Outbound | PUT | {Client’s URL}
Summary
This API will call the channel with return order processing details.
Description
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.
Request
{
"partnerCode": "AZ123",
"partnerLocationCode": "AZ1234",
"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.0,
"isExcess": true,
"virtualSkuChildItemReturnPostings": [
{
"returnOrderItemStatus": "CREATED",
"channelSkuCode": "1234",
"qcStatus": "FAIL",
"qcReason": "DAMAGED",
"barcode": "bar1"
}
]
}
],
"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": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCNThFQTVFNkY0QUFDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ0eXAiOiJKV1QiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGcifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFPQ001MzI2SjFaWVwiLFwiQnV5ZXJHc3RpblwiOlwiMjlBQUJDUjE3MThFMVpMXCIsXCJEb2NOb1wiOlwiTUVhajIyLTIzLzUwNTlcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTMvMTAvMjAyMlwiLFwiVG90SW52VmFsXCI6MTgxNy4wNCxcIkl0ZW1DbnRcIjoxLFwiTWFpbkhzbkNvZGVcIjpcIjYyMTE0MjkwXCIsXCJJcm5cIjpcImE0Mjk3NDZlMzRkODQ0YzlkMmNiMmE2ZjY4OTk3ZDFjMmFmMjM5ODdjYzgzNGYzYjUyZGE0NWQxYjBiYzk3YzlcIixcIklybkR0XCI6XCIyMDIyLTEwLTEzIDEyOjAxOjAwXCJ9IiwiaXNzIjoiTklDIn0.wvB7b15AnpdQdX_d0VZEyj9dL1qWDaOFPLRPrlV0V2XIu3cE3aQ3YtsWLnTnyrmtUlokpbkkE4folBQNhfzkCPlnODNxRPfpO-Kz9eyNpqcIEp-8TqvcDKXZ3PrBRqmNmner00AG_fVmmqT1HLiyKB2sqOnhqtCfQaQF-PGnqIOhal3PDxIMVt0WAtaQOIwwDA75dsjjnFHaZFPl9tFPR8A6Wrw4NhQH-7xhABKW3Z961a_rGmO6M3XP7jPHyYPW-QWMfTqwNXwxNdFgFeML5FloPiUipt2-g4FIplgm-KcN1xMvEQ2irAfzQwbnxi7UKz-jwOgM0Zy2BbburYgDvQ",
"shippingLabelDocumentUrl": "https://mybrand.com/sldoc.pdf",
"shipmentItems": [
{
"channelSkuCode": "100000789702",
"orderItemCode": "item123",
"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
}
]
}
]
}
],
"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 | This is customer code in channel | yes |
| String | This is the code of the location of the customer in the channel. | yes |
| 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. | 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 |
| String | Unique invoice date provided by channel | yes |
| String | Downloadable pdf url of the invoice document | no |
| String | Downloadable pdf url of the shipping label document | no |
| Object[] | Items belonging to this shipment | yes |
| String | SKU code of order item | yes |
| String | This is provided by the channel to uniquely identify each order item. | yes |
| Double | Per unit tax applicable for the SKU. | yes |
| Double | Total tax applicable for the SKU | yes |
| Double | Per unit base selling price of the SKU | yes |
| Double | Total base selling price of SKU | yes |
| Double | Per unit selling price of the SKU including tax | yes |
| Double | Total selling price of the SKU | yes |
| Integer | Quantity of the sku in the shipment item. | yes |
| Double | Shipping charge per unit for a shipment item | no |
| Object | Distribution of tax with tax type | yes |
| String | Type of tax applicable | yes |
| Double | Tax rate for this tax type | yes |
| Double | Tax applicable for this type of tax per unit | yes |
| Double | Total tax applicable for this type of tax | yes |
| 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 |
Response
{
"hasError": false,
"errorMessage":"message"
}
HttpStatus : 200