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

ReturnItem

id
string

The ID of the item.

Example:
10579097059534
external_order_item_id
string

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

Example:
10579097059534
external_product_id
string

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

Example:
7002111410382
external_variant_id
string

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

Example:
41681852399822
sku
string

The SKU of the item.

Example:
t-shirt-blue-xl
product_title
string

The title of the product.

Example:
T-Shirt
intended_return_quantity
integer

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

Example:
2
variant_title
string or null

The title of the variant.

Example:
Blue - XL
return_reason
string

The return reason provided by the customer.

Example:
Wrong size
return_reason_comment
string

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

Example:
Too Small
return_subreason
string

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

Example:
Too small
ordered_quantity
integer

The purchase quantity of the item in the original order.

Example:
3
refund_quantity
integer

The number of items that need to be refunded.

Example:
2
return_quantity
integer

The number of items that need to be returned.

Example:
2
received_quantity
integer

The number of items that have been received by the merchant.

Example:
0
restocked_quantity
integer

The number of items that have been restocked by the merchant.

Example:
0
removed_quantity
integer

The number of items that have been removed by the merchant.

Example:
0
unit_display_price

The display price of each item.

amount
string

The amount represented with two decimal places.

Example:
99.99
currency
string

The currency code, using ISO 4217 standards.

Example:
USD
unit_discounted_price_including_tax

The tax-inclusive discounted price for each item, representing the actual amount paid by the buyer.

amount
string

The amount represented with two decimal places.

Example:
99.99
currency
string

The currency code, using ISO 4217 standards.

Example:
USD
unit_discount

The discount allocated to each item.

amount
string

The amount represented with two decimal places.

Example:
99.99
currency
string

The currency code, using ISO 4217 standards.

Example:
USD
unit_tax

The tax allocated to each item.

amount
string

The amount represented with two decimal places.

Example:
99.99
currency
string

The currency code, using ISO 4217 standards.

Example:
USD
properties
array[object]

Custom properties filled in by the customer when purchasing the product.

name
string

Custom property name.

Example:
monogram
value
string

Custom property value.

Example:
joe
shopper_uploaded_image_urls
array[string]

The images provided by the customer when submitting a return.

product_image_urls
array[string]

The images of the product.

product_categories
array[string]

The product categories configured on the e-commerce platform.

product_tags
array[string]

The product tags configured on the e-commerce platform.

item_tags
array[ItemTag]

The tags applied by the merchant to this return item.

id
string

The unique identifier for the item tag.

Example:
da1c35a503364bf8bb851ffaa49028c4
name
string

The name of the item tag.

Example:
Defective
created_at
string

The create time of the item-tag.

Example:
2023-07-15T00:00:00Z
merchant_uploaded_image_urls
array[string]

The images uploaded by the merchant for this return item.

bundled_items
array[object]

When the item being returned is a whole bundle, this array will represent its child items.

external_id
string

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

external_product_id
string

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

external_variant_id
string

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

sku
string

The SKU of the item.

product_title
string

The title of the product.

variant_title
string or null

The title of the variant.

unit_display_price

The display price of each item.

unit_discounted_price_including_tax

The tax-inclusive discounted price for each item, representing the actual amount paid by the buyer.

unit_discount

The discount allocated to each item.

unit_tax

The tax allocated to each item.

product_categories
array[string]

The product categories configured on the e-commerce platform.

product_tags
array[string]

The product tags configured on the e-commerce platform.

intended_return_quantity
number

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

return_quantity
number

The number of items that need to be returned.

received_quantity
number

The number of items that have been received by the merchant.

ordered_quantity
number

The purchase quantity of the item in the original order.

exchange_variant
object or null

Exchange variant associated with this return item. Available only when using replacement.

external_product_id
string

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

external_variant_id
string

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

sku
string

The SKU of the item.

product_title
string

The title of the product.

title
string

The title of the variant.

unit_display_price

The display price of each item.

parent_item_id
string or null

When the item being returned is one of the child items in a bundle, this ID will represent its parent item, which is the bundle ID.

Example
preparing...