Create Return Order API (Beta)

Inbound | POST | /return/return-orders

Summary

This API is used to create B2C return orders in Omni.

Description

This API is used to create B2C return orders in Omni. One order item represents only one quantity of an SKU. If there are multiple quantities of the same SKU then multiple order items should be created.

Request

{
  "forwardOrderCode": "108",
  "returnOrderCode": "100078",
  "locationCode": "Wid234",
  "returnOrderTime": "2020-10-16T20:22:28.000+05:30",
  "returnOrderStatus": "RETURN_CREATED",
  "expectedDate": "2020-10-16T20:22:28.000+05:30",
  "orderItems": [
    {
      "itemCode": "I10098",
      "reason": "Different Size",
      "channelSkuCode": "10007345",
      "enableDoorStepQc": true,
      "name": "Name",
      "brand": "Brand1",
      "color": "Black",
      "category": "Footwear",
      "subCategory": "Shoe",
      "serialNumber": "100",
      "price": 100.00,
      "finalAmountPaid": 100.00,
      "imageUrl": "xyz",
      "storeCreditsUsed": 0.0,
      "subTaxItemData": [
        {
          "type": "type",
          "rate": 10,
          "taxPerUnit": 10,
          "taxTotal": 10
        }
      ],
      "returnOrderItemAttributes": {
        "attribute1": "string",
        "attribute2": "string",
        "attribute3": "string",
        "attribute4": "string",
        "attribute5": "string",
        "attribute6": "string",
        "attribute7": "string",
        "attribute8": "string",
        "attribute9": "string",
        "attribute10": "string",
        "channelMetadata": "string",
        "channelMetadataMap": {"mapKey1": "mapValue1", "mapKey2": "mapValue2"}
      },
      "channelMetaData": {}
    }
  ],
  "orderType": "CUSTOMER_RETURN",
  "awbNumber": "HYN402",
  "transporter": "transporter",
  "currencyCode": "INR",
  "regionType": "INDIAN",
  "returnReason": "damaged product",
  "sellerGstin": "29AADCP7081J1ZY",
  "consigneeGstin": "29AAHCT2518N1ZW",
  "shipmentDimension": {
    "breadth": 10,
    "height": 10,
    "length": 10,
    "weight": 1
  },
  "dropAddress": {
    "name": "customerName",
    "line1": "address line 1",
    "line2": "address line 2",
    "line3": "address line 3",
    "city": "Bengaluru",
    "state": "Karnataka",
    "zip": "560076",
    "country": "INDIA",
    "email": "email.com",
    "phone": "9999999999",
    "longitude": 77.5946,
    "latitude": 12.9716,
    "openLocationCode": "7J4VXJ2R+PV"
  },
  "pickupAddress": {
    "name": "customerName",
    "line1": "address line 1",
    "line2": "address line 2",
    "line3": "address line 3",
    "city": "Bengaluru",
    "state": "Karnataka",
    "zip": "560076",
    "country": "INDIA",
    "email": "email.com",
    "phone": "9999999999",
    "longitude": 77.5946,
    "latitude": 12.9716,
    "openLocationCode": "7J4VXJ2R+PV"
  },
  "orderDetails": {
    "codValue": 0,
    "invoiceNumber": "INV-10",
    "invoiceTime": "2020-10-16T20:22:28.000+05:30",
    "invoiceValue": 100.00,
    "isCod": false,
    "forwardShipmentNumber": "101"
  },
  "returnOrderAttributes": {
    "attribute1": "string",
    "attribute2": "string",
    "attribute3": "string",
    "attribute4": "string",
    "attribute5": "string",
    "attribute6": "string",
    "attribute7": "string",
    "attribute8": "string",
    "attribute9": "string",
    "attribute10": "string",
    "channelMetadata": "string"
  },
  "channelMetaData": {}
}

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. Format eg : `2020-10-16T20:22:28.000+05:30`	No
`returnOrderStatus`	String	The Status of the return order	No
`expectedDate`	String	Expected date of return. Format eg : `2020-10-16T20:22:28.000+05:30`	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. Note: Max character limit supported is 255 characters	Yes
`orderItems.channelSkuCode`	String	SKU code for return order item.	Yes
`orderItems.name`	String	Name of the product	Conditional Yes*
`orderItems.brand`	String	Brand of the product	Conditional Yes*†
`orderItems.enableDoorStepQc`	Boolean	To enable door step qc by courier	No
`orderItems.color`	String	Color of the product	Conditional Yes*†
`orderItems.category`	String	Category of the product	Conditional Yes*†
`orderItems.subCategory`	String	Sub Category of the product	Conditional Yes*†
`orderItems.serialNumber`	String	Serial number of the product	Conditional Yes*†
`orderItems.price`	Double	Price of the product	Conditional Yes*
`orderItems.finalAmountPaid`	Double	Final amount paid for the product	Conditional Yes*
`orderItems.imageUrl`	String	Image url of the product	No
`orderItems.storeCreditsUsed`	Double	Store credits for this line item	No
`orderItems.subTaxItemData`	Object[]	List of sub tax items object	Conditional Yes*†
`orderItems.returnOrderItemAttributes`	Object	Custom attributes of order item	No
`orderItems.returnOrderItemAttributes.attribute1`	String	Custom attribute 1	No
`orderItems.returnOrderItemAttributes.attribute2`	String	Custom attribute 2	No
`orderItems.returnOrderItemAttributes.attribute3`	String	Custom attribute 3	No
`orderItems.returnOrderItemAttributes.attribute4`	String	Custom attribute 4	No
`orderItems.returnOrderItemAttributes.attribute5`	String	Custom attribute 5	No
`orderItems.returnOrderItemAttributes.attribute6`	String	Custom attribute 6	No
`orderItems.returnOrderItemAttributes.attribute7`	String	Custom attribute 7	No
`orderItems.returnOrderItemAttributes.attribute8`	String	Custom attribute 8	No
`orderItems.returnOrderItemAttributes.attribute9`	String	Custom attribute 9	No
`orderItems.returnOrderItemAttributes.attribute10`	String	Custom attribute 10	No
`orderItems.returnOrderItemAttributes.channelMetadata`	String	meta data fields as a string which is to be parsed at the channel's end	No
`orderItems.returnOrderItemAttributes.channelMetadataMap`	Map<String, String>	Key-value pairs of additional channel metadata for the order item	No
`orderItems.channelMetaData`	Object	Top-level channel metadata object for the order item	No
`subTaxItemData.type`	String	Type of tax applicable	Conditional Yes*†
`subTaxItemData.rate`	Double	Tax rate for this tax type	Conditional Yes*†
`subTaxItemData.taxPerUnit`	Double	Tax applicable for this type of tax per unit	Conditional Yes*†
`subTaxItemData.taxTotal`	Double	Total tax for this tax type	Conditional Yes*†
`orderType`	String	Type of return. Possible values → `SELF_SHIP`, `CUSTOMER_RETURN`, `RETURN_TO_ORIGIN`	Conditional Yes*
`awbNumber`	String	Courier tracking number	If courier partner integration done via Increff, then can be ignored. (Otherwise YES)
`transporter`	String	Courier partner name	If courier partner integration done via Increff, then can be ignored. (Otherwise YES)
`currencyCode`	String	Currency	Conditional Yes*
`regionType`	String	Can take two values: INDIAN and INTERNATIONAL, specifying the region type of order	Conditional Yes*
`sellerGstin`	String	Seller GSTIN. If logisticAggregatorType=CLICKPOST, then this field is mandatory. If logisticAggregatorType=SHIPROCKET, then this field can be null	Conditional Yes*
`consigneeGstin`	String	Consignee GSTIN	Conditional Yes*†
`returnReason`	String	The reason due to which the order was returned. Note: Max character limit supported is 255 characters	Conditional Yes*
`shipmentDimension`	Object	Package Dimensions	Conditional Yes*
`shipmentDimension.breadth`	Double	Breadth of package. Default value can be set as 1	Yes
`shipmentDimension.height`	Double	Height of package. Default value can be set as 1	Yes
`shipmentDimension.length`	Double	Length of package. Default value can be set as 1	Yes
`shipmentDimension.weight`	Double	Weight of package. Default value can be set as 200	Yes
`dropAddress`	Object	Shipping Address (Warehouse address)	Conditional Yes*
`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
`dropAddress.longitude`	Double	Longitude of the drop address	No
`dropAddress.latitude`	Double	Latitude of the drop address	No
`dropAddress.openLocationCode`	String	Open Location Code (Plus Code) of the drop address	No
`pickupAddress`	Object	Billing address of the customer	Conditional Yes*
`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
`pickupAddress.longitude`	Double	Longitude of the pickup address	No
`pickupAddress.latitude`	Double	Latitude of the pickup address	No
`pickupAddress.openLocationCode`	String	Open Location Code (Plus Code) of the pickup address	No
`orderDetails`	Object	Order Details	Conditional 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`	String	Invoice Time of the order. If logisticAggregatorType=CLICKPOST, then this field is mandatory. If logisticAggregatorType=SHIPROCKET, then this field can be null. Format eg : `2020-10-16T20:22:28.000+05:30`	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
`returnOrderAttributes`	Object	Custom attributes of the forward order	No
`returnOrderAttributes.attribute1`	String	Custom attribute 1	No
`returnOrderAttributes.attribute2`	String	Custom attribute 2	No
`returnOrderAttributes.attribute3`	String	Custom attribute 3	No
`returnOrderAttributes.attribute4`	String	Custom attribute 4	No
`returnOrderAttributes.attribute5`	String	Custom attribute 5	No
`returnOrderAttributes.attribute6`	String	Custom attribute 6	No
`returnOrderAttributes.attribute7`	String	Custom attribute 7	No
`returnOrderAttributes.attribute8`	String	Custom attribute 8	No
`returnOrderAttributes.attribute9`	String	Custom attribute 9	No
`returnOrderAttributes.attribute10`	String	Custom attribute 10	No

These fields are mandatory if courier partner integration needs to be done via Increff(ie. in cases where the channel does not have the AWB and transporter details and wants increff to fetch these details through the integration between increff and logistic aggregator)
† These fields are dependant on the Courier partner being integrated with, if it is mandatory for the courier partner, then they must be sent.

Response

Empty Body

HttpStatus : 200

Note: Max character limit supported is 255 characters