This endpoint allows you to update the status of an order. Status updates are important for keeping customers informed about their order progress and for internal tracking.
Path Parameters
Parameter
Type
Description
order_id*
integer
ID of the order to update
Request Headers
Header
Value
Description
Authorization
Basic Auth
Base64 encoded username:password combination
Request Body Parameters
Parameter
Type
Required
Description
status*
string
Yes
New status for the order (see Status Codes table below)
Order Status Codes
Status Code
Description
P
In preparation
H
Dispatched
G
Cancellation requested
E
Sent to supplier
A
Pending customer acceptance
Y
Payment overdue
I
Cancelled
B
Awaiting stock
D
Payment denied
F
Error
O
Open
C
Completed
J
Cancellation denied
Note: Other status codes may be available depending on the e-commerce configuration. Consult with the e-commerce administrator if you have questions about available statuses.
Example Request
{
"status": "I"
}
Response
The endpoint returns the ID of the updated order.
Example Success Response (200 OK)
{
"order_id": "5131"
}
Example Error Response (405 Method Not Allowed)
{
"message": "Method Not Allowed: Missing parameters",
"status": 405
}
Tip: When updating an order to "Dispatched" status (H), consider also including shipping information using separate API calls. This helps customers track their packages more effectively.
Important: Status updates typically trigger customer notifications. Make sure you're updating to the correct status to avoid confusing your customers.