POST /v1/external/international/shipments/create/forward-shipment
Use this API to do multiple tasks in one go, namely creating a quick order, requesting its shipment, pickup generation generating the label and the manifest for the same order.
This API integrates several other APIs to perform all these tasks together.
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 |
|---|---|---|---|
billing_email |
String | No | |
shipping_country |
String | No | |
shipping_last_name |
String | No | |
igst_amount |
Number | No | |
shipping_phone |
Number | No | |
sub_total |
Number | No | |
breadth |
Number | No | |
ioss |
String | No | |
shipping_city |
String | No | |
shipping_is_billing |
Boolean | No | |
payment_method |
String | No | |
purpose_of_shipment |
Number | No | |
currency |
String | No | |
vendor_details |
Object | No | |
vendor_details.pickup_location |
String | No | |
vendor_details.email |
String | No | |
vendor_details.name |
String | No | |
vendor_details.phone |
Number | No | |
vendor_details.address_2 |
String | No | |
vendor_details.country |
String | No | |
vendor_details.pin_code |
String | No | |
vendor_details.state |
String | No | |
vendor_details.address |
String | No | |
vendor_details.city |
String | No | |
order_items[] |
Array | No | |
order_items[].units |
Number | No | |
order_items[].name |
String | No | |
order_items[].sku |
String | No | |
order_items[].selling_price |
String | No | |
order_items[].hsn |
String | No | |
length |
Number | No | |
order_type |
Number | No | |
shipping_address_2 |
String | No | |
billing_last_name |
String | No | |
billing_state |
String | No | |
igstPaymentStatus |
String | No | |
billing_address |
String | No | |
shipping_address |
String | No | |
Terms_Of_Invoice |
String | No | |
shipping_pincode |
String | No | |
height |
Number | No | |
channel_id |
String | No | |
shipping_customer_name |
String | No | |
pickup_location |
String | No | |
shipping_state |
String | No | |
pickup_location_id |
Number | No | |
order_id |
String | No | |
product_category |
String | No | |
billing_pincode |
String | No | |
billing_phone |
String | No | |
billing_city |
String | No | |
order_date |
String | No | |
shipping_email |
String | No | |
weight |
Number | No | |
billing_country |
String | No | |
billing_customer_name |
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.