Return request events

Every event has the common fields and a data object, the snapshot of the entity at the moment of the event. This page lists what data holds, for the version 2026-01 of the format.

Events

Event	When
return-request.created	A return request is created.
return-request.deleted	A return request is deleted.
return-request.guest-verify-requested	A guest asks for the link to make a return request (Webround emails it).
return-request.updated	A return request is updated.

Payloads

Payload of return-request.created

Field	Type	Notes
data.id	string
data.storeId	string
data.orderId	string
data.customerId	string
data.status	string
data.items	object[]
data.items[].orderItemId	string
data.items[].quantity	integer
data.items[].variantId	string
data.items[].variantName	string
data.items[].coverUrl	string	can be null
data.items[].skuCode	string	can be null
data.items[].unitNet	string
data.items[].unitGross	string
data.items[].unitTax	string
data.items[].totalNet	string
data.items[].totalGross	string
data.items[].totalTax	string
data.items[].appliedTaxRate	integer
data.items[].taxBehavior	string
data.reason	string	can be null
data.shippingAddress	any
data.billingAddress	any
data.customerEmail	string
data.submittedAt	datetime
data.merchantNote	string	can be null
data.createdAt	datetime
data.updatedAt	datetime

Payload of return-request.deleted

Field	Type	Notes
data.id	string
data.orderId	string

Payload of return-request.guest-verify-requested

Field	Type	Notes
data.storeId	string
data.orderId	string
data.customerEmail	string
data.signedUrl	string

Payload of return-request.updated

Field	Type	Notes
data.id	string
data.storeId	string
data.orderId	string
data.customerId	string
data.status	string
data.items	object[]
data.items[].orderItemId	string
data.items[].quantity	integer
data.items[].variantId	string
data.items[].variantName	string
data.items[].coverUrl	string	can be null
data.items[].skuCode	string	can be null
data.items[].unitNet	string
data.items[].unitGross	string
data.items[].unitTax	string
data.items[].totalNet	string
data.items[].totalGross	string
data.items[].totalTax	string
data.items[].appliedTaxRate	integer
data.items[].taxBehavior	string
data.reason	string	can be null
data.shippingAddress	any
data.billingAddress	any
data.customerEmail	string
data.submittedAt	datetime
data.merchantNote	string	can be null
data.processedAt	datetime	can be null
data.updatedAt	datetime