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,
"giftChangePerUnit":10,
"qcStatus": "FAIL",
"qcReason": "DAMAGED",
"imageUrls": [
"<https://mydomain.com/img.jpg>",
"<https://mydomain.com/img2.jpg>"
],
"sellingPricePerUnit": 20.0,
"isExcess": true,
"channelMetaData": "string",
"returnOrderItemAttributes": {
"attribute1": "string",
"attribute10": "string",
"attribute2": "string",
"attribute3": "string",
"attribute4": "string",
"attribute5": "string",
"attribute6": "string",
"attribute7": "string",
"attribute8": "string",
"attribute9": "string",
"channelMetadata": "string"
},
"virtualSkuChildItemReturnPostings": [
{
"omsReturnItemId": "oms_124A43",
"returnOrderItemStatus": "CREATED",
"channelSkuCode": "1234",
"qcStatus": "FAIL",
"qcReason": "DAMAGED",
"barcode": "bar1",
"clientSkuCode": "ClientSkuCode1"
}
],
"bundledSkuChildItemReturnPostings": [
{
"barcode": "string",
"clientSkuCode": "ClientSkuCode1",
"channelSkuCode": "string",
"omsReturnItemId": 0,
"qcReason": "string",
"qcStatus": "PASS",
"returnOrderItemStatus": "CREATED"
}
]
}
],
"shipments": [
{
"shipmentCode": "UIfd897",
"locationCode": "loc1",
"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",
"shipmentItems": [
{
"channelSkuCode": "100000789702",
"orderItemCode": "item123",
"channelDiscount": 122.45,
"netTaxAmountPerUnit": 60,
"netTaxAmountTotal": 120,
"baseSellingPricePerUnit": 500,
"baseSellingPriceTotal": 1000,
"sellingPricePerUnit": 560,
"sellingPriceTotal": 1120,
"quantity": 2,
"taxItems": [
{
"type": "SGST",
"rate": 6,
"taxPerUnit": 30,
"taxTotal": 60
},
{
"type": "CGST",
"rate": 6,
"taxPerUnit": 30,
"taxTotal": 60
}
]
},
{
"channelSkuCode": "100000734701",
"orderItemCode": "item124",
"netTaxAmountPerUnit": 60,
"netTaxAmountTotal": 120,
"baseSellingPricePerUnit": 500,
"baseSellingPriceTotal": 1000,
"sellingPricePerUnit": 560,
"sellingPriceTotal": 1120,
"quantity": 2,
"shippingChargePerUnit": 10.0,
"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
}
],
"bundledParentBarcode": "string",
"bundledParentChannelSkuId": "string",
"bundledParentClientSkuCode":"BPClientSkuCode1"
}
],
"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"
},
"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"
},
"orderCustomAttributes": {
"attribute1": "1",
"attribute2": "2",
"attribute3": "3",
"attribute4": "4",
"attribute5": "5",
"attribute6": "6",
"attribute7": "7",
"attribute8": "8",
"attribute9": "9",
"attribute10": "10",
"channelMetadata": "gg",
"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"
}
}
],
"returnOrderAttributes": {
"attribute1": "string",
"attribute10": "string",
"attribute2": "string",
"attribute3": "string",
"attribute4": "string",
"attribute5": "string",
"attribute6": "string",
"attribute7": "string",
"attribute8": "string",
"attribute9": "string",
"channelMetadata": "string"
},
"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 |
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 Note: The value of returnCreationTime will be null in case the return orders are processed without the return order expectation created by Marketplaces or the user manually from CIMS. |
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.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.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.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.returnOrderItemAttributes |
Object[] | Custom attributes of order item | No |
items.returnOrderItemAttributes.orderItemCustomAttributes |
Object | List of attributes for the 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 |
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 if 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 |
virtualSkuDefinitions.childSkus.clientSkuCode |
String | Unique identifier for the child sku at client’s end | No |
bundledSkuDefinitions |
Object[] | List of bundled sku definitions | Yes |
bundledSkuDefinitions.mrp |
Double | MRP value of product | No |
bundledSkuDefinitions.bundledParentBarcode |
String | Unique barcode of bundled Sku | No |
bundledSkuDefinitions.bundledParentClientSkuCode |
String | Unique identifier of bundled sku at client’s end | No |
bundledSkuDefinitions.bundledParentChannelSkuId |
String | Unique identifier of bundled Sku at channel | Yes |
bundledSkuDefinitions.childSkus |
Object[] | List of child SKUs | Yes |
childSkus.barcode |
String | Unique barcode of child sku | No |
childSkus.channelSkuCode |
String | Unique identifier of child sku at channel | No |
childSkus.qty |
Integer | child sku quantity | No |
shipments |
Object[] | List of shipments in forward order | No |
shipments.shipmentCode |
String | Forward Shipment code | No |
shipments.generatedInvoiceId |
String | Invoice id generated for the Forward shipment | No |
shipments.generatedInvoiceDate |
ZonedDateTime | Invoice date generated for the Forward shipment | No |
shipments.invoiceDocumentUrl |
String | Url of the Forward invoice document | No |
shipments.shippingLabelDocumentUrl |
String | Url of the Forward shipping label doc | No |
shipments.externalInvoiceId |
String | Unique Forward invoice id provided by channel | No |
shipments.externalInvoiceDate |
ZonedDateTime | Forward Invoice date provided by channel | No |
shipments.irn |
String | IRN code of Forward shipment | No |
shipments.qrCode |
String | qr code of Forward shipment | No |
shipments.shipmentStatus |
String | Possible values: | |
OPEN,CLOSED,INVOICED,MANIFESTED,DISPATCHED,CANCELLED,DELIVERED |
No | ||
shipments.locationCode |
String | Location code of Forwardshipment | No |
shipments.shipmentItems |
Object[] | List of Forward shipment items | yes |
shipments.shipmentItems.channelSkuCode |
String | Channel SKU code | yes |
shipments.shipmentItems.orderItemCode |
String | Order item code | yes |
shipments.shipmentItems.channelDiscount |
Double | Channel discount on SKU | No |
shipments.shipmentItems.netTaxAmountPerUnit |
Double | Per unit tax applicable for the SKU. | yes |
shipments.shipmentItems.netTaxAmountTotal |
Double | Total tax applicable for the SKU | yes |
shipments.shipmentItems.baseSellingPricePerUnit |
Double | Per unit base selling price of the SKU | yes |
shipments.shipmentItems.baseSellingPriceTotal |
Double | Total base selling price of SKU | yes |
shipments.shipmentItems.sellingPricePerUnit |
Double | Per unit selling price of the SKU including tax | yes |
{
"hasError": false,
"errorMessage": "Sample error message"
}