Update Status
PUT
{{api_url}}/shop/order/{{orderid}}/statusSets an order's status. Send one of the valid status values below in status.
Body
| Field | Type | Description |
|---|---|---|
status | string | The status to set. Must be one of the values below, lowercase, exactly as written. |
Valid statuses
newneeds_reviewin_processpick_up_readypick_up_confirmedclosedpendingcanceled
Example
Set order 101769 to in_process:
{{api_url}}/shop/order/101769/status
{"status": "in_process"}
Response
{"orderid": "101769", "status": "in_process", "updated_records": 1}
| Field | Type | Description |
|---|---|---|
orderid | string | The InfiPlex order ID from the URL. |
status | string | The status now set on the order. |
updated_records | integer | The number of orders updated. 1 when the change was applied. |
Before you build
orderidis the InfiPlex order ID (shop_orderid), not the marketplace order number. To find an order from its marketplace order number, use Order Search withtext_search.- To find orders in a status, use Order Search with
order_status_eq. - To flag an order as handled without changing its status, use Processed.
- Your API key needs Order write permission. A key without it gets
403 Forbidden.
Related guides:
Authorization
Bearer token, sent in the Authorization header. Inherited from the collection.
Headers
| Key | Value | Description |
|---|---|---|
Content-Type | application/json |
Body
{
"status": "new"
}Example Request
curl --location --request PUT '{{api_url}}/shop/order/{{orderid}}/status' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{auth_token}}' \
--data '{
"status": "new"
}'Example Responses
Update Status
Request
curl --location --request PUT 'https://example.com/api/admin/shop/order/101769/status' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"status": "new"
}'Response 200 OK
{
"orderid": "101769",
"status": "new",
"updated_records": 1
}
