Skip to end of banner
Go to start of banner

Return Order Posting API (to ERP)(Beta)

Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

Version 1 Next »

Outbound | POST | {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.

Here shipments object mention in payload represents the foward order information.

Request

{
    "partnerCode": "AZ123",
    "locationCode": "ABCDEF",
    "partnerLocationCode": "AZ1234",
    "channelName": "AMAZON",
    "returnOrderCode": "H893RUOT123",
    "forwardOrderCode": "Dx784si",
    "forwardParentOrderCode":"Dx784si",
    "returnCreationTime": "2020-10-16T20:22:28.000+00:00",
    "returnGateEntryCreationTime": "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": [
                {
                    "omsReturnItemId": "oms_124A43",
                    "returnOrderItemStatus": "CREATED",
                    "channelSkuCode": "1234",
                    "qcStatus": "FAIL",
                    "qcReason": "DAMAGED",
                    "barcode": "bar1"
                }
            ],
            "bundledSkuChildItemReturnPostings": [
            {
                  "barcode": "string",
                  "channelSkuCode": "string",
                  "omsReturnItemId": 0,
                  "qcReason": "string",
                  "qcStatus": "PASS",
                  "returnOrderItemStatus": "CREATED"
            }
          ]
        }
    ],
    "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": "eyJhbGciOiJSUzI1NiIs",
            "shippingLabelDocumentUrl": "https://mybrand.com/sldoc.pdf",
            "shipmentStatus": "MANIFESTED",
            "shipmentItems": [
                {
                    "channelSkuCode": "100000789702",
                    "orderItemCode": "item123",
                    "channelDiscount": 122.45,
                    "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
                        }
                    ]
                }
            ]
        }
    ],
    "virtualSkuDefinitions": [
      {
        "virtualParentChannelSkuId": "ch_sku",
        "virtualParentBarcode": "bar",
        "childSkus": [
          {
            "channelSkuCode": "ch_sku",
            "qty": 47,
            "barcode": "shoe14h124"
          }
        ]
      }
    ],
    "bundledSkuDefinitions": [
    {
      "childSkus": [
        {
          "barcode": "string",
          "channelSkuCode": "string",
          "qty": 0
        }
      ],
      "bundledParentBarcode": "string",
      "bundledParentChannelSkuId": "string"
    }
  ],
    "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"
    },
    "orderCustomAttributes": {
        "attribute1": "1",
        "attribute2": "2",
        "attribute3": "3",
        "attribute4": "4",
        "attribute5": "5",
        "attribute6": "6",
        "attribute7": "7",
        "attribute8": "8",
        "attribute9": "9",
        "attribute10": "10",
        "channelMetadata": "gg",
        "currency": "INR"
    },
    "orderItemCustomAttributes": [
        {
            "barcode": "string",
            "channelSkuCode": "string",
            "orderItemCode": "string",
            "orderItemCustomAttributes": {
                "attribute1": "1",
                "attribute2": "2",
                "attribute3": "3",
                "attribute4": "4",
                "attribute5": "5",
                "attribute6": "6",
                "attribute7": "7",
                "attribute8": "8",
                "attribute9": "9",
                "attribute10": "10",
                "channelMetadata": "gg"
            }
        }
    ]
}

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

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

returnGateEntryCreationTime

ZonedDateTime

Time of return gate entry creation 

Note: The value of returnCreationTime will be null in case the return orders are processed without the return order expectation created by Marketplaces or the user manually from CIMS.

no

items

Object[]

List of return items processed.

yes

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.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.bundledSkuChildItemReturnPostings

Object[]

List of bundled SKU child items

no

items.bundledSkuChildItemReturnPostings.barcode

String

barcode of the child SKU

yes

items.bundledSkuChildItemReturnPostings.omsReturnItemId

Long

Increff return item id of the child SKU

yes

items.bundledSkuChildItemReturnPostings.qcReason

String

qc reason of the child SKU

no

items.bundledSkuChildItemReturnPostings.qcStatus

String

qc status of the child SKU
Possible values:

PASS,FAIL

yes

items.bundledSkuChildItemReturnPostings.returnOrderItemStatus

String

ReturnOrderItemStatus
(CREATED,PROCESSING,MISSING,PARTIAL_MISSING_COMBO,RECEIVED,CANCELLED)

yes

consignmentNumber

String

The consignment number associated with the return order

no

awbNumber

String

Return order AWB

no

virtualSkuDefinitions

Object[]

List of virtual sku definitions

no

virtualSkuDefinitions.virtualParentChannelSkuId

String

Channel SKU code of parent SKU

no

virtualSkuDefinitions.virtualParentBarcode

String

Barcode of parent SKU

no

virtualSkuDefinitions.childSkus

Object[]

List if child SKU associated with parent SKU

no

virtualSkuDefinitions.childSkus.channelSkuCode

String

Channel SKU code of child SKU

no

virtualSkuDefinitions.childSkus.qty

Integer

Quantity of child SKU, the parent SKU comprises of

no

virtualSkuDefinitions.childSkus.barcode

String

Barcode of child SKU

no

bundledSkuDefinitions

Object[]

List of bundled sku definitions

yes

bundledSkuDefinitions.bundledParentBarcode

String

Unique barcode of bundled Sku

no

bundledSkuDefinitions.bundledParentChannelSkuId

String

Unique identifier of bundled Sku at channel

yes

bundledSkuDefinitions.childSkus

Object[]

List of child SKUs

yes

childSkus.barcode

String

Unique barcode of child sku

no

childSkus.channelSkuCode

String

Unique identifier of child sku at channel

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.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.channelDiscount

Double

Channel discount on SKU

no

shipments.shipmentItems.netTaxAmountPerUnit

Double

Per unit tax applicable for the SKU.

yes

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.shippingChargePerUnit

Double

Shipping charge per unit 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

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

(Not sent when channel does not send these details eg: Amazon)

no

billingAddress.state

String

State of customer

no

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

orderCustomAttributes

Object

Custom attributes of order

no

orderCustomAttributes.attribute1

String

Custom attribute 1

no

orderCustomAttributes.attribute2

String

Custom attribute 2

no

orderCustomAttributes.attribute2

String

Custom attribute 2

no

orderCustomAttributes.attribute3

String

Custom attribute 3

no

orderCustomAttributes.attribute4

String

Custom attribute 4

no

orderCustomAttributes.attribute5

String

Custom attribute 5

no

orderCustomAttributes.attribute6

String

Custom attribute 6

no

orderCustomAttributes.attribute7

String

Custom attribute 7

no

orderCustomAttributes.attribute8

String

Custom attribute 8

no

orderCustomAttributes.attribute9

String

Custom attribute 9

no

orderCustomAttributes.attribute10

String

Custom attribute 10

no

orderCustomAttributes.currency

String

Currency

no

orderCustomAttributes.channelMetaData

Object

meta data fields as an object which is to be parsed at the channel’s end

no

orderItemCustomAttributes

Object[]

Custom attributes of order item

no

orderItemCustomAttributes.orderItemCustomAttributes

Object

List of attributes for the order item

no

orderItemCustomAttributes.attribute1

String

Custom attribute 1

no

orderItemCustomAttributes.attribute2

String

Custom attribute 2

no

orderItemCustomAttributes.attribute3

String

Custom attribute 3

no

orderItemCustomAttributes.attribute4

String

Custom attribute 4

no

orderItemCustomAttributes.attribute5

String

Custom attribute 5

no

orderItemCustomAttributes.attribute6

String

Custom attribute 6

no

orderItemCustomAttributes.attribute7

String

Custom attribute 7

no

orderItemCustomAttributes.attribute8

String

Custom attribute 8

no

orderItemCustomAttributes.attribute9

String

Custom attribute 9

no

orderItemCustomAttributes.attribute10

String

Custom attribute 10

no

orderItemCustomAttributes.channelMetaData

Object

meta data fields as an object which is to be parsed at the channel’s end

no

orderItemCustomAttributes.barcode

String

Unique barcode of the order item

no

orderItemCustomAttributes.channelSkuCode

String

Unique sku code of the order item identifiable at channel’s end

no

orderItemCustomAttributes.orderItemCode

String

Unique item code of the order item identifiable in omni

no

Response

Empty Body

Http Status : 200

  • No labels