Create Return Order API (Beta)

Parameter Name

Data Type

Description

Mandatory

forwardOrderCode

String

Forward order code for which return order is being created.

yes

returnOrderCode

String

Unique identifier provided by the channel for the return order being created.

yes

locationCode

String

Location code of the warehouse where the return order will be received.

yes

returnOrderTime

String

Time at which return order got placed by customer

no

orderItems

Object[]

Array of order items, order items represent each line of return order.

yes

orderItems.itemCode

String

Unique identifier provided by the channel for the return order item.

yes

orderItems.reason

String

Reason for return as given by the customer.

yes

orderItems.channelSkuCode

String

SKU code for return order item.

yes

orderItems.name

String

Name of the product

Conditional Yes(Mandatory if AWB integration needed with RMS)

orderItems.brand

String

Brand of the product

Conditional Yes(Mandatory if AWB integration needed with RMS)

orderItems.color

String

Color of the product

Conditional Yes(Mandatory if AWB integration needed with RMS)

orderItems.category

String

Category of the product

Conditional Yes(Mandatory if AWB integration needed with RMS)

orderItems.subCategory

String

Sub Category of the product

Conditional Yes(Mandatory if AWB integration needed with RMS)

orderItems.serialNumber

String

Serial number of the product

Conditional Yes(Mandatory if AWB integration needed with RMS)

orderItems.price

Double

Price of the product

Conditional Yes(Mandatory if AWB integration needed with RMS)

orderItems.finalAmountPaid

Double

Final amount paid for the product

Conditional Yes(Mandatory if AWB integration needed with RMS)

orderItems.imageUrl

String

Image url of the product

Conditional Yes(Mandatory if AWB integration needed with RMS)

orderItems.storeCreditsUsed

Double

Store credits for this line item

Conditional Yes(Mandatory if AWB integration needed with RMS)

orderItems.subTaxItemData

Object[]

List of sub tax items object

Conditional Yes(Mandatory if AWB integration needed with RMS)

subTaxItemData.type

String

Type of tax applicable

Conditional Yes(Mandatory if AWB integration needed with RMS)

subTaxItemData.rate

Double

Tax rate for this tax type

Conditional Yes(Mandatory if AWB integration needed with RMS)

subTaxItemData.taxPerUnit

Double

Tax applicable for this type of tax per unit

Conditional Yes(Mandatory if AWB integration needed with RMS)

subTaxItemData.taxTotal

Double

Total tax for this tax type

Conditional Yes(Mandatory if AWB integration needed with RMS)

orderType

String

Type of return. Possible values - SELF_SHIP,CUSTOMER_RETURN,RETURN_TO_ORIGIN

Conditional Yes(Mandatory if AWB integration needed with RMS)

awbNumber

String

Courier tracking number.

no

transporter

String

Courier partner name.

no

currencyCode

String

Currency

Conditional Yes(Mandatory if AWB integration needed with RMS)

regionType

String

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

Conditional Yes(Mandatory if AWB integration needed with RMS)

sellerGstin

String

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

Conditional Yes(Mandatory if AWB integration needed with RMS)

consigneeGstin

String

Consignee GSTIN

Conditional Yes(Mandatory if AWB integration needed with RMS)

returnReason

String

The reason due to which the order was returned

Conditional Yes(Mandatory if AWB integration needed with RMS)

shipmentDimension

Object

Package Dimensions

Conditional Yes(Mandatory if AWB integration needed with RMS)

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

dropAddress

Object

Shipping Address (Warehouse address)

Conditional Yes(Mandatory if AWB integration needed with RMS)

dropAddress.name

String

Name of Warehouse POC

Yes

dropAddress.line1

String

1st line of warehouse’s address

Yes

dropAddress.line2

String

2nd line of warehouse’s address

No

dropAddress.line3

String

3rd line of warehouse’s address

No

dropAddress.city

String

City of Warehouse

Yes

dropAddress.state

String

State of Warehouse

Yes

dropAddress.zip

String

ZIP/Pin code of Warehouse

Yes

dropAddress.country

String

Country of warehouse

Yes

dropAddress.email

String

Email of warehouse

Yes

dropAddress.phone

String

Phone Number of warehouse POC

Yes

pickupAddress

Object

Billing address of the customer

Conditional Yes(Mandatory if AWB integration needed with RMS)

pickupAddress.name

String

Name of customer

Yes

pickupAddress.line1

String

1st line of customer’s address

Yes

pickupAddress.line2

String

2nd line of customer’s address

No

pickupAddress.line3

String

3rd line of customer’s address

No

pickupAddress.city

String

City of customer

Yes

pickupAddress.state

String

State of customer

Yes

pickupAddress.zip

String

ZIP/Pin code of customer

Yes

pickupAddress.country

String

Country of customer

Yes

pickupAddress.email

String

Email of customer

Yes

pickupAddress.phone

String

Phone Number of customer

Yes

orderDetails

Object

Order Details

Conditional Yes(Mandatory if AWB integration needed with RMS)

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

String

Forward Shipment Number

No