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"
},
"forwardOrderCode": "string",
"shippingAddress": {
"city": "Bangalore",
"country": "India",
"email": "[email protected]",
"line1": "string",
"line2": "string",
"line3": "string",
"name": "string",
"phone": "9999999999",
"state": "Karnataka",
"zip": "560102"
},
"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",
"attribute10": "string",
"attribute2": "string",
"attribute3": "string",
"attribute4": "string",
"attribute5": "string",
"attribute6": "string",
"attribute7": "string",
"attribute8": "string",
"attribute9": "string",
"channelMetadata": "string",
"channelMetadataMap": {
"key1": "value1",
"key2": "value2"
}
}
}
],
"locationCode": "string",
"messageId": 0,
"returnOrderAttributes": {
"attribute1": "string",
"attribute10": "string",
"attribute2": "string",
"attribute3": "string",
"attribute4": "string",
"attribute5": "string",
"attribute6": "string",
"attribute7": "string",
"attribute8": "string",
"attribute9": "string",
"channelMetadata": "string",
"channelMetadataMap": {
"key1": "value1",
"key2": "value2"
}
},
"orderCustomAttributes": {
"attribute1": "1",
"attribute10": "10",
"attribute2": "2",
"attribute3": "3",
"attribute4": "4",
"attribute5": "5",
"attribute6": "6",
"attribute7": "7",
"attribute8": "8",
"attribute9": "9",
"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",
"attribute10": "10",
"attribute2": "2",
"attribute3": "3",
"attribute4": "4",
"attribute5": "5",
"attribute6": "6",
"attribute7": "7",
"attribute8": "8",
"attribute9": "9",
"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 |
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[] | 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.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 | contains custom attributes, channel metadata and channel metadata map | no |
items.posBundledSkuChildItemReturnPostings |
Object[] | List of bundled SKU child items | no |
items.posBundledSkuChildItemReturnPostings.barcode |
String | barcode of the child SKU | Yes |
items.posBundledSkuChildItemReturnPostings.channelSkuCode |
Long | Channel SKU code of the child SKU | no |
items.posBundledSkuChildItemReturnPostings.clientSkuCode |
String | Client sku code of the child sku | Yes |
items.posBundledSkuChildItemReturnPostings.omsReturnItemId |
String | 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.returnOrderItemAttributes |
Object | contains custom attributes, channel metadata and channel metadata map | no |
items.posBundledSkuChildItemReturnPostings.returnOrderItemStatus |
String | Possible values: | |
CREATED,PROCESSING,MISSING,PARTIAL_MISSING_COMBO,RECEIVED,CANCELLED |
Yes | ||
items.posBundledSkuChildItemReturnPostings.increffItemCode |
String | no | |
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 |
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.omsShipmentId |
Long | Increff OMS identifier for shipment | 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.netTaxAmountPerUnit |
Double | Per unit tax applicable for the SKU. | yes |
shipments.shipmentItems.clientSkuCode |
String | Client SKU identifier for the item | no |
shipments.shipmentItems.giftChargePerUnit |
Double | Gift charges per unit of the item | no |
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 |
shipments.shipmentItems.sellingPriceTotal |
Double | Total selling price of the SKU | yes |
shipments.shipmentItems.quantity |
Integer | Quantity of the sku in the shipment item. | yes |
shipments.shipmentItems.shippingCharge |
Double | Shipping charge for a shipment item | no |
shipments.shipmentItems.taxItems |
Object[] | Distribution of tax with tax type | yes |
shipments.shipmentItems.taxItems.type |
String | Type of tax applicable | yes |
shipments.shipmentItems.taxItems.rate |
Double | Tax rate for this tax type | yes |
shipments.shipmentItems.taxItems.taxPerUnit |
Double | Tax applicable for this type of tax per unit | yes |
shipments.shipmentItems.taxItems.taxTotal |
Double | Total tax applicable for this type of tax | yes |
shippingAddress |
Object | Shipping address of the customer | yes |
shippingAddress.name |
String | Name of customer | |
| (Not sent when channel does not send these details eg: Amazon) | no | ||
shippingAddress.line1 |
String | 1st line of customer’s address | |
| (Not sent when channel does not send these details eg: Amazon) | no | ||
shippingAddress.line2 |
String | 2nd line of customer’s address | no |
shippingAddress.line3 |
String | 3rd line of customer’s address | no |
shippingAddress.city |
String | City of customer | |
| (Not sent when channel does not send these details eg: Amazon) | no | ||
shippingAddress.state |
String | State of customer | |
| (Not sent when channel does not send these details eg: Amazon) | no | ||
shippingAddress.zip |
String | ZIP/Pin code of customer | yes |
shippingAddress.country |
String | Country of customer | yes |
shippingAddress.email |
String | Email of customer | no |
shippingAddress.phone |
String | Phone Number of customer | no |
billingAddress |
Object | Billing address of the customer | yes |
billingAddress.name |
String | Name of customer | |
| (Not sent when channel does not send these details eg: Amazon) | no | ||
billingAddress.line1 |
String | 1st line of customer’s address | |
| (Not sent when channel does not send these details eg: Amazon) | no |
Empty Body