Versions Compared

Version Old Version 2 New Version Current
Changes made by

Suprit Bhattacharjee

Suprit Bhattacharjee

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  "shippingAndBillingAddressSame": true, Add payload for when this flag is false as well.

  "logisticAggregatorType": "CLICKPOST",  "warehouseCode": "wh-1"

}

Parameter Name

Data Type

Description

Mandatory

billingAddress

Object

Billing Address of Customer

yes

billingAddress.city

String

City of Customer

yes

billingAddress.country

String

Country of Customer

yes

billingAddress.email

String

Email of Customer

yes

billingAddress.firstName

String

First Name of customer

yes

billingAddress.lastName

String

Last Name of customer

yes

billingAddress.middleName

String

Middle Name of customer

no

billingAddress.phone

String

Phone Number of Customer

yes

billingAddress.state

String

State of customer

yes

billingAddress.street1

String

1st line of customer address

yes

billingAddress.street2

String 

2nd line of customer address

no

billingAddress.street3

String

3rd line of customer address

no

billingAddress.zip

String

Zip/Pin code of customer address

yes

currencyCode

String

Currency

yes

dropAddress

Object

Shipping Address of customer

dropAddress.city

String

City of customer

yes

dropAddress.country

String

Country of customer

yes

dropAddress.email

String

Email of customer

yes

dropAddress.firstName

String

First Name of customer

yes

dropAddress.lastName

String

Last Name of customer

yes

dropAddress.middleName

String

Middle name of customer

no

dropAddress.phone

String

Phone Number of customer

yes

dropAddress.state

String

State of customer

yes

dropAddress.street1

String 

1st line of customer address

yes

dropAddress.street2

String

2nd line of customer address

no

dropAddress.street3

String

3rd line of customer address

no

dropAddress.zip

String

Zip/Pin code of customer

yes

regionType

String

Can take two values:INDIAN and INTERNATIONAL, specifying the region type of order

yes

orderDetails

Object

Order Details

yes

orderDetails.codValue

Double

If order is of type COD, then this should be greater than 0

yes

orderDetails.invoiceNumber

String

Invoice Id of the order

yes

orderDetails.invoiceTime

Date

Invoice Time of the order

yes

orderDetails.invoiceValue

Double

Invoice value

yes

orderDetails.isCod

Boolean

True if the order is of COD type

yes

orderDetails.orderDate

Date

Order Date

yes

orderDetails.orderLineItemList

Object[]

Order Line Items

yes

orderDetails.orderLineItemList.clientSkuId

String

SKU of the product

yes

orderDetails.orderLineItemList.finalAmountPaid

Double

Final amount paid for the product

yes

orderDetails.orderLineItemList.imageUrl

String

Image url of the product

no

orderDetails.orderLineItemList.name

String

Name of the product

yes

orderDetails.orderLineItemList.price

Double

Price of the product

yes

orderDetails.orderLineItemList.quantity

Integer

Quantity of the product

yes

orderDetails.orderLineItemList.storeCreditsUsed

Double

Store credits for this line item

no

orderDetails.orderNumber

String

Order Number

yes

pickupAddress

Object

Pickup Address

yes

pickupAddress.city

String

City of Warehouse

yes

pickupAddress.country

String

Country of Warehouse

yes

pickupAddress.email

String

Email of Warehouse

yes

pickupAddress.firstName

String

First name of Warehouse

yes

pickupAddress.lastName

String

Last name of Warehouse

yes

pickupAddress.middleName

String 

Middle name of warehouse

no

pickupAddress.phone

String

Phone number of warehouse

yes

pickupAddress.state

String

State of warehouse

yes

pickupAddress.street1

String

1st line of warehouse address

yes

pickupAddress.street2

String

2nd line of warehouse address

no

pickupAddress.street3

String

3rd line of warehouse address

no

pickupAddress.zip

String

Zip/Pin code of warehouse

yes

sellerGstin

String

Seller GSTIN

yes

shipmentDimension

Object

Package Dimensions

yes

shipmentDimension.breadth

Integer

Breadth of package (cms)

yes

shipmentDimension.height

Integer

Height of package(cms)

yes

shipmentDimension.length

Integer

Length of package(cms)

yes

shipmentDimension.weight

Integer

Weight of package(grams for Clickpost/kilograms for Shiprocket)

yes

shippingAndBillingAddressSame

Boolean

True if billing and shipping address are the same

yes

logisticAggregatorType

String

Can be “CLICKPOST” or “SHIPROCKET”, specifies which aggregator type to use for Order Creation

yes

warehouseCode

String

Warehouse Code

yes

...

  "shippingAndBillingAddressSame": true,  "logisticAggregatorType": "CLICKPOST",

  "warehouseCode": "wh-1"

...

Parameter Name

Data Type

Description

documentUrl

String

PDF Url of the shipping label

courierName

String

Courier name

awbNo

String

Awb Number

FAQs

What is the difference between the Create Order API call and Generate Shipping Label API call?

The Create Order API call is used for creating the order on the logistics aggregator portal. Once the order has been created on the logistics aggregator portal, the Generate Shipping Label API call can be made to generate the awb.

Is the Create Order API call required for all logistic aggregators?

No, it is just required for Shiprocket.

For Clickpost and Shipway, if the Generate Shipping Label API call is made directly, then the order creation and AWB generation happens in this same call on the logistic aggregator portal.

Can we have multiple logistic aggregator accounts?

Yes, you can configure multiple logistic aggregator accounts. If there are multiple accounts, then the field “logisticAccountAlias“ has to be passed to identify the account.

If only single account is being used, then no need to pass logistic account alias.