Inbound through the API
These routes do what the Inbound screens do. You announce and cancel; the partner site receives, and what arrived is what the site counted.
| Route | Scope | Does |
|---|---|---|
POST /v1/inbound/create | inbound:write | announces one inbound |
GET /v1/inbound/list | inbound:read | lists your inbound |
GET /v1/inbound/detail/<id> | inbound:read | one inbound with its lines and reception photos |
PATCH /v1/inbound/detail/<id> | inbound:write | announces a draft, or cancels |
POST /v1/inbound/cancel/<id> | inbound:write | cancels a draft or announced inbound |
Announce an inbound
Send the site_id (from the stock of GET /v1/product/detail/<id>) and the lines, each with a product_id or a sku and a quantity:
curl -X POST https://api.logistic.ultineo.com/v1/inbound/create \
-H "Authorization: Bearer YOUR_KEY" -H "Content-Type: application/json" \
-d '{"site_id": "whse_...", "lines": [{"sku": "TEE-BLUE-M", "quantity": 120}],
"carrier_code": "100002", "tracking_number": "1Z999AA10123456784",
"expected_date": "2026-12-01", "note": "Two cartons"}' | Field | Rule |
|---|---|
site_id | required: one site per inbound |
lines | required: 1 to 50 lines, a product at most once, quantity from 1 to 100000 |
carrier_id or carrier_code, tracking_number | optional; a tracking number needs its carrier |
expected_date | optional, YYYY-MM-DD or a Unix time |
note | optional, for the site |
status | announced (default) or draft |
The answer is 201 with the inbound and its reference. With a tracking number, the inbound is linked to the parcel that already follows it, or a parcel is added for tracking as POST /v1/parcel/create does. An open inbound already carrying the same tracking number answers 409 with its id.
Follow the reception
GET /v1/inbound/detail/<id> answers the status (draft, announced, receiving, received, closed or cancelled), the site, the totals (lines, expected, counted, damaged), the dates announced_at, receiving_at, received_at, closed_at and cancelled_at, and the lines: each with its product, expected, counted, damaged and difference once received. photos lists the photos the site took at reception.
GET /v1/inbound/list filters on status (a comma list, for example announced,receiving) and site, with limit (at most 100) and offset.
Announce a draft or cancel
Send a PATCH with "status": "announced" to announce a draft, or "status": "cancelled" to cancel; POST /v1/inbound/cancel/<id> cancels too, with an optional note. Only a draft or announced inbound is cancelled: once the site has started counting, the answer is 409. To change the lines, cancel the inbound and announce a new one.