Return

Return object model

id
string
required

UUID without dashes in between

rma_number
string
required

Short id for return. It will be unique most of the time within a single store. It's for store customers to identify their returns.

Example:
EUGCX4FL
status
string
required
Allowed values:
submittedapprovedshippedreceivedrejecteddone
internal_notes
string
required
Example:
Please call him to confirm before sending the refund.
order
Order
required
id
string
required

UUID without dashes in between

order_number
string
required

The order number that a customer inputs on the returns page.

Example:
1005
customer_name
string
required
Example:
James Law
customer_email
string<email>
required
country
string
required

ISO_3166-1 Country Code in 3 letters

>= 3 characters<= 3 characters
Example:
USA
external_id
string

Order id in the eCommerce platform. E.g., Shopify order id

Example:
77
app
PlatformApp

app model

return_items
array[ReturnItem]
required
external_id
string
required
external_product_id
string
required
title
string
required
sku
string
required
ordered_quantity
integer
required
return_quantity
integer
required
price
Price
required

(Deprecated) The field was still maintained only for some legacy customers. Please do not depend on this value. For price, discount, tax, and other order data, please directly connect to order data source. Returns Center does not own and maintain order data, but only returns data.

image_url
string<uri>
required

(Deprecated) The field was still maintained only for some legacy customers. Please do not depend on this value. For product data, please directly connect to product data source. Returns Center does not own and maintain product data, but only returns data.

Example:
https://example..com/cool-stuff.jpg
exchange_variant
ExchangeVariant or null
return_reason
ReturnReason
subreason
string
Example:
cover is broken
merchant_tags
array[object]
bundled_items
array[object]

If current item is a bundle, this field includes its inner items.

resolution
Resolution
required
type
string
required
Allowed values:
store_creditoriginal_paymentexchange
exchange_notes
null or string
required

Only present when the resolution is exchange

Example:
Please ship to me with a new gift box
return_method
ReturnMethod
required
type
string
required
Allowed values:
retailer_labelcustomer_courierin_store
cost_of_return
CostOfReturn
required
label
Label
required
name
string
required

Return method name

zone
object
rule
object
created_at
string<date-time>

The moment when a customer successfully submits a return request.

updated_at
string<date-time>
tracking_number
string
required

The tracking number of the return shipment provided by the customer / merchant.

reject_reason
string
required
shipments
array[object]
tracking_number
string
items
array[object]
label
Label
Example
preparing...