Return order

Returns order

Authorizations

Authorization

string

headerrequired

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

Headers

tenant-key

string

required

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.

Body

application/json

ReturnOrder Model

orderId

string

required

returnTimeStamp

string

required

employeeId

string

required

source

string

required

items

object[]

required

Show child attributes

attributes

object

Show child attributes

exchange

boolean

Response

201 - application/json

ReturnOrderResponse Model

refundStatus

enum<string>

Available options:

REFUND_INITIATED,

REFUND_SUCCESS,

REFUND_FAILURE,

REFUND_PENDING

totalRefund

number

items

object[]

Show child attributes