View Collections

6. VIEW COLLECTIONS

URL: https://app.detrack.com/api/v1/collections/view.json
Limit: 100 collections per request (send separate requests if you are viewing more than 100 collections)
HTTP POST REQUEST

Note: the request structure below is for Method #1: Name/Value Pair (NVP) + JSON String. For Method #2: Custom Header + JSON Body, please refer to the json parameter only.

Parameter Description
key Your API key. You can obtain this from your dashboard.
json The JSON string containing the collections you wish to view. It should contain an array with the following fields:

Field Description
date The collection date. Format: YYYY-MM-DD e.g. 2014-02-28. Required field.
do The D.O. #. The D.O. # of the collection to view. Required field.
HTTP POST RESPONSE (JSON)
Field Description
info Contains information on the status of the request.

Field Description
status The status of the request. The value will be “ok” if request is processed successfully or “failed” if the key or json parameter is missing.
failed The number of collections that are not retrieved due to error.
error Contains the error details if the request failed. Note: this field is set only if the request failed.

Field Description
code The error code. Please refer to Collection Error Codes
message The corresponding error message.
results Contains an array of statuses with the following fields:

Field Description
date The date of the collection. Format: YYYY-MM-DD e.g. 2014-02-28
do The D.O. # of the collection.
status The status of the collection view request. The value will be “ok” if the collection is successfully retrieved or “failed” if the collection is not retrieved.
collection The retrieved collection with the following fields:

Field Description
date The collection date. Format: YYYY-MM-DD e.g. 2014-02-28.
do The D.O. #. This field is unique for the date.
address The collection address.
collection_time The collection time window.
collect_from The name of the sender to collect from.
phone The phone number of the sender.
notify_email The email address to send customer-facing collection updates to.
notify_url The URL to post collection updates to. Please refer to Collection Push Notification
assign_to The name of the vehicle to assign this collection to.
instructions Collection instructions for the driver.
zone The zone that this collection falls under.
reason The reason of non-collection if the collection is not collected.
note Any note recorded by the driver regarding this collection.
sent_by The name of the sender who signed for the collection.
image If the POD contains an image (signature / photo), the value will be 1. Otherwise, it will be 0Please refer to Download Collection 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 collection.
pod_lng The longitude of the driver’s last known location when submitting POD for this collection.
pod_address The address of the driver’s last known location when submitting POD for this collection.
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 collected.
reject Quantity of the item rejected by recipient.
reason Reason of item rejection.
errors Contains an array of error messages if the collection view request failed. Note: this field is set only if the collection view request failed.

Field Description
code The error code. Please refer to Collection Error Codes
message The corresponding error message.

For additional fields, please refer to Additional Collection Fields.

SAMPLE REQUEST JSON
[
   {
      "date":"2014-02-13",
      "do":"DO140213001"
   },
   {
      "date":"2014-02-13",
      "do":"DO140213003"
   }
]
SAMPLE RESPONSE JSON
{
   "info":{
      "status":"ok",
      "failed":1
   },
   "results":[
      {
         "date":"2014-02-13",
         "do":"DO140213001",
         "status":"ok",
         "collection":{
            "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":"",
            "sent_by":"",
            "image":0,
            "view_image_url":"",
            "do":"DO140213001",
            "status":"In Progress",
            "time":"",
            "pod_lat":"",
            "pod_lng":"",
            "pod_address":"",
            "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":""
               }
            ]
         }
      },
      {
         "date":"2014-02-13",
         "do":"DO140213003",
         "status":"failed",
         "errors":[
            {
               "code":1003,
               "message":"Collection with D.O. # DO140213003 not found on 2014-02-13."
            }
         ]
      }
   ]
}