Skip to end of banner
Go to start of banner

Return Order Processed Notification API to ERP

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 9 Next »

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

partnerCode

String

This is customer code in channel

yes

partnerLocationCode

String

This is the code of the location of the customer in the channel.

yes

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

returnReason

String

Reason for return as given by the customer

no

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

No

eventTime

ZonedDateTime

Time of event creation

yes

returnCreationTime

ZonedDateTime

Time of return order creation 

no

items

Object[]

List of return items processed.

yes

items.itemCode

String

This is provided by the ERP to uniquely identify each order item.

items.returnReason

String

Reason of return.

items.channelSkuCode

String

SKU code of return order item

yes

items.returnOrderItemStatus

String

Status of the item. Possible values : 

CREATED, PROCESSING, MISSING, RECEIVED, CANCELLED.

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

shipments.externalInvoiceDate

String

Unique invoice date provided by channel

yes

invoiceDocumentUrl

String

Downloadable pdf url of the invoice document

no

shippingLabelDocumentUrl

String

Downloadable pdf url of the shipping label document

no

shipments.shipmentItems

Object[]

Items belonging to this shipment

yes

shipmentItems.channelSkuCode

String

SKU code of order item

yes

shipmentItems.orderItemCode

String

This is provided by the channel to uniquely identify each order item.

yes

shipmentItems.netTaxAmountPerUnit

Double

Per unit tax applicable for the SKU.

yes

shipmentItems.netTaxAmountTotal

Double

Total tax applicable for the SKU

yes

shipmentItems.baseSellingPricePerUnit

Double

Per unit base selling price of the SKU

yes

shipmentItems.baseSellingPriceTotal

Double

Total base selling price of SKU

yes

shipmentItems.sellingPricePerUnit

Double

Per unit selling price of the SKU including tax

yes

shipmentItems.sellingPriceTotal

Double

Total selling price of the SKU 

yes

shipmentItems.quantity

Integer

Quantity of the sku in the shipment item.

yes

shipmentItems.shippingChargePerUnit

Double

Shipping charge per unit for a shipment item

no

shipmentItems.taxItems

Object

Distribution of tax with tax type

yes

taxItems.type

String

Type of tax applicable

yes

taxItems.rate

Double

Tax rate for this tax type

yes

taxItems.taxPerUnit

Double

Tax applicable for this type of tax per unit

yes

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

yes

shippingAddress.line1

String

1st line of customer’s address

yes

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

yes

shippingAddress.state

String

State of customer

yes

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

yes

billingAddress.line1

String

1st line of customer’s address

yes

billingAddress.line2

String

2nd line of customer’s address

no

billingAddress.line3

String

3rd line of customer’s address

no

billingAddress.city

String

City of customer

yes

billingAddress.state

String

State of customer

yes

billingAddress.zip

String

ZIP/Pin code of customer

yes

billingAddress.country

String

Country of customer

yes

billingAddress.email

String

Email of customer

no

billingAddress.phone

String

Phone Number of customer

no

Response

{
    "hasError": false,
    "errorMessage":"message"
}

HttpStatus : 200

  • No labels