Magento Create Return Order API

Created by
Last updated 25 April 2024, 10:44

Create Return Order

Inbound | POST  | /return-orders

Summary

This API is used to create B2C return orders in Increff Omni.

Description

This API is used to create B2C return orders in Increff Omni. One order item represents only one quantity of an SKU. If there are multiple quantities of the same SKU then multiple order items should be created.

Request

{
    "forwardOrderCode": "108",
    "returnOrderCode": "100078",
    "locationCode": "Wid234",
    "returnOrderTime": "2020-10-16T20:22:28.000+05:30",
    "orderItems": [
        {
            "itemCode": "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. This will be the entity_id of the forward order created in Increff Omni

yes

returnOrderCode

String

This is a unique identifier provided by the channel to identify the return order

yes

locationCode

String

Location code of the warehouse where the return order will be received. This is the location code of order in Increff Omni.

yes

returnOrderTime

String

Time at which return order got placed by customer. This should be in the format as mentioned above

no

orderItems

Object[]

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

yes

orderItems.itemCode

String

This is a unique identifier provided by the channel to identify the return order item.

yes

orderItems.reason

String

Reason for return as given by the customer.

yes

orderItems.channelSkuCode

String

SKU code for return order item.

yes

orderType

String

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

yes

awbNumber

String

Courier tracking number.

no

transporter

String

Courier partner name.

no

Response

Empty Body

HttpStatus : 200