Withdrawal

The withdrawal object, present on the Withdrawal Request email (EU right-of-withdrawal). The email also receives the usual order (Order) and settings.

Fields

Field Type Notes
confirmationNumber string e.g. WD-20260609-AB12CD34.
customerName string
requestedAt datetime
isPartial boolean True when only some items are withdrawn.
isOutsideWithdrawalPeriod boolean
refundAmount number
resolution string Pending, Accepted, Refused.
resolvedAt datetime Optional.
items WithdrawalItem[] The items requested for withdrawal (below).

WithdrawalItem (withdrawal.items[])

Field Type
itemUniqueId guid
itemName string
quantity number
unitPrice number
totalPrice number

Was this article helpful?