PATCH Orders
Use this endpoint to update existing orders.
User level: Advanced
Endpoint
PATCH /v1/{scopeId}/orders/{id}| Property | Value |
|---|---|
| Method | PATCH |
| Scope ID | Branch UUID |
| Authentication | Authorization: Bearer <access_token> |
| Required scope | routix:orders:write |
| Content-Type | application/json |
| Request body | JSON object |
Update rules
- The API validates server-side whether the record belongs to the allowed organization and branch.
- Only explicitly allowed fields can be updated.
- Unknown or disallowed fields return
400 invalid_update.
Allowed update fields
| Field |
|---|
account_id |
order_date |
status |
total_weight_kg |
total_volume_m3 |
total_packages |
Example request
curl -X PATCH "https://api.routix.com/v1/550e8400-e29b-41d4-a716-446655440000/orders/0ea1dd6b-3a97-4284-a2b1-6c0f80a9ec39" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
-H "Content-Type: application/json" \
-d '{
"status": "confirmed",
"total_packages": 12
}'Example response
{
"data": {
"id": "0ea1dd6b-3a97-4284-a2b1-6c0f80a9ec39",
"account_id": "7ecf4b8d-8d1f-4a0f-8e57-6d8f14c6a221",
"order_date": "2026-07-05",
"status": "confirmed",
"total_weight_kg": 1240,
"total_volume_m3": 5.4,
"total_packages": 12
},
"version": "v1"
}Error response
{
"error": "invalid_update",
"error_description": "One or more fields are not allowed for updates on orders"
}Possible error codes
400 invalid_request400 invalid_update401 unauthorized401 invalid_token403 invalid_token_type403 insufficient_scope404 not_found405 method_not_allowed
Related pages
- API calls & examples
- Setup guide
Last updated on
