QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Reference
API Overview
v2
Returns
Update Return Status
post
Update Return Status By RMA
post
Update return items
patch
Batch mark items as received
post
Update return items By RMA
patch
Merchant Tags
List Merchant Tags
get
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 Outgoing IPs
Webhook Reference
Webhooks
Receive a webhook delivery of returns update
post
Support
Contact Support

Receive a webhook delivery of returns update

post
/your-webhook-receiver-endpoint

Notice: This endpoint is the specification of how you shall implement your webhook handler for AfterShip Returns, in case you want to receive updates and sync them into your own system.

Please note that you can define URLs freely. events/sapmples/returns is just an example. We accept all the URLs that are HTTPS protected. You can register your own base URL upon registration.

Request

Headers

as-signature-hmac-sha256
string

Webhook signature

Example:
QbuJUExfJz0NnRHlwRzX1UU2gZK+v3urueXYK67tdlA=

Body

id
string

UUID without dashes in between

event
string
Allowed values:
return.createdreturn.updatedreturn.dropoff.createdreturn.dropoff.updatedreturn.shipment.updatedreturn.dropoff.shipment.updated
version
string
Example:
2022-02-22
created_at
string<date-time>

ISO8601 format

data
Return

Return object model

id
string
required

UUID without dashes in between

rma_number
string
required

Short id for return. It will be unique most of the time within a single store. It's for store customers to identify their returns.

Example:
EUGCX4FL
status
string
required

RMA status mainly refelected the approval status of a return, NOT for logistics status of shipments of return items.Show all...

Allowed values:
submittedapprovedshippedreceivedrejecteddoneexpired
internal_notes
string
required
Example:
Please call him to confirm before sending the refund.
order
Order
required
return_items
array[ReturnItem]
required
resolution
Resolution
required

Types of resolutions:Show all...

return_method
ReturnMethod
required
created_at
string<date-time>

The moment when a customer successfully submits a return request.

updated_at
string<date-time>
tracking_number
string
required

The tracking number of the return shipment provided by the customer / merchant.

reject_reason
string
required
shipments
array[object]
dropoffs
array[object]
exchange_order
object
Parameters
:
Body
preparing...