Swagger Petstore - OpenAPI 3.0
PATCH/api/orders/{id}/lines/{lineId}/ship

Ship an order line

Ships a specified line on an order and returns the reloaded order. Use qtyShipped to record the quantity shipped; a shipped quantity supersedes a packed quantity when reconciling back-orders. You cannot ship more than the ordered quantity.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 1 body field
idstringrequired
The unique identifier of the order containing the line to ship.
lineIdstringrequired
The unique identifier of the order line to ship.

The shipped quantity for the order line.

qtyShippednumberrequired
The quantity shipped. Must be 0 or greater.

6 status codes
200Returns the whole order, reloaded after the line's shipped quantity is updated.
idstringoptional
Order id.
orderNumberstringoptional
Human-facing, `ORD-YYMM-NNN`.
customerIdstringoptional
Customer id.
customerNamestringoptional
customerTypeSnapshotstringoptional
The customer's type AT ORDER TIME — it may change later, and the order keeps what it was sold under.
orderDatestringoptional
The day the order was taken.
requestedDeliveryDatestringoptional
The day it ships — what production and packing group by (D-14).
statusstringoptional
Allowed:draftconfirmedin_productionpackingshippingshippedclosed
sourcestringoptional
Allowed:phonewalk_inemail_importself_service
specialInstructionsstringoptional
Order-level note.
createdByIdstringoptional
createdByNamestringoptional
createdAtstringoptional
fromRecurringIdstringoptional
The standing order that generated this one (R6). Null for every hand-taken order. Note the `source` does NOT distinguish one: a generated order says `phone`, because the OrderSource enum was deliberately left untouched.
linesarray<object>optional
400Returned when the input is invalid; the `error` field describes what was wrong.
errorstringrequired
401Returned when you are not authenticated.
errorstringrequired
403Returned when you are authenticated but lack the required department membership or role.
errorstringrequired
404Returned when the requested order or line is not found.
errorstringrequired
500Returned when an unexpected server error occurs.
errorstringrequired

Error handling

A 400 is returned for invalid input, including a shipped quantity above the ordered quantity; a 401 is returned when you are not authenticated; a 403 is returned when you lack the required department membership or role; a 404 is returned when the order or line is not found; and a 500 is returned for an unexpected server error. The id path parameter and lineId path parameter must identify the order and line to ship. qtyShipped is required and must be 0 or greater.