QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Reference
API Overview
Returns
Get return detail by ID
get
Get return detail by RMA number
get
Get returns
get
Return Dropoffs
Record dropped-off return items
post
Model
Envelope
Error
Resource
Return
Webhook
Webhook Overview
Webhook Outgoing IPs
Webhook Signature
Webhooks
Receive a webhook delivery of returns update
post
Support
Contact Support

Return

id
string
Example:
b3eedf69b7c0410d8975d4350c007705
rma_number
string
Example:
A1B2C3D4
filed_by
Allowed values:
shoppermerchantcustomer_support
approval_status
Allowed values:
submittedapproveddonerejectedexpired
merchant_note
string
Example:
This is an internal note
order
object
external_id
string
Example:
4254002020558
order_number
string
Example:
10001
order_name
string
Example:
#10001
customer
object
Example:
["customer@example.com"]
country
string

ISO 3166-1 alpha-3

Example:
USA
store
object
gift_return
GiftReturn
recipient
object
return_items
array[ReturnItem]
external_order_item_id
string
Example:
10579097059534
external_product_id
string
Example:
7002111410382
external_variant_id
string
Example:
41681852399822
sku
string
Example:
t-shirt-blue-xl
product_title
string
Example:
T-Shirt
intended_return_quantity
integer
Example:
2
variant_title
string
Example:
Blue - XL
return_reason
string
Example:
Wrong size
return_reason_comment
string
Example:
To Small
return_subreason
string
Example:
Too
discounted_price_including_tax
Money
ordered_quantity
integer
Example:
3
properties
array[object]
image_urls
array[string]
product_categories
array[string]
product_tags
array[string]
exchange_variant
ExchangeVariant
refunded_total
Money
shipments
array[ReturnShipment]
tracking_number
string
Example:
ABC123456789
tracking_status
string
Example:
InTransit
slug
string
Example:
usps
items
array[object]
label
object
packing_slip_url
string
Example:
https://cdn.example.com/x/y/z.pdf
shipping_documents_url
string
Example:
https://cdn.example.com/x/y/z.pdf
shipping_documents_components
array
Allowed values:
labelpacking_slipconditional_shipping_document
conditional_shipping_document_urls
array[string]
restocks
array[object]
items
array[object]
created_at
string
Example:
2024-01-01T00:00:00.001Z
Example
preparing...