API integration documentation – Delivery Bot Blog

Delivery Bot’s API makes it easy for retail stores to integrate our network of couriers to your deliveries. Save unnecessary time organizing your orders by automating the delivery process. Through our API you can POST deliveries and GET tracking updates providing the best experience for your customer and employees.

Creating an API

After logging into our portal go to your settings page, select API, and click the plus icon to create an API. Once you have entered a nickname your API token will be shown. For security reasons, you’ll only be able to see your token once so store it in a safe place. After your API is created you’ll be able to test, set up, and deploy. For testing and setup questions inquiries send us an email at info@deliverybotnyc.com.

Create a delivery

Add a delivery order.
https://api.deliverybotnyc.com/add_order

Deliver_to Required	string (DeliverTo) Pick up from customer and deliver to store or pick up from store and deliver to customer [“store”, “customer]
Name Required	string (Name) Name of customer.
Phone Required	string (Phone) Phone number of customer for the courier to call. The phone number must be a valid US. number.
Address required	string (Address) Coma separated address of the customer address (including city, state, and zip code).
Apt	string (Apt) Coma separated address of the drop-off address (including city, state, and zip code).
Items required	string (No.Items) Quantity of items of the item type.
item required	string (ItemType) Type of item [“box”, “heavy-box”, “large-box”, “1-hander”, “2-hander”, “plant”, “bag”, “letter”, “garment”, “other”].
Items2	string (No.Items) Quantity of items of the additional item type.
Item2	string (ItemType) Type of additional item [“box”, “heavy-box”, “large-box”, “1-hander”, “2-hander”, “plant”, “bag”, “letter”, “garment”, “other”].
Tip	number(Tip) Optional tip for courier in dollars. $4.10 = 4.10
Ready_by required	string (ReadyBy) Date and time when order is ready for pick-up or “now”
Note	string (Note) Instructions for courier.

POST /add_order
Request sample
{
  "deliver_to": "customer",
  "name": "John Smith",
  "phone": "+19175737687",
  "address": "400 East 74 St, NY, NY, 10021",
  "apt": "301",
  "items": "2",
  "item": "box",
  "items2": "1",
  "item2": "1-hander",
  "tip": "2.02",
  "ready_by": "2022-01-01 12:35:00",
  "note": "Leave with doorman"
}

Response sample
{
  "tracking_number": "9138921372384",
  "tracking_url": "https://tracking.deliverybotnyc.com/2m3lke",
  "deliver_to": "customer",
  "name": "John Smith",
  "phone": "+19175737687",
  "address": "400 East 74 St, NY, NY, 10021",
  "apt": "301",
  "items": "2",
  "item": "box",
  "items2": "1",
  "item2": "1-hander",
  "price": "7.00",
  "tip": "2.02",
  "ready_by": "2022-01-01 12:35:00",
  "deliver_by": "2022-01-01 14:05:00",
  "note": "Leave with doorman"
}

Response sample
{
  "error": "invalid_params",
  "messege": "One or more fields couldn't be validated."
  "field_error": [
    {
      "field" "deliver_to",
      "error" "Invalid deliver to value."
    },
    {
      "field" "name",
      "error" "Minimum character length for  name is 2."
    },
    {
      "field" "phone",
      "error" "Invalid phone number format. Required format: '+xxxxxxxxxx'."
    },
    {
      "field" "item2",
      "error" "Invalid item value. Allowed items: 'box', 'heavy-box', 'large-box', '1-hander', '2-hander', 'plant', 'bag', 'letter', 'garment', 'other'."
    }
}

Response sample
{
  "code": "authorization_failed",
  "message": "Invalid authorization token."
}

Response sample
{
  "code": "invalid_delivery_parameters",
  "error": "outside_of_delivery_time",
  "messege": "Ready by time outside of delivery hours."
}

Find orders

Get the status and other details of multiple orders.
https://api.deliverybotnyc.com/order_details

Start_date	string (Date) Starting date for deliveries
End_date	string (Date) Ending date for deliveries
Name	string (Name) Customer name
Count	string (Count) Number of results to return

GET /order_details
Request sample
{
  "start_date": "2021-01-01 00:00:00",
  "end_date": "2022-01-02 00:00:00",
  "name": "John Smith"
}

200

403

Response sample
{
  "tracking_number": "9138921372384",
  "tracking_url": "https://tracking.deliverybotnyc.com/2m3lke",
  "deliver_to": "customer",
  "name": "John Smith",
  "phone": "9175737687",
  "address": "400 East 74 St, NY, NY, 10021",
  "apt": "301",
  "items": "2",
  "item": "box",
  "items2": "",
  "item2": "",
  "price": 7.00,
  "tip": 2.02,
  "ready_by": "2022-01-01 12:35:00",
  "deliver_by": "2022-01-01 14:05:00",
  "note": "Leave with doorman"
  "last_update": "2022-01-01 13:09:00",
  "status": "Delivered"
}

Response sample
{
  "code": "authorization_failed",
  "message": "Invalid authorization token."
}

Get tracking logs

Get the tracking information and status of an order.
https://api.deliverybotnyc.com/tracking_details/{tracking_number}

Tracking_number
Required

string (Id)
Tracking number of the delivery

GET /tracking_details/{tracking_number}

Response sample
{
  "tracking_number": "9138921372384",
  "status": "Delivered",
  "last_update": "2022-01-01 13:09:38"
  "logs":[
    {
      "status": "Processing",
      "date_time": "2022-01-01 12:35:00"
    },
    {
      "status": "Scheduled",
      "date_time": "2022-05-27 12:43:09"
    },
    {
      "status": "Picked-up",
      "date_time": "2022-05-27 12:58:01",
    },
    {
      "status": "Delivered",
      "date_time": "2022-01-01 13:09:38"
    },
  ]
}

Response sample
{
  "error": "invalid_params",
  "messege": "One or more fields couldn't be validated."
  "field_error": [
    {
      "field" "tracking_id",
      "code" "Minimum character length for  tracking_id is 9."
    }
}

Response sample
{
  "code": "authorization_failed",
  "message": "Invalid authorization token."
}

Response sample
{
  "code": "unkown_tracking_id",
  "message": "No tracking logs available for this tracking id."
}

Get proof of delivery

https://api.deliverybotnyc.com/delivery_proof/{tracking_number}

Tracking_number
Required

string (Id)
Tracking number of the delivery

GET /delivery_proof/{tracking_number}

Response sample
{
  "tracking_number": "9138921372384",
  "id": "908",
  "type": "picture",
  "url": "https://portal.deliverybotnyc.com/uploads/proofs/2022/01/728748879_1660330778.jpg",
  "date": "2022-01-01"
},
{
  "tracking_number": "9138921372384",
  "id": "909",
  "type": "signature",
  "url": "https://portal.deliverybotnyc.com/uploads/proofs/2022/01/728748879_1660330778.jpg",
  "date": "2022-01-01"
}

Response sample
{
  "code": "invalid_params",
  "messege": "One or more fields couldn't be validated."
  "field_error": [
    {
      "field" "tracking_id",
      "error" "Minimum character length for  tracking_id is 9."
    }
}

Response sample
{
  "code": "authorization_failed",
  "message": "Invalid authorization token."
}

Response sample
{
  "code": "unkown_tracking_id",
  "message": "No tracking logs available for this tracking id."
}

Cancel a delivery

https://api.deliverybotnyc.com/cancel_order/{tracking_number}

Tracking_number
Required

string (Id)
Tracking number of the delivery

POST /cancel_order/{tracking_number}

Response sample
{
  "tracking_number": "9138921372384",
  "tracking_url": "https://tracking.deliverybotnyc.com/2m3lke",
  "deliver_to": "customer",
  "name": "John Smith",
  "phone": "9175737687",
  "address": "400 East 74 St, NY, NY, 10021",
  "apt": "301",
  "items": "2",
  "item": "box",
  "items2": "",
  "item2": "",
  "price": 7.00,
  "tip": 2.02,
  "ready_by": "2022-01-01 12:35:00",
  "deliver_by": "2022-01-01 14:05:00",
  "note": "Leave with doorman"
  "last_update": "2022-01-01 13:09:00",
  "status": "Canceled"
}

Response sample
{
  "error": "invalid_params",
  "messege": "One or more fields couldn't be validated."
  "field_error": [
    {
      "field" "deliver_to",
      "error" "Invalid deliver to value."
    },
    {
      "field" "name",
      "error" "Minimum character length for  name is 2."
    },
    {
      "field" "phone",
      "error" "Invalid phone number format. Required format: '+xxxxxxxxxx'."
    },
    {
      "field" "item2",
      "error" "Invalid item value. Allowed items: 'box', 'heavy-box', 'large-box', '1-hander', '2-hander', 'plant', 'bag', 'letter', 'garment', 'other'."
    }
}

Response sample
{
  "code": "authorization_failed",
  "message": "Invalid authorization token."
}

Response sample
{
  "code": "unkown_tracking_id",
  "message": "Tracking id is not available."
}

Response sample
{
  "code": "invalid_action",
  "message": "Unable to cancel an order after its been picked up. Please contact support."
}

Update a delivery

https://api.deliverybotnyc.com/update_order

Tracking_number Required	string (Id) Tracking number of the delivery
Name	string (Name) Name of customer.
Phone	string (Phone) Phone number of customer for the courier to call. The phone number must be a valid US. number.
Address	string (Address) Coma separated address of the customer address (including city, state, and zip code).
Apt	string (Apt) Coma separated address of the drop-off address (including city, state, and zip code).
Items	string (No.Items) Quantity of items of the item type.
item	string (ItemType) Type of item [“box”, “heavy-box”, “large-box”, “1-hander”, “2-hander”, “plant”, “bag”, “letter”, “garment”, “other”].
Items2	string (No.Items) Quantity of items of the additional item type.
Item2	string (ItemType) Type of additional item [“box”, “heavy-box”, “large-box”, “1-hander”, “2-hander”, “plant”, “bag”, “letter”, “garment”, “other”].
Note	string (Note) Instructions for courier.

POST /update_order
Request sample
{
  "tracking_id": "89234710923",
  "name": "John Smith",
  "phone": "+19175737687",
  "address": "400 East 74 St, NY, NY, 10021",
  "apt": "301",
  "items": "2",
  "item": "box",
  "items2": "1",
  "item2": "1-hander",
  "note": "Leave with doorman"
}

Response sample
{
  "tracking_number": "9138921372384",
  "tracking_url": "https://tracking.deliverybotnyc.com/2m3lke",
  "deliver_to": "customer",
  "name": "John Smith",
  "phone": "9175737687",
  "address": "400 East 74 St, NY, NY, 10021",
  "apt": "301",
  "items": "2",
  "item": "box",
  "items2": "",
  "item2": "",
  "price": 7.00,
  "tip": 2.02,
  "ready_by": "2022-01-01 12:35:00",
  "deliver_by": "2022-01-01 14:05:00",
  "note": "Leave with doorman"
}

Response sample
{
  "error": "invalid_params",
  "messege": "One or more fields couldn't be validated."
  "field_error": [
    {
      "field" "deliver_to",
      "error" "Invalid deliver to value."
    },
    {
      "field" "name",
      "error" "Minimum character length for  name is 2."
    },
    {
      "field" "phone",
      "error" "Invalid phone number format. Required format: '+xxxxxxxxxx'."
    },
    {
      "field" "item2",
      "error" "Invalid item value. Allowed items: 'box', 'heavy-box', 'large-box', '1-hander', '2-hander', 'plant', 'bag', 'letter', 'garment', 'other'."
    }
}

Response sample
{
  "code": "authorization_failed",
  "message": "Invalid authorization token."
}

Response sample
{
  "code": "unkown_tracking_id",
  "message": "Tracking id is not available."
}

Response sample
{
  "code": "invalid_action",
  "message": "Unable to update an order after its been picked up. Please contact support."
}

Response sample
{
  "code": "invalid_delivery_parameters",
  "error": "outside_of_delivery_zone",
  "messege": "Address outside of delivery zone."
}

Create a store (NEW: coming soon!)

https://api.deliverybotnyc.com/…

POST /...
Request sample
{

}

200

403

Response sample
{







}

Response sample
{
  "status": "authorization_error"
  "message": "credentials don't match operation"
}

Update store information (NEW: coming soon!)

https://api.deliverybotnyc.com/…

POST /...
Request sample
{

}

200

403

Response sample
{







}

Response sample
{
  "status": "authorization_error"
  "message": "credentials don't match operation"
}