ShiftDocs

Shipments

Create a forward order

The Create Forward Order API allows you to create new forward orders with comprehensive sender, receiver, product, and package details. This API supports various order types including prepaid (PPD) and Cash on Delivery (COD) orders.

POST{host}/api/v1/open/forward/order

Main Request Fields

FieldTypeRequiredDescription
orderNumberStringRequiredUnique identifier for the order
pickupLocationObjectRequiredSender/pickup address details
dropLocationObjectRequiredReceiver/delivery address details
shipmentsObjectRequiredPackage and product details

Location Object Structure

Each location (pickup/drop) can be specified in two ways:

Option 1: Using Address UID (Existing Address)

FieldTypeDescription
addressUidIntegerReference to existing address ID

Option 2: Full Address Details (New Address)

FieldTypeRequiredDescription
nameStringRequiredContact person name
phoneStringRequiredContact phone number
emailStringRequiredContact email address
addressObjectRequiredAddress details object

Address Object Structure

FieldTypeRequiredDescription
addressLine1StringRequiredPrimary address line
addressLine2StringOptionalSecondary address line
cityStringRequiredCity name
stateStringRequiredState name
pincodeIntegerRequiredPostal code (6-digit Indian pincode)

Shipments Object Structure

FieldTypeRequiredDescription
weightInGramsIntegerRequiredTotal package weight in grams
product_detailsArrayOptionalArray of product detail objects
payment_detailsObjectOptionalPayment information
dimensionsObjectOptionalPackage dimensions (length_cm, breadth_cm, height_cm)

Response Example

Success Response (HTTP 200)

{
  "data": 12345,
  "errorMessage": null
}

The data field contains the unique order ID generated for the created forward order.

Error Response (HTTP 400)

{
  "data": null,
  "errorMessage": "Invalid order data provided"
}

Stuck on an integration?

Your account manager can put you in touch with our tech team.

Talk to us