POST /v1/external/courier/assign/awb
This API can be used to assign the AWB (Air Waybill Number) to your shipment. The AWB is a unique number that helps you track the shipment and get details about it.
Parameters:
| PARAMS | REQUIRED | DATA TYPE | DESCRIPTION | EXAMPLE |
|---|
shipment_id | YES | integer | The shipment id of the order you want to create the AWB for. | 16016920 |
courier_id | NO | integer | The courier id of the courier service you want to select. The default courier is selected in case no id is specified. | 10 |
status | NO | string | Use this to change the courier of a shipment. Value: reassign. Note that this can be done only once in 24 hours. | reassign |
Servers
- https://apiv2.shiprocket.in
Request headers
| Name |
Type |
Required |
Description |
Content-Type |
String |
Yes |
The media type of the request body.
Default value: "application/json"
|
Request body fields
| Name |
Type |
Required |
Description |
courier_id |
String |
No |
|
shipment_id |
String |
No |
|
status |
String |
No |
|
is_return |
String |
No |
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.
