Update Shipping Detail
POST
/api/v1/sales/{salesId}/update-shipping-details
Update Shipping Details
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 shipping details need 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 |
|---|---|---|---|
| shippingDate | Yes | Date and time when the shipment is dispatched | Must be in ISO 8601 format (e.g., 2026-08-04T18:30:00Z) |
| transportDate | Yes | Date and time of transportation | Must be in ISO 8601 format (e.g., 2026-08-14T18:30:00Z) |
| transporterId | Yes | Unique Contact ID of the transporter | Must be a positive number |
| vehicleNo | Yes | Vehicle number used for transportation | Maximum 15 characters. Only letters, numbers, and hyphen (-) are allowed. Spaces are not permitted. |
| referenceNo | No | Reference number related to the shipment | Maximum 20 characters |
| modeOfTransport | No | Mode of transportation (e.g., Road, Air, Rail, Water) | Maximum 20 characters |
| weight | No | Weight of the shipment | Maximum 20 characters |
Example Use Case
Important Notes
api-token is required to authenticate the request.shippingDate and transportDate must be provided in ISO 8601 format.transporterId must be a valid Contact ID of an existing transporter.vehicleNo accepts only alphanumeric characters and hyphens (-). Spaces and special characters are not allowed.Request
Path Params
Header Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/sales/5313756/update-shipping-details' \
--header 'api-token: {{.in-api-token}}' \
--header 'Content-Type: application/json' \
--data '{
"shippingDate": "2026-08-04T18:30:00Z",
"transportDate": "2026-08-14T18:30:00Z",
"transporterId": 13851674,
"vehicleNo": "GJ-21-2001",
"referenceNo": "51234",
"modeOfTransport": "Via Water",
"weight": "120"
}'Response Response Example
200 - Example 1
{
"status": true,
"message": "Shipping details updated successfully",
"code": "200",
"response": null
}