Processed
PUT
{{api_url}}/shop/order/{{orderid}}/processedSets or clears an order's processed flag. Send 1 to mark the order processed, or 0 to mark it not processed.
The flag records that the order has been handled on your side. Setting it does not create a shipment, does not send tracking to the sales channel, and does not notify the customer. When the order ships, use Order Tracking Create.
Body
| Field | Type | Description |
|---|---|---|
is_processed | integer | 1 marks the order processed. 0 marks it not processed. |
Examples
Mark order 101769 processed:
{{api_url}}/shop/order/101769/processed
{"is_processed": 1}
Clear the flag:
{"is_processed": 0}
Response
The order ID and the flag as set:
{"orderid": "101769", "is_processed": 1}
| Field | Type | Description |
|---|---|---|
orderid | string | The InfiPlex order ID from the URL. |
is_processed | integer | The flag now set on the order. |
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 read the flag back, use Order Get. It returns
is_processedas"1"or"0". - To move an order to a workflow status such as
in_processorclosed, use Update Status. To cancel an order, use Cancel. - 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
{
"is_processed": 1
}Example Request
curl --location --request PUT '{{api_url}}/shop/order/{{orderid}}/processed' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{auth_token}}' \
--data '{
"is_processed": 1
}'Example Responses
Processed
Request
curl --location --request PUT 'https://example.com/api/admin/shop/order/101769/processed' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"is_processed": 1
}'Response 200 OK
{
"orderid": "101769",
"is_processed": 1
}
