This API will call the client POS system with return order processing details.
This API will call the client POS system with return order processing details. This API will be triggered only after the return order has been received and processed in Omni.
{
"awbNumber": "string",
"channelName": "string",
"consignmentNumber": "string",
"eventTime": "2023-06-30T03:32:58Z",
"billingAddress": {
"city": "Bangalore",
"country": "India",
"email": "[email protected]",
"line1": "string",
"line2": "string",
"line3": "string",
"name": "string",
"phone": "9999999999",
"state": "Karnataka",
"zip": "560102",
"longitude": 77.5946,
"latitude": 12.9716,
"openLocationCode": "7J4VXJ2R+PV"
},
"forwardOrderCode": "string",
"shippingAddress": {
"city": "Bangalore",
"country": "India",
"email": "[email protected]",
"line1": "string",
"line2": "string",
"line3": "string",
"name": "string",
"phone": "9999999999",
"state": "Karnataka",
"zip": "560102",
"longitude": 77.5946,
"latitude": 12.9716,
"openLocationCode": "7J4VXJ2R+PV"
},
"items": [
{
"barcode": "BAR123",
"clientSkuCode": "CSKU123",
"channelDiscount": 0,
"channelSkuCode": "string",
"giftChargePerUnit": 0,
"imageUrls": [
"string"
],
"isExcess": true,
"itemCode": "string",
"posBundledSkuChildItemReturnPostings": [
{
"clientSkuCode": "CSKU456",
"barcode": "string",
"channelSkuCode": "string",
"increffItemCode": "string",
"omsReturnItemId": 0,
"qcReason": "string",
"qcStatus": "PASS",
"returnOrderItemAttributes": {
"attribute1": "value1",
"attribute2": "value2",
"attribute3": "value3",
"attribute4": "value4",
"attribute5": "value5",
"attribute6": "value6",
"attribute7": "value7",
"attribute8": "value8",
"attribute9": "value9",
"attribute10": "value10",
"channelMetadata": "string",
"channelMetadataMap": {
"key1": "value1",
"key2": "value2"
}
},
"returnOrderItemStatus": "CREATED"
}
],
"virtualSkuChildItemReturnPostings": [
{
"clientSkuCode": "CSKU123",
"barcode": "string",
"channelSkuCode": "string",
"omsReturnItemId": 0,
"qcReason": "string",
"qcStatus": "PASS",
"returnOrderItemStatus": "CREATED",
"returnOrderItemAttributes": {
"attribute1": "value1",
"attribute2": "value2",
"attribute3": "value3",
"attribute4": "value4",
"attribute5": "value5",
"attribute6": "value6",
"attribute7": "value7",
"attribute8": "value8",
"attribute9": "value9",
"attribute10": "value10",
"channelMetadata": "string",
"channelMetadataMap": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"qcReason": "string",
"qcStatus": "PASS",
"returnOrderItemStatus": "CREATED",
"returnReason": "string",
"sellerDiscount": 0,
"sellingPricePerUnit": 0,
"returnOrderItemAttributes": {
"attribute1": "string",
"attribute2": "string",
"attribute3": "string",
"attribute4": "string",
"attribute5": "string",
"attribute6": "string",
"attribute7": "string",
"attribute8": "string",
"attribute9": "string",
"attribute10": "string",
"channelMetadata": "string",
"channelMetadataMap": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"locationCode": "string",
"messageId": 0,
"returnOrderAttributes": {
"attribute1": "string",
"attribute2": "string",
"attribute3": "string",
"attribute4": "string",
"attribute5": "string",
"attribute6": "string",
"attribute7": "string",
"attribute8": "string",
"attribute9": "string",
"attribute10": "string",
"channelMetadata": "string",
"channelMetadataMap": {
"key1": "value1",
"key2": "value2"
}
},
"orderCustomAttributes": {
"attribute1": "1",
"attribute2": "2",
"attribute3": "3",
"attribute4": "4",
"attribute5": "5",
"attribute6": "6",
"attribute7": "7",
"attribute8": "8",
"attribute9": "9",
"attribute10": "10",
"channelMetadata": "string",
"channelMetadataMap": {
"key1": "value1",
"key2": "value2"
},
"currency": "string"
},
"paymentMethod": "COD",
"returnCreationTime": "2023-06-30T03:32:58Z",
"returnOrderCode": "string",
"orderItemCustomAttributes": [
{
"barcode": "string",
"channelSkuCode": "string",
"clientSkuCode": "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": "string",
"channelMetadataMap": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"returnOrderType": "RETURN_TO_ORIGIN",
"shipments": [
{
"awbNumber": "string",
"deliveredAt": "2023-06-30T03:32:58Z",
"externalInvoiceId": "string",
"externalInvoiceDate": "2023-06-30T03:32:58Z",
"generatedInvoiceDate": "2023-06-30T03:32:58Z",
"generatedInvoiceId": "string",
"invoiceDocumentUrl": "string",
"irn": "string",
"omsShipmentId": 987654321,
"locationCode": "string",
"packageSku": "string",
"qrCode": "string",
"shipmentCode": "string",
"shipmentItems": [
{
"barcode": "string",
"baseSellingPricePerUnit": 0,
"baseSellingPriceTotal": 0,
"channelSkuCode": "string",
"netTaxAmountPerUnit": 0,
"netTaxAmountTotal": 0,
"clientSkuCode": "CSKU123",
"giftChargePerUnit": 2,
"orderItemCode": "string",
"quantity": 0,
"sellingPricePerUnit": 0,
"sellingPriceTotal": 0,
"shippingCharge": 0,
"taxItems": [
{
"rate": 0,
"taxPerUnit": 0,
"taxTotal": 0,
"type": "string"
}
]
}
],
"shippingLabelDocumentUrl": "string",
"shipmentStatus": "OPEN",
"transporter": "string"
}
],
"virtualSkuDefinitions": [
{
"childSkus": [
{
"barcode": "string",
"channelSkuCode": "string",
"qty": 0,
"clientSkuCode": "string"
}
],
"virtualParentBarcode": "string",
"virtualParentChannelSkuId": "string",
"virtualParentClientSkuCode": "string"
}
],
"bundledSkuDefinitions": [
{
"childSkus": [
{
"clientSkuCode": "string",
"barcode": "string",
"channelSkuCode": "string",
"qty": 0
}
],
"bundledParentBarcode": "string",
"bundledParentChannelSkuId": "string",
"bundledParentClientSkuCode": "string"
}
]
}
| Parameter Name | Data Type | Description | Mandatory |
|---|---|---|---|
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 |
returnCreationTime |
ZonedDateTime | Time of return order creation | Yes |
consignmentNumber |
String | The consignment number associated with the return order | No |
awbNumber |
String | Return order AWB | No |
items |
Object[] | List of return items processed. | Yes |
items.barcode |
String | barcode of the item | No |
items.clientSkuCode |
String | clientSkuCode of the item | No |
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.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[] | List of urls of the images of the return items. Populated only for items marked as fail. | No |
items.sellingPricePerUnit |
Double | Selling price per unit of the item | Yes |
items.channelDiscount |
Double | Discount provided by shopfront channel per unit | No |
items.sellerDiscount |
Double | Discount applied by seller on order per unit | No |
items.giftChargePerUnit |
Double | Per unit gift charge | No |
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.clientSkuCode |
String | Client sku code of the child sku | Yes |
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 | Yes |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes |
Object | Custom attributes for the child SKU | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes.attribute1 |
String | Custom attribute 1 | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes.attribute2 |
String | Custom attribute 2 | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes.attribute3 |
String | Custom attribute 3 | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes.attribute4 |
String | Custom attribute 4 | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes.attribute5 |
String | Custom attribute 5 | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes.attribute6 |
String | Custom attribute 6 | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes.attribute7 |
String | Custom attribute 7 | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes.attribute8 |
String | Custom attribute 8 | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes.attribute9 |
String | Custom attribute 9 | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes.attribute10 |
String | Custom attribute 10 | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes.channelMetadata |
Object | meta data fields as an object which is to be parsed at the channel's end | No |
items.virtualSkuChildItemReturnPostings.returnOrderItemAttributes.channelMetadataMap |
Map<String, String> | Key-value pairs of additional channel metadata | No |
items.posBundledSkuChildItemReturnPostings |
Object[] | List of bundled SKU child items | No |
items.posBundledSkuChildItemReturnPostings.barcode |
String | barcode of the child SKU | Yes |
items.posBundledSkuChildItemReturnPostings.channelSkuCode |
String | Channel SKU code of the child SKU | No |
items.posBundledSkuChildItemReturnPostings.clientSkuCode |
String | Client sku code of the child sku | Yes |
items.posBundledSkuChildItemReturnPostings.omsReturnItemId |
Long | Increff return item id of the child SKU | Yes |
items.posBundledSkuChildItemReturnPostings.qcReason |
String | qc reason of the child SKU | No |
items.posBundledSkuChildItemReturnPostings.qcStatus |
String | qc status of the child SKU | Yes |
items.posBundledSkuChildItemReturnPostings.returnOrderItemStatus |
String | Possible values: CREATED, PROCESSING, MISSING, PARTIAL_MISSING_COMBO, RECEIVED, CANCELLED |
Yes |
items.posBundledSkuChildItemReturnPostings.increffItemCode |
String | Item barcode value generated from Increff system for the child SKU | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes |
Object | Custom attributes for the child SKU | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes.attribute1 |
String | Custom attribute 1 | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes.attribute2 |
String | Custom attribute 2 | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes.attribute3 |
String | Custom attribute 3 | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes.attribute4 |
String | Custom attribute 4 | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes.attribute5 |
String | Custom attribute 5 | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes.attribute6 |
String | Custom attribute 6 | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes.attribute7 |
String | Custom attribute 7 | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes.attribute8 |
String | Custom attribute 8 | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes.attribute9 |
String | Custom attribute 9 | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes.attribute10 |
String | Custom attribute 10 | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes.channelMetadata |
Object | meta data fields as an object which is to be parsed at the channel's end | No |
items.posBundledSkuChildItemReturnPostings.returnOrderItemAttributes.channelMetadataMap |
Map<String, String> | Key-value pairs of additional channel metadata | 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 |
shipments |
Object[] | List of shipments in forward order | No |
shipments.shipmentCode |
String | Forward Shipment code | No |
shipments.locationCode |
String | Location code of Forward shipment | No |
shipments.omsShipmentId |
Long | Increff OMS identifier for shipment | No |
shipments.shipmentStatus |
String | Possible values: OPEN, CLOSED, INVOICED, MANIFESTED, DISPATCHED, CANCELLED, DELIVERED |
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.awbNumber |
String | AWB number of the forward shipment | No |
shipments.transporter |
String | Transporter name for the forward shipment | No |
shipments.packageSku |
String | SKU of the package material used for packing | No |
shipments.deliveredAt |
ZonedDateTime | Delivery timestamp of the forward shipment | No |
Empty Body