Update a vendor shipment (only the fields sent; null clears; `arrivedAt` marks its arrival); 200 unchanged when nothing differs

For any purchase order that is not cancelled. items, when sent, replaces the lines of the shipment. The shipped quantities and statuses of the lines, the vendor shipping status and the expected date are recomputed from all shipments. :shipmentId is the id the purchase order answers for the shipment; an unknown one is 404.

Scope: outgoing-purchase-orders:write, channel:write or admin. A permission group made before the Channel API scopes existed grants it as inventory:manage or supply-chain:manage.

Idempotency: send Idempotency-Key; a retry with the same key replays the first answer.

Rate limit: write class, 1,200 requests per minute per tenant by default (read class 6,000). Every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset; a refusal is 429 rate_limited with Retry-After.

Path Params
string
required
length between 1 and 64
string
required
length between 1 and 64
Body Params
Schema_aee7e11aee | null
Schema_aee7e11aee | null
Schema_aee7e11aee | null
length ≤ 255
length ≤ 255
Schema_1bc7dc02ee | null
length ≤ 100

Container number or size ("MSCU1234567", "1x40HQ").

length ≤ 100
length ≤ 255
0 to 1000000000
length ≤ 1000
items
array of objects
length ≤ 1000
items
Headers
string
length between 7 and 50

Any string of 7 to 50 characters that identifies this request (an order number, a webhook id). A retry with the same key and the same body answers the first result with Idempotent-Replayed: true; the same key with a different body is 422 idempotency_key_reused; a concurrent request with the same key is 409 in_progress with Retry-After. Recommended on every write.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json