Skip to content

View EU Withdrawal

About

The euWithdrawal query returns a single EU right-of-withdrawal declaration owned by the authenticated customer. Ownership is resolved through the underlying order. If the declaration does not exist or belongs to a different customer, the query returns a not-found error — a customer can only view their own declarations.

Authentication

This query requires an authenticated customer — send the storefront key and a customer Bearer token. See the Authentication page.

Arguments

ArgumentTypeRequiredDescription
idID!✅ YesThe declaration IRI, e.g. /api/shop/eu-withdrawals/7.

Possible Returns

FieldTypeDescription
_idInt!Numeric declaration ID.
uuidString!Stable public identifier for the declaration.
orderIdInt!Numeric ID of the order the withdrawal applies to.
orderIncrementIdString!Human-readable order number.
isGuestBoolean!Whether the declaration was filed on a guest order.
customerEmailString!Email address tied to the declaration.
statusString!Declaration status: received, declined, refunded.
reasonTextStringThe reason the shopper supplied, or null.
receivedAtDateTimeTimestamp when the declaration was received.
confirmationSentAtDateTimeTimestamp when the confirmation email was sent, or null.
declinedAtDateTimeTimestamp when the withdrawal was declined, or null.
declinedReasonStringReason the store declined the withdrawal, or null.
refundedAtDateTimeTimestamp when the order was refunded, or null.
refundNoteStringNote attached to the refund, or null.
createdAtDateTime!Declaration creation timestamp.
updatedAtDateTime!Declaration last update timestamp.

Released under the MIT License.