GET
/
order
/
returns

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

tenant-key
string
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Query Parameters

orderId
string
required
lineItemId
string

Response

200 - application/json

Order eligibility object

orderId
string

Order ID

eligibleReasonCodes
string[]

Reason codes allowed for returns

policyType
string

Policy type

period
string

Provides the configured duration for returns

items
object[]

List of items with their eligibility to return

fees
object[]

fees

Was this page helpful?

OverviewReturn order