Return Order Processed Notification to POS
- Prabal Pandit
- Alaf Azam Khan
Outbound | POST | {Client’s URL}
Summary
This API will call the client POS system with return order processing details for B2C orders.
Description
This API will call the client POS system with return order processing details for B2C orders.This API will be triggered only after the return order has been received and processed in Omni.Â
After receiving the return order processed notification, client POS system should trigger an inventory update subject to inventory changes.
Request
{ "locationCode": "Wid234", "channelName": "AMAZON", "returnOrderCode": "H893RUOT123", "forwardOrderCode": "Dx784si", "returnCreationTime": "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", "qcStatus": "FAIL", "qcReason": "DAMAGED", "imageUrls": [ "https://mydomain.com/img.jpg", "https://mydomain.com/img2.jpg" ], "sellingPricePerUnit": 20, "isExcess": true, "virtualSkuChildItemReturnPostings": [ { "omsReturnItemId": 12345, "returnOrderItemStatus": "CREATED", "channelSkuCode": "1234", "qcStatus": "FAIL", "qcReason": "DAMAGED", "barcode": "bar1" } ] } ], "virtualSkuDefinitions": [ { "virtualParentChannelSkuId": "ch_sku", "virtualParentBarcode": "bar", "childSkus": [ { "channelSkuCode": "ch_sku", "qty": 47, "barcode": "shoe14h124" } ] } ] "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": "abc@gmail.com", "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": "abc@gmail.com", "phone": "9999999999" } }
Â
Parameter Name | Data Type | Description | Mandatory |
| String | Location code of the warehouse where the return order will be received. | yes |
| String | This is marketplace name | yes |
| String | Unique code used by the channel to identify the forward order | yes |
| String | Unique code used by the channel to identify the return order | yes |
| Long | Unique Identifier of a notification ( for de-duplication) | Yes |
| String | Possible values - COD, NCOD | yes |
| String | Possible values- RETURN_TO_ORIGIN,CUSTOMER_RETURN,SELF_SHIP | yes |
| ZonedDateTime | Time of event creation | yes |
| ZonedDateTime | Time of return order creation | yes |
| Object[] | List of return items processed. | yes |
| String | This is provided by the ERP to uniquely identify each order item. | yes |
| String | Reason of return. | no |
| String | SKU code of return order item | yes |
| String | Status of the item. Possible values :Â CREATED, PROCESSING, MISSING, RECEIVED, CANCELLED,PARTIAL_MISSING_COMBO. | yes |
| String | The qcStatus of the return Item. Possible values : PASS , FAIL | yes |
| String | The reason due to which this return item has been market qc fail | no |
| 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 |
| Double | Selling price per unit of the item | yes |
| Boolean | Flag to identify if the item is an excess item | no |
| Object[] | List of virtual SKU child items | no |
| Long | Increff return item id of the child SKU | yes |
| String | Possible values:
| yes |
| String | Channel SKU code of the child SKU | no |
| String | qc status of the child SKU
| yes |
| String | qc reason of the child SKU | no |
| String | barcode of the child SKU | yes |
| String | The consignment number associated with the return order | no |
| String | Return order AWB | no |
| Object[] | List of virtual sku definitions | no |
| String | Channel SKU code of parent SKU | no |
| String | Barcode of parent SKU | no |
| Object[] | List if child SKU associated with parent SKU | no |
| String | Channel SKU code of child SKU | no |
| Integer | Quantity of child SKU, the parent SKU comprises of | no |
| String | Barcode of child SKU | no |
| Object | Shipping address of the customer | yes |
| String | Name of customer | no (Not sent when channel does not send these details eg: Amazon) |
| String | 1st line of customer’s address | no (Not sent when channel does not send these details eg: Amazon) |
| String | 2nd line of customer’s address | no |
| String | 3rd line of customer’s address | no |
| String | City of customer | no (Not sent when channel does not send these details eg: Amazon) |
| String | State of customer | no (Not sent when channel does not send these details eg: Amazon) |
| String | ZIP/Pin code of customer | yes |
| String | Country of customer | yes |
| String | Email of customer | no |
| String | Phone Number of customer | no |
| Object | Billing address of the customer | yes |
| String | Name of customer | no (Not sent when channel does not send these details eg: Amazon) |
| String | 1st line of customer’s address | no (Not sent when channel does not send these details eg: Amazon) |
| String | 2nd line of customer’s address | no |
| String | 3rd line of customer’s address | no |
| String | City of customer | no (Not sent when channel does not send these details eg: Amazon) |
| String | State of customer | no (Not sent when channel does not send these details eg: Amazon) |
| String | ZIP/Pin code of customer | yes |
| String | Country of customer | yes |
| String | Email of customer | no |
| String | Phone Number of customer | no |
Response
{
"hasError": false,
"errorMessage":"message"
}Â
HttpStatus : 200