GET
/
returns
/
{id}

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required

The id that needs to be fetched

Response

200 - application/json
id
string
status
string

The status of the return.

order_id
string

The order ID associated with the return.

rma
string

The return merchandise authorization number.

tracking_number
string

The tracking number of the returned item.

description
string

A description of the return.

customer_email
string

The email address of the customer who initiated the return.

zendesk_number
string

The unique identifier of the Zendesk ticket associated with the return.

action_needed
string

Any action required to process the return.

issue
string

The reason for the return.

order_string
string

The string the order was placed.

shipped_string
string

The string the order was shipped.

requested_string
string

The string the return was requested.

enteredBy
string

The name of the employee who entered the return into the system.

customer_id
string

The unique identifier of the customer who initiated the return.

amount
string

The amount of the return.

reported_condition
string

The condition of the returned item.

tax_refunded
string

The amount of tax refunded.

total_refunded
string

The total amount refunded.

created_string
string
default: now()

The string the return was created.

reason_category
string

The category of the reason for the return.

flat_rate_shipping
integer

The flat rate shipping amount.

refunded_string
string

The string the return was refunded.

warehouse_received_string
string

The string the return was received at the warehouse.

warehouse_condition_string
string

The string the condition of the return was verified at the warehouse.

fedex_status
string

The status of the return in FedEx.

scanned_serial_number
string

The serial number of the returned item.

match
string

Whether or not the serial number matches the order.

country
string

The country of the customer who initiated the return.

serial_number
string

The serial number of the returned item.

condition
string

The condition of the returned item.

order_refunded
boolean
default: false

Whether or not the order was refunded.

workflow_id
string

The workflow ID associated with the return.

sso_id
string

The unique identifier of the SSO user who initiated the return.

customer_email_normalized
string

The normalized email address of the customer who initiated the return.