/items

Search, track, or get a list of the items booked in your network. This resource can be used to check the status of an item.

Search

Use the optional search query parameter to restrict results to matching items. The behavior of this resource is equivalent to the Search function on your enterprise web portal.

GET /api/v1/items?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/v1/items?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/v1/items?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/v1/items?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/v1/items?key=my-api-key&updatedSince=2019-01-29 HTTP/1.1
Host: my-company.zyllem.com
Content-Type: application/json
curl -X GET \
  'https://my-company.zyllem.com/api/v1/items?key=my-api-key&updatedSince=2019-29-01' \
  -H 'content-type: application/json'
Language
Authentication
Query
URL