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 hanlder for Returns Center, in case you want to receive updates and sync into your own system.

Note that you can define URL freely. events/sapmples/returns is just an example. We accept any URL as long as it is via HTTPS. You shall register your own base URL upon registration.

Request

Headers

am-webhook-signature

string

Webhook signature

Example:

hmac-sha256=QbuJUExfJz0NnRHlwRzX1UU2gZK+v3urueXYK67tdlA=

Body

string

UUID without dashes in between

event

string

Allowed values:

return.createdreturn.updated

version

string

Example:

2022-02-22

created_at

string<date-time>

ISO8601 format

data

Return

Return object model

string

required

UUID without dashes in between

rma_number

string

required

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

Example:

EUGCX4FL

status

string

required

Allowed values:

submittedapprovedshippedreceivedrejecteddone

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

return_method

ReturnMethod

required

created_at

string<date-time>

The moment when a customer succesfully submit a return request.

updated_at

string<date-time>

tracking_number

string

required

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

reject_reason

string

required

Parameters

Body

preparing...