Home
Tracking
Protection
Parser
Members
Log in to AfterShip
QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Reference
API Overview
Returns
Transit Return Status
Model
Envelope
Meta
Error
Primitive
CostOfReturn
ExchangeVariant
Label
Order
PlatformApp
Price
Resolution
ReturnItem
ReturnMethod
ReturnReason
Resource
Return
Webhook
Webhook Overview
Webhook Signature
Webhook Reference
Webhooks
Receive a webhook delivery of returns update
Support
Contact Support
QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Reference
API Overview
v2
Returns
Transit Return Status
post
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 Reference
Webhooks
Receive a webhook delivery of returns update
post
Support
Contact Support
ReturnItem
Export
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
amount
number
<float>
required
Example:
198.21
currency
string
required
>= 3 characters
<= 3 characters
Example:
USD
image_url
string
<uri>
required
Example:
https://example..com/cool-stuff.jpg
exchange_variant
ExchangeVariant
or
null
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
Example
preparing...