Update order status
order_update_statusAgent manual correction or degraded handoff recovery. note required except cancelled. Owning agent_id required.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | Required note except when status=CANCELLED | |
| status | Yes | New status, e.g. PENDING, CONFIRMED, SHIPPED, DELIVERED, CANCELLED | |
| carrier | No | Carrier name when attaching tracking | |
| agent_id | Yes | Owning agent id (required for authorization) | |
| order_id | Yes | Order id to update | |
| search_id | No | Optional search_id for analytics correlation | |
| tracking_id | No | Carrier tracking id when recovering handoff | |
| tracking_url | No | Carrier's public tracking page for tracking_id, when you have it. Never invent one. | |
| session_token | No | Session token from agent_authenticate — required whenever agent_id is passed | |
| handoff_endpoint | No | Merchant handoff/status endpoint URL for poll recovery | |
| external_checkout_id | No | Merchant checkout id to recover degraded handoff polling |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hint | No | ||
| next | No | ||
| error | No | ||
| detail | No | ||
| status | No | ||
| carrier | No | ||
| order_id | No | ||
| quantity | No | ||
| tracking_id | No | ||
| continue_url | No | ||
| handoff_endpoint | No | ||
| merchant_observed | No | ||
| agent_status_locked | No | ||
| external_checkout_id | No |