POST /v1/external/international/manifests/generate
Use this API to create a pickup request for your order shipment. The API returns the pickup status along with the estimated pickup time.
You will have to call the 'Generate Manifest' API after the successful response of this API.
Note:
- The AWB must be already generated for the shipment id to generate the pickup request.
- Only one shipment_id can be passed at a time.
| PARAMS | REQUIRED | DATA TYPE | DESCRIPTION | EXAMPLE |
|---|---|---|---|---|
| shipment_id | yes | integer | The shipment id of the shipment which is requested for pickup. | 1603434 |
| status | no | string | Use this field to retry if the pickup request fails. Value: retry | retry |
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 |
|---|---|---|---|
shipment_id[] |
Array | 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.