Update Order Status
POST
/api/v1/sales/{salesId}/update-order-status
Update Order Status
Purpose
Why would you use this?
Information Required
Headers
| Field | Required | Description |
|---|---|---|
| api-token | Yes | Authentication token provided by VasyERP |
| Content-Type | Yes | Must be application/json |
Path Parameters
| Field | Required | Description |
|---|---|---|
| salesId | Yes | Unique ID of the sales voucher whose order status needs to be updated |
Query Parameters
| Field | Required | Description |
|---|---|---|
| branch_id | Yes | Branch ID in which the sales voucher exists |
Request Body
| Field | Required | Description | Validation |
|---|---|---|---|
| orderStatus | Yes | New status of the sales order | Accepted values: Pending, Confirmed, Processing, Shipped, Delivered, Cancelled (as applicable) |
| reason | No | Reason code for updating the order status (primarily used for cancellation or status-specific actions) | Must be a valid numeric value when provided |
Example Use Case
Important Notes
api-token is required to authenticate the request.orderStatus is a mandatory field.reason is optional and should contain a valid reason code when applicable.Request
Path Params
Query Params
Header Params
Body Params text/plainRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/sales/3649298/update-order-status?branch_id=5999' \
--header 'api-token: af9ad6a5-593e-4bxq-a5c3-664129ebfger' \
--header 'Content-Type: application/json' \
--data '{
"orderStatus" : "In progress",
"reason": 1
}'Response Response Example
200 - Example 1
{
"status": true,
"message": "Order status updated successfully",
"code": "200",
"response": null
}