DELIVERY / COLLECTION PUSH NOTIFICATION

Our system will POST a delivery / collection notification to the notify_url, if specified, for every delivery once a status update is available.

Alternatively, you may choose to setup the webhook for our system to POST the notification to your URL.

HTTP POST REQUEST (NAME/VALUE PAIR (NVP) + JSON STRING)

Note: this is posted to the notify_url from our server, not from your server to ours.

Field

Description

date

The delivery date. Format: YYYY-MM-DD e.g. 2014-02-28.

do

The D.O. #. This field is unique for the date.

address

The delivery address.

delivery_time

The delivery time window.

deliver_to

The name of the recipient to deliver to.

phone

The phone number of the recipient.

notify_email

The email address to send customer-facing delivery updates to.

notify_url

The URL to post delivery updates to.

assign_to

The name of the vehicle to assign this delivery to.

instructions

Delivery instructions for the driver.

zone

The zone that this delivery falls under.

reason

The reason of non-delivery if the delivery is not delivered.

note

Any note recorded by the driver regarding this delivery.

received_by

The name of the recipient who signed for the delivery.

image

If the POD contains an image (signature / photo), the value will be 1. Otherwise, it will be 0. Please refer to Download Delivery POD Image File

view_image_url

If the POD contains an image (signature / photo), this field will contain an access-controlled link (user must be logged in to Detrack) to the image. Otherwise, it will be empty.

time

The time the POD is received. ISO 8601 format: YYYYMMDDTHH:MM:SS+HH:MM e.g. 2014-02-13T09:30:45+08:00

pod_lat

The latitude of the driver’s last known location when submitting POD for this delivery.

pod_lng

The longitude of the driver’s last known location when submitting POD for this delivery.

pod_address

The address of the driver’s last known location when submitting POD for this delivery.

items

This field may or may not be empty. If not empty, it should contain an array of items with the following fields:

Field

Description

sku

Stock keeping unit or item #.

desc

The item description.

qty

Quantity of the item to be delivered.

reject

Quantity of the item rejected by recipient.

reason

Reason of item rejection.

SAMPLE DELIVERY REQUEST JSON

{
   "date":"2014-02-13",
   "address":"63 Ubi Avenue 1 Singapore 408937",
   "delivery_time":"09:00 AM - 12:00 PM",
   "deliver_to":"John Tan",
   "phone":"+6591234567",
   "notify_email":"john.tan@example.com",
   "notify_url":"http://www.example.com/notify.php",
   "assign_to":"GT1234H",
   "instructions":"Call customer upon arrival.",
   "zone":"East",
   "reason":"",
   "note":"Recipient commented that delivery is very prompt.",
   "received_by":"John",
   "image":1,
   "view_image_url":"https://app.detrack.com/deliveries/photo/52cbaf87f92ea105a4000115.jpg",
   "do":"DO140213001",
   "status":"Delivered",
   "time":"2014-02-13T09:30:45+08:00",
   "pod_lat":1.32502083807714,
   "pod_lng":103.893779271220,
   "pod_address":"63 Ubi Avenue 1, Singapore 408937",
   "items":[
      {
         "sku":"T0201",
         "desc":"Test Item #01",
         "qty":1,
         "reject":0,
         "reason":""
      },
      {
         "sku":"T0202",
         "desc":"Test Item #02",
         "qty":5,
         "reject":0,
         "reason":""
      },
      {
         "sku":"T0203",
         "desc":"Test Item #03",
         "qty":10,
         "reject":0,
         "reason":""
      }
   ]
}

SAMPLE COLLECTION REQUEST JSON

{
   "date":"2014-02-13",
   "address":"63 Ubi Avenue 1 Singapore 408937",
   "collection_time":"09:00 AM - 12:00 PM",
   "collect_from":"John Tan",
   "phone":"+6591234567",
   "notify_email":"john.tan@example.com",
   "notify_url":"http://www.example.com/notify.php",
   "assign_to":"GT1234H",
   "instructions":"Call customer upon arrival.",
   "zone":"East",
   "reason":"",
   "note":"Sender commented that collection is very prompt.",
   "received_by":"John",
   "image":1,
   "view_image_url":"https://app.detrack.com/collections/photo/52cbaf87f92ea105a4000115.jpg",
   "do":"DO140213001",
   "status":"Collected",
   "time":"2014-02-13T09:30:45+08:00",
   "pod_lat":1.32502083807714,
   "pod_lng":103.893779271220,
   "pod_address":"63 Ubi Avenue 1, Singapore 408937",
   "items":[
      {
         "sku":"T0201",
         "desc":"Test Item #01",
         "qty":1,
         "reject":0,
         "reason":""
      },
      {
         "sku":"T0202",
         "desc":"Test Item #02",
         "qty":5,
         "reject":0,
         "reason":""
      },
      {
         "sku":"T0203",
         "desc":"Test Item #03",
         "qty":10,
         "reject":0,
         "reason":""
      }
   ]
}
Did this answer your question?