QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Reference
API Overview
Returns
Get return detail by ID
get
Get return detail by RMA number
get
Get returns
get
Return Dropoffs
Record dropped-off return items
post
Model
Envelope
Error
Resource
Return
Webhook
Webhook Overview
Webhook Outgoing IPs
Webhook Signature
Webhooks
Receive a webhook delivery of returns update
post
Support
Contact Support

Receive a webhook delivery of returns update

post
/your-webhook-receiver-endpoint

Request

Body

id
string
Example:
3df04d0cdf3c492fad33a15f753fb960
version
string
Example:
2024-07
event
string
Example:
return.restock.created
created_at
string<date-time>
Example:
2024-06-25T06:35:21.798Z
data
Return
id
string
Example:
b3eedf69b7c0410d8975d4350c007705
rma_number
string
Example:
A1B2C3D4
filed_by
Allowed values:
shoppermerchantcustomer_support
approval_status
Allowed values:
submittedapproveddonerejectedexpired
merchant_note
string
Example:
This is an internal note
order
object
gift_return
GiftReturn
return_items
array[ReturnItem]
refunded_total
Money
shipments
array[ReturnShipment]
restocks
array[object]
created_at
string
Example:
2024-01-01T00:00:00.001Z
modified
return.restock.created
Example:
{"restocks":[{"items":[{"source_order_item_id":"13892318167283","quantity":1,"location":{"source_id":"75333206259","name":"My Custom Location"}}]}]}
restocks
array[object]
Body
preparing...