An order or portion of an order is eligible for return only if it has been fulfilled and the items to be returned have not previously been returned. Even if it meets these conditions, the order may not be returnable, or individual items may not be returnable if an item’s eligible
property is set to false
in check order return eligibility API response, or if fabric OMS determines an item cannot be returned.
General Rules:
exchange
boolean (exchange
is set to false
) field on the return payload.POST/api/v2/order/return
endpoint to initiate order-return.ORDER_DELIVERED
, ORDER_SHIPPED
, ORDER_PARTIALLY_SHIPPED
, ORDER_PARTIALLY_DELIVERED
, ORDER_PARTIALLY_RETURNED
,ORDER_PARTIALLY_CANCELLED
, PICKUP_COMPLETE
.PENDING_EXCHANGE
,RETURN_PROCESSING
, PARTIALLY_CANCELLED
, PARTIALLY_REFUNDED
,PARTIALLY_CANCELLED_REFUNDED
,VALID
, PENDING_RETURN
, ORDER_LINE_VALID
, SHIPPED
, PARTIALLY_SHIPPED
, PARTIALLY_ALLOCATED
, DELIVERED
, PARTIALLY_DELIVERED
, PARTIAL_RETURN
.returnType
to PENDING
in the request payload while calling POST/api/v2/order/return to create a return.lineOrderStatus
will be updated to RETURN_PENDING
for the line item of an order ID. You can get the order details, along with the order status, by calling the GET/api/v2/order endpoint.RETURN_PENDING
webhook event is triggered if the merchant has subscribed to the event. The target URL of the subscription payload is notified.sample curl
returnType
to PROCESSING
in the request payload.lineOrderStatus
will be updated to RETURN_PROCESSING
for the line item of the order ID. You can get the order details, along with the order status, by calling the GET/api/v2/order endpoint.RETURN_PROCESSING
webhook event is triggered if the merchant has subscribed to the event. The target URL of the subscription payload is notified about the event.sample curl:
returnType
to REJECTED
.lineOrderStatus
is updated to RETURN_REJECTED
for the line item of the order ID. You can get the order details, along with the order status, by calling the GET/api/v2/order endpoint.RETURN_REJECTED
webhook event is triggered if the merchant has subscribed to the event. The target URL will be notified of the event.sample curl:
returnType
to received
.refundStatus
as SUCCESSFUL
.lineOrderStatus
(return status at item level) will be updated to RETURNED
.statusCode
(return status at order level) will be updated to ORDER_RETURNED
.lineOrderStatus
(return status at item level) will be updated to PARTIALLY_RETURNED
.statusCode
(return status at order level) will be updated to ORDER_PARTIALLY_RETURNED
.refundStatus
as REFUND_FAILED
.RETURN_NOTIFICATION_EMAIL
and REFUND_NOTIFICATION_EMAIL
webhook events are triggered if the merchant has subscribed to the events, and details are sent to the merchant.sample curl:
An order or portion of an order is eligible for return only if it has been fulfilled and the items to be returned have not previously been returned. Even if it meets these conditions, the order may not be returnable, or individual items may not be returnable if an item’s eligible
property is set to false
in check order return eligibility API response, or if fabric OMS determines an item cannot be returned.
General Rules:
exchange
boolean (exchange
is set to false
) field on the return payload.POST/api/v2/order/return
endpoint to initiate order-return.ORDER_DELIVERED
, ORDER_SHIPPED
, ORDER_PARTIALLY_SHIPPED
, ORDER_PARTIALLY_DELIVERED
, ORDER_PARTIALLY_RETURNED
,ORDER_PARTIALLY_CANCELLED
, PICKUP_COMPLETE
.PENDING_EXCHANGE
,RETURN_PROCESSING
, PARTIALLY_CANCELLED
, PARTIALLY_REFUNDED
,PARTIALLY_CANCELLED_REFUNDED
,VALID
, PENDING_RETURN
, ORDER_LINE_VALID
, SHIPPED
, PARTIALLY_SHIPPED
, PARTIALLY_ALLOCATED
, DELIVERED
, PARTIALLY_DELIVERED
, PARTIAL_RETURN
.returnType
to PENDING
in the request payload while calling POST/api/v2/order/return to create a return.lineOrderStatus
will be updated to RETURN_PENDING
for the line item of an order ID. You can get the order details, along with the order status, by calling the GET/api/v2/order endpoint.RETURN_PENDING
webhook event is triggered if the merchant has subscribed to the event. The target URL of the subscription payload is notified.sample curl
returnType
to PROCESSING
in the request payload.lineOrderStatus
will be updated to RETURN_PROCESSING
for the line item of the order ID. You can get the order details, along with the order status, by calling the GET/api/v2/order endpoint.RETURN_PROCESSING
webhook event is triggered if the merchant has subscribed to the event. The target URL of the subscription payload is notified about the event.sample curl:
returnType
to REJECTED
.lineOrderStatus
is updated to RETURN_REJECTED
for the line item of the order ID. You can get the order details, along with the order status, by calling the GET/api/v2/order endpoint.RETURN_REJECTED
webhook event is triggered if the merchant has subscribed to the event. The target URL will be notified of the event.sample curl:
returnType
to received
.refundStatus
as SUCCESSFUL
.lineOrderStatus
(return status at item level) will be updated to RETURNED
.statusCode
(return status at order level) will be updated to ORDER_RETURNED
.lineOrderStatus
(return status at item level) will be updated to PARTIALLY_RETURNED
.statusCode
(return status at order level) will be updated to ORDER_PARTIALLY_RETURNED
.refundStatus
as REFUND_FAILED
.RETURN_NOTIFICATION_EMAIL
and REFUND_NOTIFICATION_EMAIL
webhook events are triggered if the merchant has subscribed to the events, and details are sent to the merchant.sample curl: