Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Outbound | POST | {Client’s URL}

Summary

This API is used to pass on the return order expectation coming from marketplaces to external fulfilment systemsMarketplaces to External Fulfilment Systems.

Description

  • This API will push the return order expectations coming from

...

  • Marketplace APIs to External Fulfillment system.

  • This API will be triggered at a certain frequency by Increff OMS at RETURN_ORDER_CREATE event.

Request

Code Block
languagejson
{
  "forwardOrderCode": "108",
  "returnOrderCode": "100078",
  "locationCode": "Wid234",
  "channelName": "flipkart",
  "eventType": "RETURN_ORDER_CREATE",
  "returnOrderTime": "2020-10-16T20:22:28.000+05:30",
  "orderItems": [
    {
      "returnItemCode": "I10098",
      "reason": "Different Size",
      "channelSkuCode": "10007345"
    }
  ],
  "orderType": "CUSTOMER_RETURN",
  "awbNumber": "HYN402",
  "transporter": "transporter"
}

...

Parameter Name

Data Type

Description

Mandatory

forwardOrderCode

String

Forward order code for which return order is being created.

yesYes

eventType

String

Possible values : { RETURN_ORDER_CREATE}

yesYes

returnOrderCode

String

Unique identifier provided by the channel for the return order being created.

yesYes

locationCode

String

Location code of the warehouse where the return order will be received.

yesYes

channelName

String

Channel name of the marketplace.

yesYes

returnOrderTime

String

Time at which return order got placed by customer

noNo

orderItems

Object[]

Array of order items, order items represent each line of return order.

yesYes

orderItems.returnItemCode

String

Unique identifier provided by the channel for the return order item.

yesYes

orderItems.reason

String

Reason for return as given by the customer.

yesYes

orderItems.channelSkuCode

String

SKU code for return order item.

yesYes

orderType

String

Type of return. Possible values - SELF_SHIP,CUSTOMER_RETURN,RETURN_TO_ORIGIN

yesYes

awbNumber

String

Courier tracking number.

Yes

transporter

String

Courier partner name.

Yes

Response

Empty Body

HttpStatus : 200