Return status change

wbhk

returnStatusChange

Supported Return Webhooks

All return-related webhooks are closely tied to the status of the return. Each webhook is triggered by a specific status transition, marking important stages in the return process.

Return created (status: status_created)
Return in progress (status: in_progress)
Return en route (status: en_route)
Return returned (status: returned)

Payload Structure (JSON Schema)

The payload of each return-related webhook matches the structure of a single return object as returned by the GET /v1/integrations/returns-list endpoint. While the GET /v1/integrations/returns-list endpoint responds with an array of return objects (returns-list field), each webhook delivers the full data of one return in the same format. This allows for easy reuse of the return model across both API responses and webhook events.

Payload

integer

required

warehouse

string

required

order_key

string | null

required

store_id

integer | null

required

rma

string

required

tracking_number

string | null

required

status

string

enum

required

Allowed:

return_reason

string

enum

required

Allowed:

note

string | null

required

created_at

date-time

required

updated_at

date-time

required

received_at

date-time | null

required

items

array of objects

required

items*

custom_data

array of objects

required

custom_data*

source

string

enum

required

Allowed:

Responses

200

Return a 2xx status to indicate that the data was received successfully

default

For a 4xx status, ShipMonk will retry the webhook delivery up to 100 times, with a 5-minute delay between attempts.

Loading…