ULTINEO LOGISTICS

Parcels through the API

These routes do what the Parcel screens do. Each parcel you add uses one tracking of your balance.

RouteScopeDoes
POST /v1/parcel/createparcel:writeadds one parcel, or up to 100 with {"items": [...]}
GET /v1/parcel/listparcel:readlists your parcels
GET /v1/parcel/detail/<id>parcel:readone parcel with its tracking events, newest first
PATCH /v1/parcel/detail/<id>parcel:writechanges the fields you send
DELETE /v1/parcel/detail/<id>parcel:writedeletes the parcel, as the screen does

Add a parcel

Send tracking_number (5 to 50 characters: letters, digits and - _ . /) and the carrier, as carrier_id (from GET /v1/carrier/list) or carrier_code:

curl -X POST https://api.logistic.ultineo.com/v1/parcel/create \
  -H "Authorization: Bearer YOUR_KEY" -H "Content-Type: application/json" \
  -d '{"tracking_number": "1Z999AA10123456784", "carrier_code": "100002"}'

The answer is 201 with the parcel. A tracking number you already follow is never added twice: a single parcel answers 409 with the id that holds it, and in a batch that item answers existing. You can therefore send the whole list again after a failure.

Follow your parcels

The tracking is read from the carrier after you add the parcel, not during the call. Read the parcel again with GET /v1/parcel/detail/<id>, or keep a list in sync: call GET /v1/parcel/list?updated_since=<Unix time> once, then call it with ?cursor= and the next_cursor of the previous answer.

The list also filters on status, tracking_number, carrier, recipient, shipment and q.

Pause, resume or refresh a parcel

Send a PATCH with "tracking": "paused" or "tracking": "active", or "refresh": true to ask the carrier again. Changing tracking_number or the carrier starts the tracking again for the new number.