Skip to content

File a Guest EU Withdrawal

About

The createGuestEuWithdrawal mutation records an EU right-of-withdrawal declaration for a guest order. Ownership is proved by supplying the order increment id together with the email used on the order. The declaration is created with status received and the durable-medium confirmation email is sent.

Filing is idempotent — a second call for the same order returns the existing declaration instead of creating a duplicate.

Authentication

This mutation requires only the storefront key — no customer token. See the Authentication page.

Input Fields

FieldTypeRequiredDescription
orderIncrementIdString!✅ YesThe human-readable order number of the guest order.
emailString!✅ YesThe email address used on the guest order.
reasonTextString❌ NoAn optional reason for withdrawing.

Possible Returns

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

Released under the MIT License.