Skip to end of banner
Go to start of banner

Return Order Processed Notification to POS (For Stores)

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

« Previous Version 3 Next »

Outbound | POST  | {Client’s URL}

Summary

This API will call the client system with return order processing details for B2C orders.

Description

This API will call the client system with return order processing details for B2C orders.This API will be triggered only after the return order has been received and processed in Omni. 

Request

{
  "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": [
        {
          "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

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

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,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

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