Orders
Update order
Partial update of an existing order. Send only the fields you want to change.
PATCH
/api/orders/{order_id}/
Updates are gated by order state
Customer info and notes can be edited until the order is loaded for delivery. Line items can only be modified before the order arrives at the hub. Cancelled and delivered orders are immutable.
Updatable fields
customer
Update customer info — typically address, phone, or email corrections.
notes
Append notes to the order. Existing notes are preserved.
delivery.scheduled_date
Request a delivery date change. Subject to availability.
Example
curl -X PATCH https://{licensee-url}/api/orders/22200041771/ \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "customer": { "phone1": { "number": "5559876543", "type": 0 } } }'
{
"order_id": "22200041771",
"customer": {
"phone1": { "number": "5559876543", "type": 0 }
},
"updated_at": "2026-05-12T15:22:01.123Z"
/* ... */
}
Errors
| Status | error.code | Cause |
|---|---|---|
| 404 | order_not_found | Order ID does not exist in your scope |
| 409 | order_immutable | Order is cancelled or delivered and cannot be modified |
| 422 | date_unavailable | Requested delivery date is not available in the route plan |