Additional Collection Fields
Operator avatar
Written by Operator
Updated over a week ago

ADDITIONAL COLLECTION FIELDS

If you have enabled additional collection fields for your account, you will be able to access them via API.

Request Fields

COLLECTION-LEVEL

  1. date

  2. address

  3. time

  4. name

  5. phone

  6. notify_email

  7. notify_url

  8. assign_to

  9. instructions

  10. zone

  11. reason

  12. note

  13. initial_status

  14. open_job

  15. offer

  16. start_date

  17. age

  18. time_slot

  19. req_date

  20. track_no

  21. order_no

  22. job_type

  23. job_order

  24. j_fee

  25. address_lat

  26. address_lng

  27. addr_company

  28. addr_1

  29. addr_2

  30. addr_3

  31. postal_code

  32. city

  33. state

  34. country

  35. b_addr

  36. last_name

  37. sender_phone

  38. fax

  39. customer

  40. acc_no

  41. o_name

  42. invoice_no

  43. invoice_amt

  44. pay_mode

  45. pay_amt

  46. group_name

  47. src

  48. wt

  49. parcel_width

  50. parcel_length

  51. parcel_height

  52. cbm

  53. boxes

  54. cartons

  55. pcs

  56. envelopes

  57. pallets

  58. bins

  59. trays

  60. bundles

  61. rolls

  62. labels

  63. att_1

  64. detrack_no

  65. display_status

  66. display_tracking_status

  67. carrier

  68. sno

  69. act_wt

  70. temp

  71. hold

  72. paid

  73. reschedule

  74. a_crates

  75. a_plts

  76. a_utiln

  77. gs_r

  78. d_r

  79. fb_r

  80. eta_time

  81. live_eta

  82. depot

  83. depot_contact

  84. department

  85. sales_person

  86. identification_no

  87. bank_prefix

  88. run_no

  89. job_price

  90. insurance_price

  91. insured

  92. total_price

  93. remarks

  94. items_count

  95. service_type

  96. warehouse_address

  97. destination_timeslot

  98. door

  99. vehicle_type

  100. priority

  101. service_time

  102. do

  103. type

  104. tracking_no

  105. tracking_link

  106. status

  107. tracking_status

  108. pod_time

  109. items

ITEM-LEVEL

  1. sku

  2. desc

  3. qty

  4. reject

  5. reason

  6. image

  7. po_no

  8. batch_no

  9. expiry

  10. cmts

  11. uom

  12. checked

  13. a_qty

  14. in_qty

  15. unload_time_est

  16. unload_time_act

  17. follow_up_qty

  18. follow_up_reason

  19. rework_qty

  20. rework_reason

  21. weight

  22. sno

Response Fields

COLLECTION-LEVEL

  1. created_at

  2. updated_at

  3. date

  4. address

  5. time

  6. name

  7. phone

  8. notify_email

  9. notify_url

  10. assign_to

  11. instructions

  12. zone

  13. reason

  14. note

  15. handled_by

  16. image

  17. view_image_url

  18. view_recipient_sender_device_signature_url

  19. view_signature_url

  20. view_photo_1_url

  21. view_photo_2_url

  22. view_photo_3_url

  23. view_photo_4_url

  24. view_photo_5_url

  25. view_photo_6_url

  26. view_photo_7_url

  27. view_photo_8_url

  28. view_photo_9_url

  29. view_photo_10_url

  30. pod_lat

  31. pod_lng

  32. pod_address

  33. current_lat

  34. current_lng

  35. initial_status

  36. open_job

  37. offer

  38. attempt

  39. start_date

  40. age

  41. time_slot

  42. req_date

  43. track_no

  44. order_no

  45. job_type

  46. job_order

  47. j_fee

  48. address_lat

  49. address_lng

  50. addr_company

  51. addr_1

  52. addr_2

  53. addr_3

  54. postal_code

  55. city

  56. state

  57. country

  58. b_addr

  59. last_name

  60. sender_phone

  61. fax

  62. customer

  63. acc_no

  64. o_name

  65. invoice_no

  66. invoice_amt

  67. pay_mode

  68. pay_amt

  69. group_name

  70. src

  71. wt

  72. parcel_width

  73. parcel_length

  74. parcel_height

  75. cbm

  76. boxes

  77. cartons

  78. pcs

  79. envelopes

  80. pallets

  81. bins

  82. trays

  83. bundles

  84. rolls

  85. labels

  86. att_1

  87. detrack_no

  88. display_status

  89. display_tracking_status

  90. carrier

  91. submitted_at

  92. a_t_at

  93. arr_lat

  94. arr_lng

  95. arr_add

  96. arr_at

  97. texted_at

  98. called_at

  99. sno

  100. recipient_sender_device_pod_at

  101. recipient_sender_device_signed_by

  102. signed_at

  103. p1_at

  104. p2_at

  105. p3_at

  106. p4_at

  107. p5_at

  108. p6_at

  109. p7_at

  110. p8_at

  111. p9_at

  112. p10_at

  113. act_wt

  114. temp

  115. hold

  116. paid

  117. reschedule

  118. a_crates

  119. a_plts

  120. a_utiln

  121. gs_r

  122. d_r

  123. fb_r

  124. eta_time

  125. live_eta

  126. depot

  127. depot_contact

  128. department

  129. sales_person

  130. identification_no

  131. bank_prefix

  132. run_no

  133. head_to_delivery_at

  134. pod_date_time

  135. job_price

  136. insurance_price

  137. insured

  138. total_price

  139. remarks

  140. items_count

  141. service_type

  142. warehouse_address

  143. destination_timeslot

  144. door

  145. vehicle_type

  146. priority

  147. service_time

  148. recipient_sender_device_signature_file_url

  149. signature_file_url

  150. photo_1_file_url

  151. photo_2_file_url

  152. photo_3_file_url

  153. photo_4_file_url

  154. photo_5_file_url

  155. photo_6_file_url

  156. photo_7_file_url

  157. photo_8_file_url

  158. photo_9_file_url

  159. photo_10_file_url

  160. id

  161. do

  162. driver_mobile_number

  163. type

  164. tracking_no

  165. tracking_link

  166. contactless_signature_link

  167. received_by

  168. status

  169. tracking_status

  170. status_changed_at

  171. pod_time

  172. items

  173. milestones

ITEM-LEVEL

  1. sku

  2. desc

  3. qty

  4. reject

  5. reason

  6. image

  7. photo_url

  8. po_no

  9. batch_no

  10. expiry

  11. cmts

  12. uom

  13. checked

  14. a_qty

  15. in_qty

  16. unload_time_est

  17. unload_time_act

  18. follow_up_qty

  19. follow_up_reason

  20. rework_qty

  21. rework_reason

  22. weight

  23. sno

  24. id

Note: enabled request fields will also be available in response fields.

SAMPLE REQUEST JSON

[
   {
      ...,
      "time_slot":"Morning",
      "fax":"68444856",
      "notify_url":"http://www.example.com/notify.php",
      "customer":"ABC Company Pte. Ltd.",
      "invoice_no":"INV990686",
      "invoice_amt":58.6,
      "boxes":"#112 & #113",
      "cbm":1.2,
      "cartons":2,
      "pcs":12,
      "items":[
         {
            ...,
            "po_no":"PO112658",
            "batch_no":"3336",
            "expiry":"2015-02-12"
         }
      ]
   }
]

SAMPLE RESPONSE JSON

[
   {
      ...,
      "time_slot":"Morning",
      "fax":"68444856",
      "notify_url":"http://www.example.com/notify.php",
      "customer":"ABC Company Pte. Ltd.",
      "invoice_no":"INV990686",
      "invoice_amt":58.6,
      "boxes":"#112 & #113",
      "cbm":1.2,
      "cartons":2,
      "pcs":12,
      "arr_lat":1.32502083807714,
      "arr_lng":103.893779271220,
      "arr_add":"63 Ubi Avenue 1, Singapore 408937",
      "arr_at":"2014-02-13T09:30:45+08:00",
      "sno":"4902505355769",
      "items":[
         {
            ...,
            "po_no":"PO112658",
            "batch_no":"3336",
            "expiry":"2015-02-12",
            "sno":"8886428701123"
         }
      ]
   }
]

Did this answer your question?