QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Migration
Migrate from 2024-10
Reference
API Overview
Returns
Get return detail by ID
get
Get return detail by RMA number
get
Get returns
get
Create Return
post
Approve Return By RMA number
post
Approve Return By Return ID
post
Resolve Return By RMA number
post
Resolve Return By Return ID
post
Reject Return By RMA number
post
Reject Return By Return ID
post
Receive items by RMA number
post
Receive items by Return ID
post
Attach shipments by RMA number
post
Attach shipments by Return ID
post
Return Dropoffs
Record dropped-off return items
post
Return items
Update return items by Return ID
patch
Update return items By RMA number
patch
Item tags
Get item tags
get
Model
Primitive
Address
Money
Envelope
Meta
Error
Resource
Return
Return item
Item tag
Webhook
Webhook Overview
Webhook Specifications
Webhook Outgoing IPs
Webhook Signature
Support
Contact Support

Migrate from 2024-10 to 2025-01

API Endpoint Updates

Approve return API

In the 2025-01 version of the approve return API, we have enhanced the label customization capabilities. The original custom_label_reference field is no longer sufficient for these needs, so it will be removed in the 2025-01 version. A new field, customize_label_info, has been introduced. If you used custom_label_reference for label reference customization in the 2024-10 version, please switch to customize_label_info.label_reference.

Example

In 2024-10

preparing...

In 2025-01

preparing...

Order

  • Change order.country to order.country_region