QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Reference
API Overview
v2
Returns
Update Return Status By RMA
post
Batch mark items as received
post
Update return items By RMA
patch
Batch attach shipments to an RMA
post
Merchant Tags
List Return Item Tags
get
Model
Envelope
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

ReturnItem

external_id
string
required
external_product_id
string
required
title
string
required
sku
string
required
ordered_quantity
integer
required
return_quantity
integer
required
price
Price
required

(Deprecated) The field was still maintained only for some legacy customers. Please do not depend on this value. For price, discount, tax, and other order data, please directly connect to order data source. AfterShip Returns does not own and maintain order data, but only returns data.

amount
number<float>
required
Example:
198.21
currency
string
required
>= 3 characters<= 3 characters
Example:
USD
image_url
string<uri>
required

(Deprecated) The field was still maintained only for some legacy customers. Please do not depend on this value. For product data, please directly connect to product data source. AfterShip Returns does not own and maintain product data, but only returns data.

Example:
https://example..com/cool-stuff.jpg
exchange_variant
ExchangeVariant or null
external_product_id
string
external_id
string<integer>
required
title
string
required
return_reason
ReturnReason
description
string
required
Example:
Doesn't fit me
additional_notes
string or null
required
<= 5000 characters
Example:
Too big too heavy
subreason
string
Example:
cover is broken
merchant_tags
array[object]
id
string

Merchant tags you want to add this return item. You can manage tags in AfterShip Returns Admin.

Example:
7f202ac1-575e-4807-b8af-3df51e5fe6f5
name
string

The name of the tag.

bundled_items
array[object]

If current item is a bundle, this field includes its inner items.

parent_bundle_external_id
string
external_id
string
sku
string
return_quantity
number
last_received_at
string<date-time> or null

The moment when the item was marked as received last time.

received_quantity
integer
last_received_at
string<date-time> or null

The moment when the item was marked as received last time.

received_quantity
number
return_images
array[object]

Item image uploaded with its return reason.

id
string
url
string

Download URL of image

Example
preparing...