QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Reference
API Overview
v2
Returns
Update Return Status
post
Update Return Status By RMA
post
Update return items
patch
Batch mark items as received
post
Update return items By RMA
patch
Merchant Tags
List Merchant Tags
get
Model
Envelope
Meta
v2
Error
v2
Primitive
CostOfReturn
v2
ExchangeVariant
v2
Label
v2
Order
v2
PlatformApp
v2
Price
v2
Resolution
v2
ReturnItem
v2
ReturnMethod
v2
ReturnReason
v2
Resource
Return
v2
Webhook
Webhook Overview
Webhook Signature
Webhook Outgoing IPs
Webhook Reference
Webhooks
Receive a webhook delivery of returns update
post
Support
Contact Support

Order

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
Example:
[email protected]
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

platform
string
<= 64 characters
Example:
shopify
key
string

This is the Shopify store’s name that comes ahead of the myshopify domain. E.g., For coolstuff.myshopify.com, coolstuff will be the key.

<= 256 characters
Example:
cool-stuff
Example
preparing...