{"_id":"59c07ea2a00f90001cd75cbd","category":{"_id":"59c07ea1a00f90001cd75cb3","version":"59c07ea1a00f90001cd75cb1","project":"56c27a9a2be66d19008d618d","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-16T01:50:19.202Z","from_sync":false,"order":1,"slug":"reference-api-documentation","title":"Reference API Documentation"},"user":"56c27a665da27c17003df001","parentDoc":null,"project":"56c27a9a2be66d19008d618d","version":{"_id":"59c07ea1a00f90001cd75cb1","project":"56c27a9a2be66d19008d618d","__v":1,"createdAt":"2017-09-19T02:19:13.858Z","releaseDate":"2017-09-19T02:19:13.858Z","categories":["59c07ea1a00f90001cd75cb2","59c07ea1a00f90001cd75cb3"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Rose","version_clean":"5.1.0","version":"5.1"},"githubsync":"","__v":21,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-16T04:45:50.850Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"status\": \"Success\",\n    \"responseTime\": \"2017-09-30T00:49:24.7149207+00:00\",\n    \"delivery\": {\n        \"eOrderId\": \"someOrderId\",\n        \"deliveryId\": \"59ba42949b726b41780c035a\",\n        \"quickReference\": \"6H268\",\n        \"trackingNumber\": \"59ba42949b726b41780c035a\",\n        \"orderBy\": \"Vo Trung\",\n        \"sender\": {\n            \"companyName\": \"Zyllem\",\n            \"contactName\": \"Florian Poulin\",\n            \"contactNumber\": \"+65xxxxxxxx\",\n            \"contactId\": \"HQ 04-23\",\n            \"location\": {\n                \"address\": \"71 Ayer Rajah Crescent Singapore\",\n                \"address2\": \"#04-23\",\n                \"countryCode\": \"SG\",\n                \"postalCode\": \"139951\"\n            }\n        },\n        \"receiver\": {\n            \"companyName\": \"\",\n            \"contactName\": \"John Doe\",\n            \"contactNumber\": \"+65xxxxxxxx\",\n            \"location\": {\n                \"address\": \"127 Beach Road Singapore\",\n                \"address2\": \"\",\n                \"countryCode\": \"SG\",\n                \"postalCode\": \"189711\"\n            }\n        },\n        \"pickupTime\": \"2017-09-30T01:00:00+00:00\",\n        \"parcels\": [\n            {\n                \"description\": \"A Box\"\n            },\n            {\n                \"description\": \"Another Box\"\n            }\n        ],\n        \"comments\": \"Dear driver, be gentle with the boxes, fragile content.\",\n        \"status\": \"Ready for Pickup\",\n        \"statusInfo\": \"The item is ready for pickup\",\n        \"customProperties\": [\n            {\n                \"title\": \"Custom ID\",\n                \"value\": \"some-custom-id\"\n            }\n        ]\n    }\n}","name":""},{"status":400,"language":"json","code":"{\n    \"type\": \"ERROR\",\n    \"code\": 4000,\n    \"message\": \"Invalid API key\"\n}","name":""}]},"settings":"56c2818b2be66d19008d6196","examples":{"codes":[{"name":"","language":"json","code":"{\n   \"eOrderId\": \"someOrderId\",\n   \"sender\": {\n\t   \t\"contactId\": \"HQ 04-23\",\n\t\t  \"companyName\": \"Zyllem\",\n\t\t  \"contactName\": \"Florian Poulin\",\n\t\t  \"contactNumber\": \"+65xxxxxxxx\",\n\t\t  \"location\": {\n\t\t\t \"address\": \"71 Ayer Rajah Crescent Singapore\",\n\t\t\t \"address2\": \"#04-23\",\n\t\t\t \"countryCode\": \"SG\",\n\t\t\t \"postalCode\": \"139951\"\n      }\n   },\n   \"receiver\": {\n      \"contactName\": \"John Doe\",\n      \"contactNumber\": \"+65xxxxxxxx\",\n      \"location\": {\n         \"address\": \"127 Beach Road Singapore\",\n         \"countryCode\": \"SG\",\n         \"postalCode\": \"189711\"\n      }\n   },\n   \"pickupTime\": \"2017-09-30T09:00:00+08:00\",\n   \"parcels\": [\n       {\n         \"description\": \"A Box\"\n       },\n       {\n         \"description\": \"Another Box\"\n       }\n   ],\n   \"comments\": \"Dear driver, be gentle with the boxes, fragile content.\",\n   \"customProperties\" : [\n   \t  { \n   \t  \t\"title\" : \"Custom ID\",\n   \t  \t\"value\" : \"some-custom-id\"\n   \t  }\n   \t]\n}"}]},"auth":"required","params":[{"_id":"56c2fa25b31cd53700b3fdee","ref":"","in":"body","required":false,"desc":"Optional. Order Reference from eCommerce Storefront","default":"","type":"string","name":"eOrderId"},{"_id":"56c2fa25b31cd53700b3fded","ref":"","in":"body","required":true,"desc":"Sender’s details","default":"","type":"object","name":"sender"},{"_id":"590862e6ade4172d006a89cb","ref":"","in":"body","required":false,"desc":"External contact ID","default":"","type":"string","name":"sender.contactId"},{"_id":"56c2fa25b31cd53700b3fdec","ref":"","in":"body","required":false,"desc":"Name of company","default":"","type":"string","name":"sender.companyName"},{"_id":"56c2fa25b31cd53700b3fdeb","ref":"","in":"body","required":true,"desc":"Name of sender","default":"","type":"string","name":"sender.contactName"},{"_id":"56c2fa25b31cd53700b3fdea","ref":"","in":"body","required":true,"desc":"Contact number","default":"","type":"string","name":"sender.contactNumber"},{"_id":"56c2fa25b31cd53700b3fde9","ref":"","in":"body","required":true,"desc":"Sender's address","default":"","type":"object","name":"sender.location"},{"_id":"56c2fa25b31cd53700b3fde8","ref":"","in":"body","required":true,"desc":"Street address","default":"","type":"string","name":"sender.location.address"},{"_id":"56c2fa25b31cd53700b3fde7","ref":"","in":"body","required":false,"desc":"House/Unit#","default":"","type":"string","name":"sender.location.address2"},{"_id":"56c2fa25b31cd53700b3fde6","ref":"","in":"body","required":true,"desc":"Country code","default":"","type":"string","name":"sender.location.countryCode"},{"_id":"56c2fa25b31cd53700b3fde5","ref":"","in":"body","required":true,"desc":"Postal code","default":"","type":"string","name":"sender.location.postalCode"},{"_id":"56c2fa25b31cd53700b3fde4","ref":"","in":"body","required":true,"desc":"Recipient’s details","default":"","type":"string","name":"receiver"},{"_id":"590862e6ade4172d006a89ca","ref":"","in":"body","required":false,"desc":"External contact ID","default":"","type":"string","name":"receiver.contactId"},{"_id":"56c2fa25b31cd53700b3fde3","ref":"","in":"body","required":false,"desc":"Name of company","default":"","type":"string","name":"receiver.companyName"},{"_id":"56c2fa25b31cd53700b3fde2","ref":"","in":"body","required":true,"desc":"Name of recipient","default":"","type":"string","name":"receiver.contactName"},{"_id":"56c2fa25b31cd53700b3fde1","ref":"","in":"body","required":true,"desc":"Contact number","default":"","type":"string","name":"receiver.contactNumber"},{"_id":"56c2fa25b31cd53700b3fde0","ref":"","in":"body","required":true,"desc":"Recipient's address","default":"","type":"object","name":"receiver.location"},{"_id":"56c2fa25b31cd53700b3fddf","ref":"","in":"body","required":true,"desc":"Street address","default":"","type":"string","name":"receiver.location.address"},{"_id":"56c2fa25b31cd53700b3fdde","ref":"","in":"body","required":false,"desc":"House/Unit#","default":"","type":"string","name":"receiver.location.address2"},{"_id":"56c2fa25b31cd53700b3fddd","ref":"","in":"body","required":true,"desc":"Country code","default":"","type":"string","name":"receiver.location.countryCode"},{"_id":"56c2fa25b31cd53700b3fddc","ref":"","in":"body","required":true,"desc":"Postal code","default":"","type":"string","name":"receiver.location.postalCode"},{"_id":"56c2fa25b31cd53700b3fddb","ref":"","in":"body","required":false,"desc":"Requested service","default":"","type":"string","name":"service"},{"_id":"56c2fa25b31cd53700b3fdda","ref":"","in":"body","required":false,"desc":"Optional. Delivery window","default":"","type":"string","name":"deliveryWindow"},{"_id":"56c2fa25b31cd53700b3fdd9","ref":"","in":"body","required":false,"desc":"Pickup time","default":"","type":"datetime","name":"pickupTime"},{"_id":"56c2fa25b31cd53700b3fdd8","ref":"","in":"body","required":false,"desc":"List of parcels to be delivered","default":"","type":"array_object","name":"parcels"},{"_id":"56c2fa25b31cd53700b3fdd7","ref":"","in":"body","required":true,"desc":"Description of parcel","default":"","type":"string","name":"parcels.description"},{"_id":"56c2fa25b31cd53700b3fdc8","ref":"","in":"body","required":false,"desc":"Notes to driver","default":"","type":"string","name":"comments"},{"_id":"56c2fa25b31cd53700b3fdc7","ref":"","in":"body","required":false,"desc":"Custom properties of the delivery","default":"","type":"string","name":"customProperties"},{"_id":"56c2fa25b31cd53700b3fdc6","ref":"","in":"body","required":true,"desc":"Name of the custom property","default":"","type":"string","name":"customProperties.title"},{"_id":"56c2fa25b31cd53700b3fdc5","ref":"","in":"body","required":true,"desc":"Value of the custom property","default":"","type":"string","name":"customProperties.value"}],"url":"/tr46/deliveries"},"isReference":true,"order":9,"body":"### Pickup Time\nIf you specify a `pickupTime` that falls on a non-operating hour, it will be booked with the earliest valid pickup time. Operating hours are configured by the Enterprise Administrator through the Bridge. \n\n### Service Names\nIf you don't specify a `service`, it will be booked with the first valid route. Services (or routes) are configured by the Enterprise Administrator through the Bridge. Contact your administrator if you do not know the service.  \n\n### Service Address\nThe sender and receiver addresses are passed on to Google Maps for verification. When specifying these addresses, it is best to use the following format:\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Tip\",\n  \"body\": \"You can also build your addresses using the [Google Places API](https://developers.google.com/maps/documentation/javascript/examples/places-autocomplete) to ensure accuracy.\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"**address**\",\n    \"0-1\": \"Block/Street # and Street name\\n\\nExample1: **71 Ayer Rajah Crescent**\",\n    \"1-0\": \"**address2**\",\n    \"1-1\": \"House/Unit # or additional information to supplement the first address line\\n\\nExample1: **#04-23**\\nExample2: **Beside the green gate**\",\n    \"2-0\": \"**countryCode**\",\n    \"3-0\": \"**postalCode**\",\n    \"2-1\": \"Country code\\n\\nExample1: **SG**\",\n    \"3-1\": \"Postal code\\n\\nExample1: **139951**\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\"\n}\n[/block]\n##:fa-life-ring:  [Ask a question](https://developer.zyllem.com/discuss)","excerpt":"Books a delivery order for an item and returns information like the unique delivery Id","slug":"deliveriescreate","type":"endpoint","title":"/tr46/deliveries"}

post/tr46/deliveries

Books a delivery order for an item and returns information like the unique delivery Id

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

eOrderId:
string
Optional. Order Reference from eCommerce Storefront
sender:
required
object
Sender’s details
sender.contactId:
string
External contact ID
sender.companyName:
string
Name of company
sender.contactName:
required
string
Name of sender
sender.contactNumber:
required
string
Contact number
sender.location:
required
object
Sender's address
sender.location.address:
required
string
Street address
sender.location.address2:
string
House/Unit#
sender.location.countryCode:
required
string
Country code
sender.location.postalCode:
required
string
Postal code
receiver:
required
string
Recipient’s details
receiver.contactId:
string
External contact ID
receiver.companyName:
string
Name of company
receiver.contactName:
required
string
Name of recipient
receiver.contactNumber:
required
string
Contact number
receiver.location:
required
object
Recipient's address
receiver.location.address:
required
string
Street address
receiver.location.address2:
string
House/Unit#
receiver.location.countryCode:
required
string
Country code
receiver.location.postalCode:
required
string
Postal code
service:
string
Requested service
deliveryWindow:
string
Optional. Delivery window
pickupTime:
datetime
Pickup time
parcels:
array of objects
List of parcels to be delivered
parcels.description:
required
string
Description of parcel
comments:
string
Notes to driver
customProperties:
string
Custom properties of the delivery
customProperties.title:
required
string
Name of the custom property
customProperties.value:
required
string
Value of the custom property

Examples


Result Format


Documentation

### Pickup Time If you specify a `pickupTime` that falls on a non-operating hour, it will be booked with the earliest valid pickup time. Operating hours are configured by the Enterprise Administrator through the Bridge. ### Service Names If you don't specify a `service`, it will be booked with the first valid route. Services (or routes) are configured by the Enterprise Administrator through the Bridge. Contact your administrator if you do not know the service. ### Service Address The sender and receiver addresses are passed on to Google Maps for verification. When specifying these addresses, it is best to use the following format: [block:callout] { "type": "info", "title": "Tip", "body": "You can also build your addresses using the [Google Places API](https://developers.google.com/maps/documentation/javascript/examples/places-autocomplete) to ensure accuracy." } [/block] [block:parameters] { "data": { "h-0": "Parameter name", "h-1": "Description", "0-0": "**address**", "0-1": "Block/Street # and Street name\n\nExample1: **71 Ayer Rajah Crescent**", "1-0": "**address2**", "1-1": "House/Unit # or additional information to supplement the first address line\n\nExample1: **#04-23**\nExample2: **Beside the green gate**", "2-0": "**countryCode**", "3-0": "**postalCode**", "2-1": "Country code\n\nExample1: **SG**", "3-1": "Postal code\n\nExample1: **139951**" }, "cols": 2, "rows": 4 } [/block] [block:api-header] { "type": "basic" } [/block] ##:fa-life-ring: [Ask a question](https://developer.zyllem.com/discuss)