Forward Shipment

Create Forward Shipment

This endpoint allows you to assign an Air Waybill (AWB) to a courier for a specific order. It facilitates the logistics process by providing all necessary details regarding the sender, receiver, and shipment.

Request Format

Method: POST

Endpoint: {{base_url}}/v1/external/shipments/forward-shipment

Content-Type: application/json

Request 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.

sender (object): Information about the sender, including:

firstName (string): Sender's first name.

lastName (string): Sender's last name.

email (string): Sender's email address.

phoneNumber (string): Sender's phone number.

companyName (string): Sender's company name.

origin (object): Origin address details, including:

addressLine1 (string): Primary address line.

addressLine2 (string): Secondary address line (optional).

city (string): City of origin.

state (string): State of origin.

country (string): Country of origin.

countryCode (string): ISO country code.

pinCode (string): Postal code.

type (string): Type of address (e.g., Residential).

receiver (object): Information about the receiver, structured similarly to the sender.

destination (object): Destination address details, structured similarly to the origin.

returnAddress (object): Address to which the shipment should be returned, 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.

shippingProperties (object): Payment information for the shipment, including:

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.

curl --location --request POST '/v1/external/shipments/forward-shipment' \ --header 'Authorization: Bearer {{auth_token}}' \ --header 'Content-Type: application/json' \ --data-raw '{ "orderNumber": "ORD1ttte55rwATKM01", "orderCreatedAt": "1760103113424", "channelId": "External", "sender": { "firstName": "Aman", "lastName": "Kumar", "email": "aman@godash.ai", "phoneNumber": "9871445930", "companyName": "Godash1" }, "origin": { "addressLine1": "A 401, Apex apartment , Sector 45 ", "addressLine2": "Gurgaon", "city": "Gurgaon", "state": "Haryana", "country": "India", "countryCode": "IN", "pinCode": "122003", "type": "Residential" }, "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" }, "returnAddress": { "addressLine1": "A 401, Apex apartment , Sector 45 ", "addressLine2": "Gurgaon", "city": "Gurgaon", "state": "haryana", "country": "India", "countryCode": "IN", "pinCode": "122003", "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" }'

{ "orderId": "ord_1382903931993b28be97a740140786d4", "awb": "6901910800973", "cratedAt": "1750079295760", "carrier": "Delhivery", "service": "Surface", "shipmentPurchaseError": null }

Create Forward Shipment#

Request Format#

Request Body#

Request

Responses

Create Forward Shipment

Request Format

Request Body