API Reference
Start typing to search…

Example Payloads

Create Delivery

Paid Order

{
   "id":"606d3f086eb23c627215271e",
   "accountId":"e14c133e-3846-4e13-82d0-5a03635d532e",
   "pickups":[
      {
         "contactName":"John Doe",
         "contactPhone":"94714444444",
         "displayOrderId":"string",
         "location":{
            "address1":"1st Road",
            "address2":"104G",
            "area":"Dubai Marina",
            "city":"Dubai",
            "country":"UAE",
            "notes":"Delivery instructions",
            "coordinates":{
               "latitude":"25.049347",
               "longitude":"55.231233"
            }
         },
         "items":[
            {
               "name":"Hot Butter Cuttlefish",
               "quantity":4
            }
         ]
      }
   ],
   "dropOffs":[
      {
         "contactName":"Mark",
         "contactPhone":"9474323232323",
         "location":{
            "address1":"1st Road",
            "address2":"104G",
            "area":"Dubai Marina",
            "city":"Dubai",
            "country":"UAE",
            "notes":"Delivery instructions",
            "coordinates":{
               "latitude":"25.049347",
               "longitude":"55.231233"
            }
         },
         "payment":{
            "mode":"PREPAID",
            "amount":{
               "amount":0,
               "currencyCode":"AED",
               "formattedAmount":"AED0.00"
            }
         }
      }
   ]
}

Cash on Delivery Order

{
  "id": "606d3f086eb23c627215271e",
  "accountId": "e14c133e-3846-4e13-82d0-5a03635d532e",
  "pickups": [
    {
      "contactName": "John Doe",
      "contactPhone": "94714444444",
      "displayOrderId": "string",
      "location": {
        "address1": "1st Road",
        "address2": "104G",
        "area": "Dubai Marina",
        "city": "Dubai",
        "country": "UAE",
        "notes": "Delivery instructions",
        "coordinates": {
          "latitude": "25.049347",
          "longitude": "55.231233"
        }
      },
      "items": [
        {
          "name": "Hot Butter Cuttlefish",
          "quantity": 4
        }
      ]
    }
  ],
  "dropOffs": [
    {
      "contactName": "Mark",
      "contactPhone": "9474323232323",
      "location": {
        "address1": "1st Road",
        "address2": "104G",
        "area": "Dubai Marina",
        "city": "Dubai",
        "country": "UAE",
        "notes": "Delivery instructions",
        "coordinates": {
          "latitude": "25.049347",
          "longitude": "55.231233"
        }
      },
      "payment": {
        "mode": "CASH_ON_DELIVERY",
        "amount": {
          "amount": 2500,
          "currencyCode": "AED",
          "formattedAmount": "AED25.00"
        }
      }
    }
  ]
}

Status Updates

Driver Coordinates

{
   "coordinates": {
          "latitude": "25.049347",
          "longitude": "55.231233"
              } ,
   "timestamp": "2021-01-01T09:23:54.723Z "
}

Delivery Job Started

{
 "referenceId": "12345",
  "trackingId": "546543423423234",
  "trackingUrl": "https://track.3pl.io/242414bb48ab5f40e03efe86b0393835",
  "driverId": "1210695",
  "driverName": "John",
  "driverMobileNumber": "9472342342342",
  "pickUpTime": "2021-01-01T09:23:54.723Z",
  "status": "DELIVERY_JOB_STARTED"
}

Driver Assigned

{
  "referenceId": "12345",
  "trackingId": "546543423423234",
  "trackingUrl": "https://track.3pl.io/242414bb48ab5f40e03efe86b0393835",
  "driverId": "1210695",
  "driverName": "John",
  "driverMobileNumber": "9472342342342",
  "pickUpTime": "2021-01-01T09:23:54.723Z",
  "status": "DRIVER_ASSIGNED"
}

Driver Arrived

{
  "referenceId": "12345",
  "trackingId": "546543423423234",
  "trackingUrl": "https://track.3pl.io/242414bb48ab5f40e03efe86b0393835",
  "driverId": "1210695",
  "driverName": "John",
  "driverMobileNumber": "9472342342342",
  "pickUpTime": "2021-01-01T09:23:54.723Z",
  "status": "DRIVER_ARRIVED"
}

Delivery Started

{
  "referenceId": "12345",
  "trackingId": "546543423423234",
  "trackingUrl": "https://track.3pl.io/242414bb48ab5f40e03efe86b0393835",
  "driverId": "1210695",
  "driverName": "John",
  "driverMobileNumber": "9472342342342",
  "pickUpTime": "2021-01-01T09:23:54.723Z",
  "status": "DRIVER_ARRIVED"
}

Delivery Completed

{
  "referenceId": "12345",
  "trackingId": "546543423423234",
  "trackingUrl": "https://track.3pl.io/242414bb48ab5f40e03efe86b0393835",
  "driverId": "1210695",
  "driverName": "John",
  "driverMobileNumber": "9472342342342",
  "pickUpTime": "2021-01-01T09:23:54.723Z",
  "status": "DELIVERY_JOB_COMPLETED"
}

Delivery Canceled

{
  "referenceId": "12345",
  "trackingId": "546543423423234",
  "trackingUrl": "https://track.3pl.io/242414bb48ab5f40e03efe86b0393835",
  "driverId": "1210695",
  "driverName": "John",
  "driverMobileNumber": "9472342342342",
  "pickUpTime": "2021-01-01T09:23:54.723Z",
  "status": "DELIVERY_JOB_COMPLETED"
}