Order return by order number
When the customer’s return request is determined to be eligible, this endpoint is used to process the return request.
Note: If you do not have the order number, but have order ID, use Return order by order ID endpoint - POST /orders/{orderId}/actions/submit-return-request.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
Unique request ID
Path Parameters
Merchant-defined order identifier
Body
Return request
Item details
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 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.
Merchant-defined reason code for return
Merchant-defined time for return (UTC)
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