Skip to content

List EU Withdrawals

About

The euWithdrawals query returns a paginated list of the authenticated customer's own EU right-of-withdrawal declarations. Declarations are always scoped to the logged-in customer — you can never see another customer's declarations. Results are ordered newest first.

Authentication

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

Arguments

ArgumentTypeRequiredDescription
firstInt❌ NoNumber of items to return (forward pagination).
afterString❌ NoCursor for forward pagination. Use endCursor from a previous response.

Possible Returns

FieldTypeDescription
edges[EuWithdrawalEdge!]Array of declaration edges with cursor and node.
edges.cursorString!Cursor for this edge, used in pagination.
edges.nodeEuWithdrawal!The withdrawal declaration object.
edges.node._idInt!Numeric declaration ID.
edges.node.uuidString!Stable public identifier for the declaration.
edges.node.orderIdInt!Numeric ID of the order the withdrawal applies to.
edges.node.orderIncrementIdString!Human-readable order number.
edges.node.isGuestBoolean!Whether the declaration was filed on a guest order.
edges.node.customerEmailString!Email address tied to the declaration.
edges.node.statusString!Declaration status: received, declined, refunded.
edges.node.reasonTextStringThe reason the shopper supplied, or null.
edges.node.receivedAtDateTimeTimestamp when the declaration was received.
edges.node.confirmationSentAtDateTimeTimestamp when the confirmation email was sent, or null.
edges.node.declinedAtDateTimeTimestamp when the withdrawal was declined, or null.
edges.node.declinedReasonStringReason the store declined the withdrawal, or null.
edges.node.refundedAtDateTimeTimestamp when the order was refunded, or null.
edges.node.refundNoteStringNote attached to the refund, or null.
edges.node.createdAtDateTime!Declaration creation timestamp.
edges.node.updatedAtDateTime!Declaration last update timestamp.
pageInfoPageInfo!Pagination metadata.
pageInfo.startCursorStringCursor for the first item in the page.
pageInfo.endCursorStringCursor for the last item in the page.
pageInfo.hasNextPageBoolean!Whether more pages exist forward.
pageInfo.hasPreviousPageBoolean!Whether more pages exist backward.
totalCountInt!Total number of the customer's declarations.

Released under the MIT License.