Order return by order ID
When customer’s return request is found to be eligible, this endpoint submits the return request by order ID.
Note: If you do not have order ID, use the corresponding order number-based endpoint- POST /orders/order-number/{orderNumber}/actions/submit-return-request
.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Merchant's 24-character tenant ID
Sales channel ID
Unique request ID
Path Parameters
24-character system-generated order ID returned in the response of Create Order - POST /orders
endpoint.
Body
Return request
Merchant-defined custom attributes. This is a placeholder for additional info in key: value pairs
Employee (ID or name) who initiatedthe request
true: Return includes one or more exchanges. false: Only returns, no exchange.
Item details
Merchant-defined reason code for return
Merchant-defined time for return (UTC)
Merchant-defined source from where the return request was initiated. There are no pre-defined values; possible values are Customer Service Representative (CSR), point-of-sale (POS), etc.
Merchant-defined total refund amount
Response
Details of returned order
Item details
Refund status
REFUND_INITIATED
, REFUND_SUCCESS
, REFUND_FAILURE
, REFUND_PENDING
Merchant-defined total refund amount