ULTINEO LOGISTICS

Your API key and first call

The Ultineo Logistics API lets your own software add and read parcels, read the carrier catalogue and manage your address book. Its address is https://api.logistic.ultineo.com/v1/.

Create an API key

  1. In the workspace, open your project's menu and click API Access.
  2. Create a key and give it the scopes it needs, then copy it: it is shown once. The base article API keys details the screen.
ScopeGives
parcel:readread your parcels and their tracking events
parcel:writeadd, change, pause, resume and delete parcels
carrier:readread the carrier catalogue
address:readread your address book
address:writeadd, change and delete addresses

Make your first call

Send the key as a bearer token:

curl https://api.logistic.ultineo.com/v1/carrier/list?q=UPS \
  -H "Authorization: Bearer YOUR_KEY"

Every answer is JSON with three fields: code (the HTTP status), title and response. A list answers object, total, limit, offset and data; limit is at most 100.

Read the errors

CodeMeaning
400A required field is missing: the message names it.
401No valid API key provided.
402No parcel tracking left: buy trackings or switch on the automatic recharge.
403The key is missing the required scope: the message names it.
404The resource does not exist.
409Already there: the answer carries the id of the parcel or address that holds it.
413A batch carries more than 100 parcels.
422A value is refused: the message says which and why.