{"_id":"59c07ea2a00f90001cd75cbe","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"},"project":"56c27a9a2be66d19008d618d","user":"56c27a665da27c17003df001","parentDoc":null,"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":9,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-16T04:42:16.956Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"{\n    \"deliveries\": [\n       {\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        {\n          ... // additional items\n        }\n    ]\n}","language":"json","status":200},{"name":"","code":"{\n    \"type\": \"ERROR\",\n    \"code\": 4000,\n    \"message\": \"Invalid API key\"\n}","language":"json","status":400}]},"settings":"56c2818b2be66d19008d6196","auth":"required","params":[{"_id":"59ba447a8168a90032cbcb35","ref":"","in":"query","required":false,"desc":"Page number","default":"1","type":"int","name":"page"},{"_id":"59ba447a8168a90032cbcb34","ref":"","in":"query","required":false,"desc":"Number of items per page","default":"100","type":"int","name":"perPage"},{"_id":"59ba447a8168a90032cbcb33","ref":"","in":"query","required":false,"desc":"Search terms","default":"","type":"string","name":"search"}],"url":"/tr46/deliveries"},"isReference":true,"order":10,"body":"This API can be used for status tracking.\n\n### Search\nUse the `search` optional query parameter to restrict results to matching items. The behavior of the search is equivalent to the search available on your enterprise web portal (e.g., example.zyllem.com).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /api/tr46/deliveries?key=my-api-key&search=6H268 HTTP/1.1\\nHost: my-company.zyllem.com\\nContent-Type: application/json\",\n      \"language\": \"http\"\n    },\n    {\n      \"code\": \"curl -X GET \\\\\\n  'https://my-company.zyllem.com/api/tr46/deliveries?key=my-api-key&search=6H268' \\\\\\n  -H 'content-type: application/json'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n### Pagination\nThe returned list of items is paginated. You may use the query parameters `page` and `perPage` to navigate through the pages of results. For example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /api/tr46/deliveries?key=my-api-key&page=4&perPage=25 HTTP/1.1\\nHost: my-company.zyllem.com\\nContent-Type: application/json\",\n      \"language\": \"http\",\n      \"name\": \"HTTP\"\n    },\n    {\n      \"code\": \"curl -X GET \\\\\\n  'https://my-company.zyllem.com/api/tr46/deliveries?key=my-api-key&page=4&perPage=25' \\\\\\n  -H 'content-type: application/json'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nThe response includes headers that give you additional information related to pagination:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"zyllem-page: 1\\nzyllem-page-count: 2\\nzyllem-per-page: 25\\nzyllem-total-count: 43\",\n      \"language\": \"text\",\n      \"name\": \"Response Headers\"\n    }\n  ]\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":"Gives you a list of your ordered items","slug":"deliveries","type":"endpoint","title":"/tr46/deliveries"}

get/tr46/deliveries

Gives you a list of your ordered items

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

page:
integer1
Page number
perPage:
integer100
Number of items per page
search:
string
Search terms

Result Format


Documentation

This API can be used for status tracking. ### Search Use the `search` optional query parameter to restrict results to matching items. The behavior of the search is equivalent to the search available on your enterprise web portal (e.g., example.zyllem.com). [block:code] { "codes": [ { "code": "GET /api/tr46/deliveries?key=my-api-key&search=6H268 HTTP/1.1\nHost: my-company.zyllem.com\nContent-Type: application/json", "language": "http" }, { "code": "curl -X GET \\\n 'https://my-company.zyllem.com/api/tr46/deliveries?key=my-api-key&search=6H268' \\\n -H 'content-type: application/json'", "language": "curl" } ] } [/block] ### Pagination The returned list of items is paginated. You may use the query parameters `page` and `perPage` to navigate through the pages of results. For example: [block:code] { "codes": [ { "code": "GET /api/tr46/deliveries?key=my-api-key&page=4&perPage=25 HTTP/1.1\nHost: my-company.zyllem.com\nContent-Type: application/json", "language": "http", "name": "HTTP" }, { "code": "curl -X GET \\\n 'https://my-company.zyllem.com/api/tr46/deliveries?key=my-api-key&page=4&perPage=25' \\\n -H 'content-type: application/json'", "language": "curl" } ] } [/block] The response includes headers that give you additional information related to pagination: [block:code] { "codes": [ { "code": "zyllem-page: 1\nzyllem-page-count: 2\nzyllem-per-page: 25\nzyllem-total-count: 43", "language": "text", "name": "Response Headers" } ] } [/block] [block:api-header] { "type": "basic" } [/block] ##:fa-life-ring: [Ask a question](https://developer.zyllem.com/discuss)