Create Return Order

Parameter Name

Data Type

Description

Mandatory

returnReason

String

The reason due to which the order was returned

yes

currencyCode

String

Currency

yes

dropAddress

Object

Shipping Address (Warehouse address)

yes

dropAddress.city

String

City of warehouse

yes

dropAddress.country

String

Country of warehouse

yes

dropAddress.email

String

Email of warehouse

yes

dropAddress.firstName

String

First Name of warehouse POC

yes

dropAddress.lastName

String

Last Name of warehouse POC

yes

dropAddress.middleName

String

Middle name of warehouse POC

no

dropAddress.phone

String

Phone Number of warehouse POC

yes

dropAddress.state

String

State of warehouse

yes

dropAddress.street1

String 

1st line of warehouse address

yes

dropAddress.street2

String

2nd line of warehouse address

no

dropAddress.street3

String

3rd line of warehouse address

no

dropAddress.zip

String

Zip/Pin code of warehouse

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. If logisticAggregatorType=CLICKPOST, then this field is mandatory. If logisticAggregatorType=SHIPROCKET, then this field can be null

Conditional yes

orderDetails.invoiceTime

Date

Invoice Time of the order. If logisticAggregatorType=CLICKPOST, then this field is mandatory. If logisticAggregatorType=SHIPROCKET, then this field can be null

Conditional 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

Return Order Number

yes

orderDetails.forwardOrderNumber

String

Forward Order Number

no

orderDetails.forwardShipmentNumber

String

Forward Shipment Number

no

pickupAddress

Object

Pickup Address (Will be Customer Address)

yes

pickupAddress.city

String

City of Customer

yes

pickupAddress.country

String

Country of Customer

yes

pickupAddress.email

String

Email of Customer

yes

pickupAddress.firstName

String

First name of Customer

yes

pickupAddress.lastName

String

Last name of Customer

yes

pickupAddress.middleName

String 

Middle name of Customer

no

pickupAddress.phone

String

Phone number of Customer

yes

pickupAddress.state

String

State of Customer

yes

pickupAddress.street1

String

1st line of Customer address

yes

pickupAddress.street2

String

2nd line of Customer address

no

pickupAddress.street3

String

3rd line of Customer address

no

pickupAddress.zip

String

Zip/Pin code of seller

yes

sellerGstin

String

Seller GSTIN. If logisticAggregatorType=CLICKPOST, then this field is mandatory. If logisticAggregatorType=SHIPROCKET, then this field can be null

Conditional yes

shipmentDimension

Object

Package Dimensions

yes

shipmentDimension.breadth

Integer

Breadth of package. Default value can be set as 1

yes

shipmentDimension.height

Integer

Height of package. Default value can be set as 1

yes

shipmentDimension.length

Integer

Length of package. Default value can be set as 1

yes

shipmentDimension.weight

Integer

Weight of package. Default value can be set as 0.5

yes

warehouseCode

String

Warehouse Code

no

Parameter Name

Data Type

Description

returnAwb

String

The AWB generated for the return order

courierName

String

The courier assigned for the return order