GuidesAPI Reference

/tr46/deliveries

get https://{yourEnterprise}.zyllem.io/api/tr46/deliveries

Gives you a list of your ordered items

This API can be used for status tracking.

Search

Use the optional search 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).

GET /api/tr46/deliveries?key=my-api-key&search=6H268 HTTP/1.1
Host: my-company.zyllem.com
Content-Type: application/json

curl -X GET \
  'https://my-company.zyllem.com/api/tr46/deliveries?key=my-api-key&search=6H268' \
  -H 'content-type: application/json'

Lookup

Use the optional lookup query parameter to look up the exact match of a string. This query can be used in place of 'search', and also produces faster results. The lookup is not case sensitive.
This resource is equivalent to the Search function on your enterprise web portal.

GET /api/tr46/deliveries?key=my-api-key&lookup=6H268 HTTP/1.1
Host: my-company.zyllem.com
Content-Type: application/json

curl -X GET \
  'https://my-company.zyllem.com/api/tr46/deliveries?key=my-api-key&lookup=6H268' \
  -H 'content-type: application/json'

updatedSince

Use the optional updatedSince query parameter to filter results by last update (i.e., when an action was last performed on the item). This accepts a date (only) or date & time query that is in ISO8601 format. The value must be URL encoded.

GET /api/tr46/deliveries?key=my-api-key&updatedSince=2019-29-01 HTTP/1.1
Host: my-company.zyllem.com
Content-Type: application/json

curl -X GET \
  'https://my-company.zyllem.com/api/tr46/deliveries?key=my-api-key&updatedSince=2019-29-01' \
  -H 'content-type: application/json'

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:

GET /api/tr46/deliveries?key=my-api-key&page=4&perPage=25 HTTP/1.1
Host: my-company.zyllem.com
Content-Type: application/json

curl -X GET \
  'https://my-company.zyllem.com/api/tr46/deliveries?key=my-api-key&page=4&perPage=25' \
  -H 'content-type: application/json'

The response includes headers that give you additional information related to pagination:

zyllem-page: 1
zyllem-page-count: 2
zyllem-per-page: 25
zyllem-total-count: 43

Language
URL