Forward Shipment (V2)
POST
/v2/external/shipments/forward-shipment
Create Forward Shipment
Request Format
{{base_url}}/v2/external/shipments/forward-shipmentRequest Body
rderNumber (string): Unique identifier for the order.orderCreatedAt (string): Epoc Timestamp (In Miliseconds) when the order was created.channelId (string): Identifier for the channel through which the order was placed.warehouseId (string): Identifier for the warehouse through which the order was placed.returnAddressId (string): Identifier for the warehouse through which the order will be returned in case of RTO.receiver (object): Information about the receiver, structured similarly to the sender.destination (object): Destination address details, structured similarly to the origin.type (string): Type of shipment.sellerNote (string): Any notes from the seller regarding the shipment.parcelAttributes (object): Details about the parcel, including:dimension (object): Dimensions of the parcel (length, width, height, unit).weight (object): Weight of the parcel (weight, unit).tags (string): Tags associated with the shipment.productRequestsList (array): List of products included in the shipment, each with:productName (string): Name of the product.price (number): Price of the product.quantity (number): Quantity of the product.category (string): Category of the product.currencyCode (string): Currency code for the price.sku (string): Stock Keeping Unit identifier.taxRate (string): Applicable tax rate.discount (string): Discount applied.taxesIncluded (boolean): Indicates if taxes are included in the price.orderType (string): Type of payment (e.g., PREPAID).subTotal (number): Total amount before additional charges.shippingCharges (number): Charges for shipping.otherCharges (number): Any other applicable charges.discount (number): Total discount applied.carrier (string): Name of the carrier handling the shipment.service (string): Type of service used for shipping.Request
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/external/shipments/forward-shipment' \
--header 'Authorization: Bearer {{auth_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"orderNumber": "ORD1ttte55rwATKM01",
"orderCreatedAt": "1760103113424",
"channelId": "External",
"warehouseId": "1c2f6853-0084-42c5-85f8-4937eca3b6a0",
"returnAddressId": "1c2f6853-0084-42c5-85f8-4937eca3b6a0",
"receiver": {
"firstName": "Aditya Singh",
"lastName": "",
"email": "aditya.singh@godash.ai",
"phoneNumber": "9000755025",
"companyName": "Godash"
},
"destination": {
"addressLine1": "Chapel Rd, St Sebastian Colony",
"addressLine2": "Bandra West",
"city": "Mumbai",
"state": "Maharashtra",
"country": "India",
"countryCode": "IN",
"pinCode": "400050",
"type": "Residential"
},
"type": "Zippyy",
"sellerNote": "test comments",
"parcelAttributes": {
"dimension": {
"length": 12.35,
"width": 12.85,
"height": 12.14,
"unit": "cm"
},
"weight": {
"weight": 1,
"unit": "kg"
}
},
"tags": "test",
"productRequestsList": [
{
"productName": "PDT1",
"price": "1241",
"quantity": 1,
"category": null,
"currencyCode": "INR",
"sku": "SKU-322",
"taxRate": "0",
"discount": "0",
"description": null,
"hs_code": null
}
],
"shippingProperties": {
"orderType": "PREPAID",
"subTotal": 1241.21,
"shippingCharges": 0.0,
"otherCharges": 0.0,
"discount": 0.0
},
"carrier": "Delhivery",
"service": "Surface"
}'Response Response Example
{
"orderId": "ord_1382903931993b28be97a740140786d4",
"awb": "6901910800973",
"cratedAt": "1750079295760",
"carrier": "Delhivery",
"service": "Surface",
"shipmentPurchaseError": null
}Modified at 2026-01-19 10:32:31