Page Comparison

...

After receiving the return order processed notification, client POS system should trigger an inventory update subject to inventory changes.

Request

Code Block

language	json

{
  "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
`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	Noyes
`eventTime`	ZonedDateTime	Time of event creation	yes
`returnCreationTime`	ZonedDateTime	Time of return order creation	noyes
`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	yes
`items.virtualSkuChildItemReturnPostings`.`returnOrderItemStatus`	String	Possible values: `CREATED,PROCESSING,MISSING,PARTIAL_MISSING_COMBO,RECEIVED,CANCELLED`	yes
`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`	yes
`items.virtualSkuChildItemReturnPostings.qcReason`	String	qc reason of the child SKU	no
`items.virtualSkuChildItemReturnPostings.barcode`	String	barcode of the child SKU	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
`shippingAddress`	Object	Shipping address of the customer	yes
`shippingAddress.name`	String	Name of customeryes	no (Not sent when channel does not send these details eg: Amazon)
`shippingAddress.line1`	String	1st line of customer’s addressyes	no (Not sent when channel does not send these details eg: Amazon)
`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 customeryes	no (Not sent when channel does not send these details eg: Amazon)
`shippingAddress.state`	String	State of customeryes	no (Not sent when channel does not send these details eg: Amazon)
`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 customeryes	no (Not sent when channel does not send these details eg: Amazon)
`billingAddress.line1`	String	1st line of customer’s addressyes	no (Not sent when channel does not send these details eg: Amazon)
`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 customeryes	no (Not sent when channel does not send these details eg: Amazon)
`billingAddress.state`	String	State of customeryes	no (Not sent when channel does not send these details eg: Amazon)
`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

...

Versions Compared

Old Version 7

New Version Current

Key

Request