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

Replace an order and its lines

Updates an order by replacing its full set of order details and lines. Provide customerId, source, and at least one line with all required line fields; this operation replaces the order rather than changing only the fields you send. The returned order contains the updated details and lines.

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

1 parameter · 5 body fields
idstringrequired
The unique identifier of the order to replace.

Replacement order details and lines.

customerIdstringrequired
The unique identifier of the customer placing the order.
sourcestringrequired
How the order was received: phone, walk_in, email_import, or self_service.
Allowed:phonewalk_inemail_importself_service
requestedDeliveryDatestringoptional
The day it ships. Production and packing group by this, not the order date (D-14).
specialInstructionsstringoptional
An order-level note.
linesarray<object>required
The replacement order lines. Include at least one line; each line requires `itemId`, `qty`, `rawBaked`, `loosePacked`, and `sliced`.

7 status codes
200Returns the updated order, including its order details and lines.
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 response includes an `error` string describing the problem.
errorstringrequired
401Returned when the request is unauthenticated; sign in before calling this operation.
errorstringrequired
403Returned when the authenticated user lacks the required department membership or role.
errorstringrequired
404Returned when the order is not found.
errorstringrequired
409Returned when the request conflicts with the current state.
errorstringrequired
500Returned when an unexpected server error occurs.
errorstringrequired

Error handling

A 400 is returned for invalid input; a 401 when the request is unauthenticated; a 403 when the authenticated user lacks the required department membership or role; a 404 when the order is not found; a 409 for a conflict; and a 500 for an unexpected server error. The id path parameter must identify an order. customerId, source, and lines are required, lines must contain at least one item, and each line must include itemId, qty, rawBaked, loosePacked, and sliced; the enum fields must use their listed values.