QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Migration
Migrate from 2025-01
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

Create Return

post
/returns

This API is used to create a Return. Currently, it only supports the "Refund" resolution and does not support "Replace with the same item" or "Exchange for anything."

Request

Body

order
object
required
external_id
string
required

The order ID of the original order on the e-commerce platform.

Example:
4254002020558
store
object
required
return_items
array[object]
required
external_order_item_id
string
required

The ID of the item on the e-commerce platform.

Example:
10579097059534
intended_return_quantity
integer
required

The number of items that the customer plans or expects to return.

>= 1
return_reason
string
required

The return reason provided by the customer.

Example:
Wrong size
return_subreason
string

If the return reason supports sub-reasons, this is the sub-reason provided by the customer.

Example:
Too small
return_reason_comment
string

Additional information provided by the customer regarding the reason for the return.

Example:
To Small
shopper_uploaded_image_urls
array[string]

The images provided by the customer when submitting a return.

resolution
string
required

The resolution for processing this item, currently only supports refund.

Allowed value:
refund
return_method
object
type
string
required
Allowed values:
retailer_labelcustomer_courierhappy_returnsin_storegreen_returnretail_reworkscarrier_pickup
refund_destination
string
required

The destination for the refund

Allowed values:
original_paymentstore_credit
Auth
:
Body
preparing...