Add a vendor shipment: what left the vendor, when, how, and when it is expected

For a purchase order that was sent and is not fully received. Without items every quantity that has not shipped yet ships (ordered minus already shipped, over the lines that ship: product lines and custom items); with items the lines named ship in the quantities given, and at least one quantity must be above 0 (422). A charge line never ships and a custom item takes no lot (422). Shipping more than was ordered is allowed. shippedAt defaults to now; tracking and carrier are optional. From all shipments together each line gets its shipped quantity and status, the purchase order its vendor shipping status (pending, partly-fulfilled, fulfilled) and its expected date: the latest ETA among the shipments that have not arrived. When that date moves, the incoming stock reserved for the purchase order moves to it in the same request.

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

The purchase order's uuid or 24-hex id.

Body Params
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