Update Order Status
POST
/api/v1/sales/30801778/update-order-status
Update Sales Order Status
Purpose
Why would you use this?
Information Returned
Example Use Case
Required Parameters
| Parameter | Description |
|---|---|
| salesId | Sales Order ID whose status needs to be updated |
| orderStatus | New status of the order |
| reason | Reason for status update (recommended for Cancelled or Return status) |
| branch_id | Branch ID associated with the sales order |
Request Body Highlights
| Field | Description |
|---|---|
| orderStatus | New order status to be applied |
| reason | Reason for status change |
Allowed Order Status Values
Important Notes
salesId from the Sales APIs.Order confirmed status is available only when enabled in system settings.Cancelled or Return.Request
Query Params
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/sales/30801778/update-order-status?branch_id=24448' \
--header 'api-token: a6f919n4-4370-47a6-ad48-d3d6f719e3b0' \
--header 'Content-Type: application/json' \
--data '{
"orderStatus" : "Order confirmed",
"reason": "Test"
}'Response Response Example
200 - Example 1
{
"status": true,
"message": "Order status updated successfully",
"code": "200",
"response": null
}