HTTP Triggers
- Emmanuel Nipal
- Lara Cledera
- Khristy Arasheal Pascual (Unlicensed)
HTTP Trigger Tokens Availability
For tracking number and URL, availability of the token is dependent on when the provider will push the tracking number/URL.
e.g. If the provider pushes the tracking number/URL upon update to STARTED PICKUP status of Ref#: 1,
then tracking number token for the said post is available ONLY on the succeeding statuses after STARTED PICKUP (e.g. DONE PICKUP, ARRIVED AT HUB & etc.).
Label | Token | Description | Draft | Assign | Unpost | Accept | Cancel | Assigning Rider | Start Pickup | Done Pickup | Arrived at hub | Start Delivery | Reject | Done | In transit for return | Returned | Failed Delivery | Failed Pickup | Failed Return |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Business ID | {businessId} | ID of the Business Account |
| |||||||||||||||||
Courier ID | {courierId} | ID of the Courier Account |
|
| ||||||||||||||||
Reference No. | {refNo} | Reference Number of the booking |
|
| ||||||||||||||||
Status | {status} | Status of the booking |
| |||||||||||||||||
Business Name | {businessName} | Name of the Business |
| |||||||||||||||||
Courier Name | {courierName} | Name of the Courier |
|
| ||||||||||||||||
Pickup Address | {pickup.address} | Address where the package will be picked up |
| |||||||||||||||||
Pickup CIty | {pickup.city} | City where the package will be picked up |
| |||||||||||||||||
Pickup Completion Date Time | {pickup.completionDateTime} | Expected Completion Date and Time of the pickup |
| |||||||||||||||||
Sender Name | {pickup.customerName} | Name of the Sender |
| |||||||||||||||||
Pickup Contact Number | {pickup.contactNumber} | Contact Number of the Sender |
| |||||||||||||||||
Pickup Email | {pickup.email} | Email Address of the Sender |
| |||||||||||||||||
Pickup Latitude | {pickup.lat} | Latitude of the pickup address |
| |||||||||||||||||
Pickup Longitude | {pickup.long} | Longitude of the pickup address |
| |||||||||||||||||
Pickup Province | {pickup.province} | Province where the package will be picked up |
| |||||||||||||||||
Pickup Item Description | {pickup.details} | Item Description of the pickup item |
| |||||||||||||||||
Pickup Remarks | {pickup.remarks} | Pickup remarks or instruction |
| |||||||||||||||||
Pickup Postal Code | {pickup.postalCode} | Postal Code of the pickup address |
| |||||||||||||||||
Pickup Barangay | {pickup.barangay} | Barangay of the pickup address |
| |||||||||||||||||
Delivery COD Amount | {delivery.codAmount} | Cash On Delivery Amount |
| |||||||||||||||||
Delivery Completion Date Time | {delivery.completionDateTime} | Expected Completion Date and Time of the Delivery |
| |||||||||||||||||
Delivery Contact Number | {delivery.contactNumber} | Contact Number of the recipient |
| |||||||||||||||||
Recipient Name | {delivery.customerName} | Name of the recipient |
| |||||||||||||||||
Delivery Address | {delivery.address} | Address where the package will be delivered |
| |||||||||||||||||
Delivery City | {delivery.city} | City where the package will be delivered |
| |||||||||||||||||
Delivery Item Description | {delivery.details} | Item Description of the Delivery Item |
| |||||||||||||||||
Product Height | {product.height} | Height of the Product |
| |||||||||||||||||
Product Length | {product.lenght} | Length of the Product |
| |||||||||||||||||
Product Width | {product.width} | Width of the Product |
| |||||||||||||||||
Delivery Email | {delivery.email} | Email Address of the Recipient |
| |||||||||||||||||
Declared Value | {delivery.itemPrice} | Declared Item Price |
| |||||||||||||||||
Delivery Latitude | {delivery.lat} | Latitude of the Delivery Address |
| |||||||||||||||||
Delivery Longitude | {delivery.long} | Longitude of the Delivery Address |
| |||||||||||||||||
Delivery Meta Tags | {delivery.metaTags} | Meta Tags |
| |||||||||||||||||
Delivery Province | {delivery.province} | Province where the package will be delivered |
| |||||||||||||||||
Delivery Remarks | {delivery.remarks} | Delivery remarks or instruction |
| |||||||||||||||||
Delivery Postal Code | {delivery.postalCode} | Postal Code of the delivery address |
| |||||||||||||||||
Delivery Barangay | {delivery.barangay} | Barangay where the package will be delivered |
| |||||||||||||||||
Delivery Weight | {delivery.weight} | Weight of the Item |
| |||||||||||||||||
Tracking Number | {trackingNumber} | Tracking Number of the package |
|
| ||||||||||||||||
Tracking URL | {trackingUrl} | Tracking URL where the customer can monitor the delivery (this is usually available for On Demand Providers) |
|
| ||||||||||||||||
Post ID | {postId} | ID of the booking |
| |||||||||||||||||
Opportunity ID | {opportunityId} | ID of the booking (courier’s view) |
|
| ||||||||||||||||
Product Size | {product.size} | Size of the Product |
|
| ||||||||||||||||
Approximate Shipping Fee | {fee.approximateShipping} | Approximate Shipping Fee (Shipping cost which is quoted by the courier) |
|
| ||||||||||||||||
Actual Shipping Fee | {fee.actualShipping} | Actual Shipping Fee (Shipping cost which is reflected upon booking) |
|
| ||||||||||||||||
Final Shipping Fee | {fee.finalShipping} | Final Shipping Free (Final Shipping cost including all additional fees set by the courier) |
|
| ||||||||||||||||
Last Update Remarks | {lastUpdateRemarks} | Last Remarks Updated |
|
| ||||||||||||||||
Substatus | {subStatus} | Sub status of the booking |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Custom Field | {customField} | Customized Field |
|
|
|
|
|
|
|
|
|
|
| |||||||
Delivery Meta Tags | {delivery.metaTags} | Meta Tags |
|
|
|
|
|
|
|
|
|
|
| |||||||
List of Items | {listOfItems} | List of items in the booking |
|
|
|
|
|
|
|
|
|
|
| |||||||
Number of Attempts | {numberOfAttempts} | Number of Delivery Attempts |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Shareable link | {shareableLink} | A DPH link which can be shared to the customers for tracking |
|
|
|
|
|
|
|
|
|
|
| |||||||
Delivery Quantity | {delivery.quantity} | Quantity |
|
|
|
|
|
|
|
|
|
|
| |||||||
Dimension Height | {dimension.height} | Height of the item |
|
|
|
|
|
|
|
|
|
|
| |||||||
Dimension Width | {dimension.width} | Width of the item |
|
|
|
|
|
|
|
|
|
|
| |||||||
Dimension Length | {dimension.length} | Length of the item |
|
|
|
|
|
|
|
|
|
|
|