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
- In the workspace, open your project's menu and click API Access.
- 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.
| Scope | Gives |
|---|---|
parcel:read | read your parcels and their tracking events |
parcel:write | add, change, pause, resume and delete parcels |
carrier:read | read the carrier catalogue |
address:read | read your address book |
address:write | add, 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
| Code | Meaning |
|---|---|
| 400 | A required field is missing: the message names it. |
| 401 | No valid API key provided. |
| 402 | No parcel tracking left: buy trackings or switch on the automatic recharge. |
| 403 | The key is missing the required scope: the message names it. |
| 404 | The resource does not exist. |
| 409 | Already there: the answer carries the id of the parcel or address that holds it. |
| 413 | A batch carries more than 100 parcels. |
| 422 | A value is refused: the message says which and why. |