This API will call the channel with return order processing details.
This API will call the channel with return order processing details.This API will only get triggered after the return order is received and processed.
Here shipments object mention in payload represents the forward order information.
{
"partnerCode": "AZ123",
"locationCode": "ABCDEF",
"partnerLocationCode": "AZ1234",
"channelName": "AMAZON",
"returnOrderCode": "H893RUOT123",
"forwardOrderCode": "Dx784si",
"forwardParentOrderCode": "Dx784si",
"returnCreationTime": "2020-10-16T20:22:28.000+00:00",
"returnGateEntryCreationTime": "2020-10-16T20:22:28.000+00:00",
"messageId": 12345,
"paymentMethod": "COD",
"returnOrderType": "RETURN_TO_ORIGIN",
"eventTime": "2020-10-16T20:22:28.000+00:00",
"consignmentNumber": "con1",
"awbNumber": "awb1",
"items": [
{
"itemCode": "ic123",
"returnReason": "size misfit",
"channelSkuCode": "100007542",
"returnOrderItemStatus": "CREATED",
"channelDiscount": 10,
"sellerDiscount": 10,
"giftChargePerUnit": 10,
"qcStatus": "FAIL",
"qcReason": "DAMAGED",
"imageUrls": [
"<https://mydomain.com/img.jpg>",
"<https://mydomain.com/img2.jpg>"
],
"sellingPricePerUnit": 20.0,
"isExcess": true,
"barcode": "bar1",
"clientSkuCode": "ClientSkuCode1",
"returnItemCode": "retItem1",
"increffItemCode": "incItem1",
"channelMetaData": "string",
"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"}
},
"batchDetails": {
"batchId": 133,
"batchCode": "batchCode_94d47c303a38",
"mrp": 400,
"manufacturingDate": "2026-05-04T13:32:41.741+05:30",
"quantity": 1,
"expiryDate": "2026-05-04T13:32:41.741+05:30",
"supplierCode": "supplierCode_32b8ff1799c2"
},
"virtualSkuChildItemReturnPostings": [
{
"omsReturnItemId": "oms_124A43",
"returnOrderItemStatus": "CREATED",
"channelSkuCode": "1234",
"qcStatus": "FAIL",
"qcReason": "DAMAGED",
"barcode": "bar1",
"clientSkuCode": "ClientSkuCode1",
"batchDetails": {
"batchId": 112,
"batchCode": "batchCode_d4e502d51245",
"mrp": 0.00,
"manufacturingDate": "2026-05-04T13:32:41.737+05:30",
"quantity": 1,
"expiryDate": "2026-05-04T13:32:41.738+05:30",
"supplierCode": "supplierCode_34d6c985dc8c"
}
"increffItemCode": "incItem1",
"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"}
}
}
],
"bundledSkuChildItemReturnPostings": [
{
"barcode": "string",
"clientSkuCode": "ClientSkuCode1",
"channelSkuCode": "string",
"omsReturnItemId": 0,
"qcReason": "string",
"qcStatus": "PASS",
"returnOrderItemStatus": "CREATED",
"batchDetails": {
"batchId": 113,
"batchCode": "batchCode_389e00fb8fcf",
"mrp": 300,
"manufacturingDate": "2026-05-04T13:32:41.74+05:30",
"quantity": 1,
"expiryDate": "2026-05-04T13:32:41.74+05:30",
"supplierCode": "supplierCode_5238427a25b8"
}
"increffItemCode": "incItem1",
"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"}
}
}
]
}
],
"shipments": [
{
"shipmentCode": "UIfd897",
"locationCode": "loc1",
"omsShipmentId": 1000001020,
"generatedInvoiceId": "AR105044395",
"generatedInvoiceDate": "2020-10-16T20:22:28.000+00:00",
"externalInvoiceId": "FK56556GH45",
"externalInvoiceDate": "2020-10-16T20:22:28.000+00:00",
"invoiceDocumentUrl": "<https://mybrand.com/invoice123.pdf>",
"irn": "a429746e34d844c9d2cb2a6f68997d1c2af23987cc834f3b55da45d1b0bc27c0",
"qrCode": "eyJhbGciOiJSUzI1NiIs",
"shippingLabelDocumentUrl": "<https://mybrand.com/sldoc.pdf>",
"shipmentStatus": "MANIFESTED",
"awbNumber": "awb-ship1",
"transporter": "BLUEDART",
"packageSku": "PKG-SKU-001",
"deliveredAt": "2020-10-18T20:22:28.000+00:00",
"packedAt": "2020-10-16T20:22:28.000+00:00",
"shipmentDetails": {
"length": 12.0,
"breadth": 6.0,
"height": 8.0,
"weight": 13.0,
"shipmentId": 1000001020,
"totalItemQuantity": 2,
"packboxDetailsList": [
{
"length": 12.0,
"breadth": 6.0,
"height": 8.0,
"weight": 13.0,
"boxId": 1000001021,
"awbNumber": "awb-box1",
"packBoxRemarks": "Handle with care",
"volWeight": 235.5,
"boxSkuId": "bsku_1",
"boxCode": "1000001020",
"skuQuantityDataList": [
{
"globalSkuId": 1000004230,
"clientSkuId": "clientSku",
"count": 1
}
]
}
]
},
"shipmentItems": [
{
"channelSkuCode": "100000789702",
"orderItemCode": "item123",
"channelDiscount": 122.45,
"netTaxAmountPerUnit": 60,
"netTaxAmountTotal": 120,
"baseSellingPricePerUnit": 500,
"baseSellingPriceTotal": 1000,
"sellingPricePerUnit": 560,
"sellingPriceTotal": 1120,
"quantity": 2,
"barcode": "bar1",
"clientSkuCode": "ClientSkuCode1",
"taxItems": [
{
"type": "SGST",
"rate": 6,
"taxPerUnit": 30,
"taxTotal": 60
},
{
"type": "CGST",
"rate": 6,
"taxPerUnit": 30,
"taxTotal": 60
}
]
}
]
}
],
"virtualSkuDefinitions": [
{
"virtualParentChannelSkuId": "ch_sku",
"virtualParentBarcode": "bar",
"virtualParentClientSkuCode": "VPClientSkuCode1",
"childSkus": [
{
"channelSkuCode": "ch_sku",
"qty": 47,
"barcode": "shoe14h124",
"clientSkuCode": "ClientSkuCode1"
}
]
}
],
"bundledSkuDefinitions": [
{
"childSkus": [
{
"barcode": "string",
"channelSkuCode": "string",
"clientSkuCode": "ClientSkuCode1",
"qty": 0,
"mrp": 100.0
}
],
"bundledParentBarcode": "string",
"bundledParentChannelSkuId": "string",
"bundledParentClientSkuCode": "BPClientSkuCode1",
"mrp": 100.0
}
],
"shippingAddress": {
"name": "Sender's Name",
"line1": "Line Address 1",
"line2": "Line Address 2",
"line3": "Line Address 3",
"city": "city",
"state": "state",
"zip": "zip",
"country": "country",
"email": "[email protected]",
"phone": "9999999999",
"longitude": 77.5946,
"latitude": 12.9716,
"openLocationCode": "7J4VXJ2R+PV"
},
"billingAddress": {
"name": "customer",
"line1": "address line 1",
"line2": "address line 2",
"line3": "address line 3",
"city": "Bengaluru",
"state": "Karnataka",
"zip": "560076",
"country": "INDIA",
"email": "[email protected]",
"phone": "9999999999",
"longitude": 77.5946,
"latitude": 12.9716,
"openLocationCode": "7J4VXJ2R+PV"
},
"orderCustomAttributes": {
"attribute1": "1",
"attribute2": "2",
"attribute3": "3",
"attribute4": "4",
"attribute5": "5",
"attribute6": "6",
"attribute7": "7",
"attribute8": "8",
"attribute9": "9",
"attribute10": "10",
"channelMetadata": "gg",
"channelMetadataMap": {"mapKey1": "mapValue1", "mapKey2": "mapValue2"},
"currency": "INR"
},
"orderItemCustomAttributes": [
{
"barcode": "string",
"clientSkuCode": "ClientSkuCode1",
"channelSkuCode": "string",
"orderItemCode": "string",
"orderItemCustomAttributes": {
"attribute1": "1",
"attribute2": "2",
"attribute3": "3",
"attribute4": "4",
"attribute5": "5",
"attribute6": "6",
"attribute7": "7",
"attribute8": "8",
"attribute9": "9",
"attribute10": "10",
"channelMetadata": "gg",
"channelMetadataMap": {"mapKey1": "mapValue1", "mapKey2": "mapValue2"}
}
}
],
"returnOrderAttributes": {
"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": "string",
"deliveryChallanNumber": "string",
"deliveryChallanPdfUrl": "string"
}
| Parameter Name | Data Type | Description | Mandatory |
|---|---|---|---|
partnerCode |
String | This is customer code in channel | yes |
partnerLocationCode |
String | This is the code of the location of the customer in the channel. | yes |
locationCode |
String | Location code of the warehouse where the return order will be received. | yes |
channelName |
String | This is marketplace name | yes |
forwardOrderCode |
String | Unique code used by the channel to identify the forward order | yes |
forwardParentOrderCode |
String | Unique code used by the channel to identify the forward parent order | No |
returnOrderCode |
String | Unique code used by the channel to identify the return order | yes |
messageId |
Long | Unique Identifier of a notification ( for de-duplication) | Yes |
paymentMethod |
String | Possible values - COD, NCOD | yes |
returnOrderType |
String | Possible values- RETURN_TO_ORIGIN, CUSTOMER_RETURN, SELF_SHIP | yes |
eventTime |
ZonedDateTime | Time of event creation | yes |
channelMetaData |
Object | meta data fields as an object which is to be parsed at the channel's end | No |
returnCreationTime |
ZonedDateTime | Time of return order creation | Yes |
returnGateEntryCreationTime |
ZonedDateTime | Time of return gate entry creation | No |
items |
Object[] | List of return items processed. | yes |
items.itemCode |
String | This is provided by the ERP to uniquely identify each order item. | yes |
items.returnReason |
String | Reason of return. | No |
items.channelSkuCode |
String | SKU code of return order item | yes |
items.channelDiscount |
Integer | Discount provided by shopfront channel per unit | No |
items.sellerDiscount |
Integer | Discount applied by seller on order per unit | No |
items.clientSkuCode |
String | SKU identifier added by brand | No |
items.increffItemCode |
String | Item barcode value generated from Increff system | No |
items.returnItemCode |
String | Item barcode value scanned during return order processing | No |
items.barcode |
String | Product barcode value | No |
items.giftChargePerUnit |
Integer | Per unit gift charge | No |
items.returnOrderItemStatus |
String | Status of the item. Possible values : CREATED, PROCESSING, MISSING, RECEIVED, CANCELLED, PARTIAL_MISSING_COMBO. |
yes |
items.qcStatus |
String | The qcStatus of the return Item. Possible values : PASS, FAIL | yes |
items.qcReason |
String | The reason due to which this return item has been market qc fail | No |
items.imageUrls |
String[] | It contains the list of urls of the images of the return items. It will only be populated in case that item has been marked as fail. | No |
items.sellingPricePerUnit |
Double | Selling price per unit of the item | yes |
items.isExcess |
Boolean | Flag to identify if the item is an excess item | No |
items.channelMetaData |
Object | Top-level channel metadata object for the order item | No |
items.virtualSkuChildItemReturnPostings |
Object[] | List of virtual SKU child items | No |
items.virtualSkuChildItemReturnPostings.omsReturnItemId |
Long | Increff return item id of the child SKU | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemStatus |
String | Possible values: CREATED, PROCESSING, MISSING, PARTIAL_MISSING_COMBO, RECEIVED, CANCELLED |
No |
items.virtualSkuChildItemReturnPostings.channelSkuCode |
String | Channel SKU code of the child SKU | No |
items.virtualSkuChildItemReturnPostings.qcStatus |
String | qc status of the child SKU. Possible values: PASS, FAIL |
No |
items.virtualSkuChildItemReturnPostings.qcReason |
String | qc reason of the child SKU | No |
items.virtualSkuChildItemReturnPostings.barcode |
String | barcode of the child SKU | No |
items.virtualSkuChildItemReturnPostings.clientSkuCode |
String | Unique identifier for a virtual child sku at client's end | No |
items.virtualSkuChildItemReturnPostings.batchDetails |
Object[] | Container object holding batch-level information and QC quantity breakdowns | No, Batch details will only be returned when client configuration flag enableBatchDetailsInInventoryAPI is enabled |
batchDetails array will be empty for SKUs without batch tracking |
| items.virtualSkuChildItemReturnPostings.batchDetails.batchId | Integer | Internal unique code/identifier for the batch | Yes (if batchDetails present) |
| items.virtualSkuChildItemReturnPostings.batchDetails.batchCode | String | Batch identifier as provided by an external system (supplier, ERP, WMS, etc.) | Yes (if batchDetails present) |
| items.virtualSkuChildItemReturnPostings.batchDetails.supplierCode | String | Unique code/identifier of the supplier associated with the batch. | Yes (if batchDetails present) |
| items.virtualSkuChildItemReturnPostings.batchDetails.manufacturingDate | String | Date when the batch was manufactured | No |
| items.virtualSkuChildItemReturnPostings.batchDetails.expiryDate | String | Date when the batch expires and should no longer be used/sold | No |
| items.virtualSkuChildItemReturnPostings.batchDetails.mrp | Decimal | Maximum Retail Price for items in the batch | No |
| items.virtualSkuChildItemReturnPostings.batchDetails.quantity | Integer | Quantity of SKU in the batch | Yes (if batchDetails present) |
| items.virtualSkuChildItemReturnPostings.increffItemCode | String | Item barcode value generated from Increff system for the child SKU | No |
| items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes | Object | Custom attributes for the child SKU | No |
| items.bundledSkuChildItemReturnPostings | Object[] | List of bundled SKU child items | No |
| items.bundledSkuChildItemReturnPostings.barcode | String | barcode of the child SKU | No |
| items.bundledSkuChildItemReturnPostings.clientSkuCode | String | Unique identifier for bundled child sku at client's end | No |
| items.bundledSkuChildItemReturnPostings.channelSkuCode | String | Channel SKU code of the child SKU | No |
| items.bundledSkuChildItemReturnPostings.omsReturnItemId | Long | Increff return item id of the child SKU | yes |
| items.bundledSkuChildItemReturnPostings.qcReason | String | qc reason of the child SKU | No |
| items.bundledSkuChildItemReturnPostings.qcStatus | String | qc status of the child SKU. Possible values: PASS, FAIL | yes |
| items.bundledSkuChildItemReturnPostings.returnOrderItemStatus | String | ReturnOrderItemStatus (CREATED, PROCESSING, MISSING, PARTIAL_MISSING_COMBO, RECEIVED, CANCELLED) | yes |
| items.bundledSkuChildItemReturnPostings.batchDetails | Object[] | Container object holding batch-level information and QC quantity breakdowns | No, Batch details will only be returned when client configuration flag enableBatchDetailsInInventoryAPI is enabled
batchDetails array will be empty for SKUs without batch tracking |
| items.bundledSkuChildItemReturnPostings.batchDetails.batchId | Integer | Internal unique code/identifier for the batch | Yes (if batchDetails present) |
| items.bundledSkuChildItemReturnPostings.batchDetails.batchCode | String | Batch identifier as provided by an external system (supplier, ERP, WMS, etc.) | Yes (if batchDetails present) |
| items.bundledSkuChildItemReturnPostings.batchDetails.supplierCode | String | Unique code/identifier of the supplier associated with the batch. | Yes (if batchDetails present) |
| items.bundledSkuChildItemReturnPostings.batchDetails.manufacturingDate | String | Date when the batch was manufactured | No |
| items.bundledSkuChildItemReturnPostings.batchDetails.expiryDate | String | Date when the batch expires and should no longer be used/sold | No |
| items.bundledSkuChildItemReturnPostings.batchDetails.mrp | Decimal | Maximum Retail Price for items in the batch | No |
| items.bundledSkuChildItemReturnPostings.batchDetails.quantity | Integer | Quantity of SKU in the batch | Yes (if batchDetails present) |
| items.bundledSkuChildItemReturnPostings.increffItemCode | String | Item barcode value generated from Increff system for the child SKU | No |
| items.bundledSkuChildItemReturnPostings.returnOrderItemAttributes | Object | Custom attributes for the child SKU | No |
| items.returnOrderItemAttributes | Object | Custom attributes of order item | No |
| items.returnOrderItemAttributes.attribute1 | String | Custom attribute 1 | No |
| items.returnOrderItemAttributes.attribute2 | String | Custom attribute 2 | No |
| items.returnOrderItemAttributes.attribute3 | String | Custom attribute 3 | No |
| items.returnOrderItemAttributes.attribute4 | String | Custom attribute 4 | No |
| items.returnOrderItemAttributes.attribute5 | String | Custom attribute 5 | No |
| items.returnOrderItemAttributes.attribute6 | String | Custom attribute 6 | No |
| items.returnOrderItemAttributes.attribute7 | String | Custom attribute 7 | No |
| items.returnOrderItemAttributes.attribute8 | String | Custom attribute 8 | No |
| items.returnOrderItemAttributes.attribute9 | String | Custom attribute 9 | No |
| items.returnOrderItemAttributes.attribute10 | String | Custom attribute 10 | No |
| items.returnOrderItemAttributes.channelMetadata | Object | meta data fields as an object which is to be parsed at the channel's end | No |
| items.returnOrderItemAttributes.channelMetadataMap | Map<String, String> | Key-value pairs of additional channel metadata for the order item | No |
| items.batchDetails | Object[] | Container object holding batch-level information and QC quantity breakdowns | No, Batch details will only be returned when client configuration flag enableBatchDetailsInInventoryAPI is enabled
batchDetails array will be empty for SKUs without batch tracking |
| items.batchDetails.batchId | Integer | Internal unique code/identifier for the batch | Yes (if batchDetails present) |
| items.batchDetails.batchCode | String | Batch identifier as provided by an external system (supplier, ERP, WMS, etc.) | Yes (if batchDetails present) |
| items.batchDetails.supplierCode | String | Unique code/identifier of the supplier associated with the batch. | Yes (if batchDetails present) |
| items.batchDetails.manufacturingDate | String | Date when the batch was manufactured | No |
| items.batchDetails.expiryDate | String | Date when the batch expires and should no longer be used/sold | No |
| items.batchDetails.mrp | Decimal | Maximum Retail Price for items in the batch | No |
| items.batchDetails.quantity | Integer | Quantity of SKU in the batch | Yes (if batchDetails present) |
| consignmentNumber | String | The consignment number associated with the return order | No |
| awbNumber | String | Return order AWB | No |
| virtualSkuDefinitions | Object[] | List of virtual sku definitions | No |
| virtualSkuDefinitions.virtualParentChannelSkuId | String | Channel SKU code of parent SKU | No |
| virtualSkuDefinitions.virtualParentBarcode | String | Barcode of parent SKU | No |
| virtualSkuDefinitions.virtualParentClientSkuCode | String | Unique identifier for a parent virtual sku at client's end | No |
| virtualSkuDefinitions.childSkus | Object[] | List of child SKU associated with parent SKU | No |
| virtualSkuDefinitions.childSkus.channelSkuCode | String | Channel SKU code of child SKU | No |
| virtualSkuDefinitions.childSkus.qty | Integer | Quantity of child SKU, the parent SKU comprises of | No |
| virtualSkuDefinitions.childSkus.barcode | String | Barcode of child SKU | No |
{
"hasError": false,
"errorMessage": "Sample error message"
}