...
Request
Code Block | ||
---|---|---|
| ||
{ "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” "consignmentNumber": "con1", “awbNumber”:”awb1” "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”"sellingPricePerUnit": 20.0, “isExcess” "isExcess": true, “virtualSkuChildItemReturnPostings”:[ { “returnOrderItemStatus”:”CREATED”, “channelSkuCode”:”1234”, “qcStatus”:”FAIL”, “qcReason”:”DAMAGED”, “barcode”:”bar1” } ] } ], "virtualSkuChildItemReturnPostings": [ { "returnOrderItemStatus": "CREATED", "channelSkuCode": "1234", "qcStatus": "FAIL", "qcReason": "DAMAGED", "barcode": "bar1" } ] } ], "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 |
| String | Reason for return as given by the customer | no |
| Long | Unique Identifier of a notification | Yes |
| String | Possible values - COD, NCOD | yes |
| String | Possible values- RETURN_TO_ORIGIN,CUSTOMER_RETURN,SELF_SHIP | No |
| ZonedDateTime | Time of event creation | yes |
| ZonedDateTime | Time of return order creation | no |
| Object[] | List of return items processed. | yes |
| String | This is provided by the ERP to uniquely identify each order item. | |
| String | Reason of return. | |
| 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 |
| Object | Shipping address of the customer | yes |
| String | Name of customer | yes |
| String | 1st line of customer’s address | yes |
| String | 2nd line of customer’s address | no |
| String | 3rd line of customer’s address | no |
| String | City of customer | yes |
| String | State of customer | yes |
| 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 | yes |
| String | 1st line of customer’s address | yes |
| String | 2nd line of customer’s address | no |
| String | 3rd line of customer’s address | no |
| String | City of customer | yes |
| String | State of customer | yes |
| String | ZIP/Pin code of customer | yes |
| String | Country of customer | yes |
| String | Email of customer | no |
| String | Phone Number of customer | no |
...