> For the complete documentation index, see [llms.txt](https://eshop.gitbook.io/eshopbox-developers/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://eshop.gitbook.io/eshopbox-developers/order/order-status/update-status.md).

# Update Status

## Test update status(after shipped))

<mark style="color:green;">`POST`</mark> `https://wms.eshopbox.com/api/update-status`

This endpoint allows you to update shipment status.\ <br>

#### 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                                 |

{% tabs %}
{% tab title="200 Cake successfully retrieved." %}

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

{% endtab %}
{% endtabs %}

**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**

<table><thead><tr><th width="169.662353515625">Stage</th><th width="133.72052001953125">Status_code</th><th width="276">Status_description</th></tr></thead><tbody><tr><td>Pickup</td><td>25</td><td>OUT_FOR_PICKUP</td></tr><tr><td>Pickup</td><td>2</td><td>PICKUP_PENDING</td></tr><tr><td>Pickup</td><td>4</td><td>PICKED_UP</td></tr><tr><td>Forward</td><td>5</td><td>INTRANSIT</td></tr><tr><td>Forward</td><td>6</td><td>OUT_FOR_DELIVERY</td></tr><tr><td>Forward</td><td>8</td><td>DELIVERED</td></tr><tr><td>Failure</td><td>9</td><td>FAILED_DELIVERY</td></tr><tr><td>RTO</td><td>12</td><td>RTO</td></tr><tr><td>RTO</td><td>21</td><td>RTO_INTRANSIT</td></tr><tr><td>RTO</td><td>13</td><td>RTO_OUT_FOR_DELIVERY</td></tr><tr><td>RTO</td><td>14</td><td>RTO_DELIVERED</td></tr><tr><td>Exceptions</td><td>10</td><td>CANCELLED</td></tr><tr><td>Exceptions</td><td>16</td><td>LOST</td></tr><tr><td>Exceptions</td><td>17</td><td>DAMAGED</td></tr></tbody></table>

```
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"}'
```