Update Status

Test update status(after shipped))

POST https://wms.eshopbox.com/api/update-status

This endpoint allows you to update shipment status.

Request Body

Name	Type	Description
status_description	string	shipment status corresponding to the shipment code
waybill	string	shipment tracking id
cp_name	string	courier partner name
status	string	shipment status
status_code	number	shipment status code
location	string	shipment location
additional	object	shipment details
additional.latest_status	object	shipment status details
timestamp	string	current timestamp
remark	string	additional remarks

200 Cake successfully retrieved.

{
    "meta": {
        "success": true,
        "status": 200,
        "message": "SUCCESS"
    }
}

The latest_status object

Attribute	Type	Description
status_description	string	shipment status corresponding to the shipment code
remark	string	any additional remark against the shipment
status	string	shipment status
status_code	number	status code from the below table
location	string	shipment location
timestamp	string	Timestamp

Status type with their code

Stage	Status_code	Status_description
Pickup	25	OUT_FOR_PICKUP
Pickup	2	PICKUP_PENDING
Pickup	4	PICKED_UP
Forward	5	INTRANSIT
Forward	6	OUT_FOR_DELIVERY
Forward	8	DELIVERED
Failure	9	FAILED_DELIVERY
RTO	12	RTO
RTO	21	RTO_INTRANSIT
RTO	13	RTO_OUT_FOR_DELIVERY
RTO	14	RTO_DELIVERED
Exceptions	10	CANCELLED
Exceptions	16	LOST
Exceptions	17	DAMAGED

curl --location --request POST '{{api_url}}/update-status' \
--header 'Content-Type: application/json' \
--data-raw '{
	"status_description":"Delivered",
	"waybill":"1704610028453",
	"cp_name":"Delhivery",
	"status":"Delivered",
	"status_code":8,
	"location":"GGN_DPC (Haryana)",
	"additional":
	{
		"latest_status":
		{
			"status_description":"Delivered",
			"remark":"Added to IST",
			"status":"In Transit",
			"status_code":8,
			"location":"GGN_DPC (Haryana)",
			"timestamp":"2018-07-12T12:58:40.910000Z"
			
		}
		
	},
	"timestamp":"2018-07-12T11:53:39.902000Z",
	"remark":"Bagged at destination city PC"}'