Skip to content

List EU Withdrawals

GraphQL counterpart of GET /api/admin/eu-withdrawals. Returns a cursor-paginated list of every right-of-withdrawal declaration — the same rows shown on the admin Sales → EU Withdrawal datagrid. Runs against the admin GraphQL endpoint POST /api/admin/graphql.

Operation

adminEuWithdrawals(first, after, order_increment_id, customer_email, status, channel_code, received_at_from, received_at_to, confirmation_sent_at_from, confirmation_sent_at_to, sort, order) — a cursor QueryCollection.

Arguments

ArgumentTypeDescription
first, afterInt / StringCursor pagination.
order_increment_idStringPartial match on the order increment id.
customer_emailStringPartial match on the customer email.
statusStringreceived, refunded, or declined.
channel_codeStringFilter by channel code.
received_at_from / received_at_toStringReceived-date range.
confirmation_sent_at_from / confirmation_sent_at_toStringConfirmation-email-sent range.
sortStringid (default), received_at, status.
orderStringasc, desc (default desc).

Permission

sales.eu_withdrawals

Fields

Select _id for the numeric declaration id (id is the resource IRI). Every column of the declaration is populated on each row — the customer and order context, the evidence timeline (receivedAt, confirmationSentAt, finalConfirmationSentAt, confirmationError), and both outcome blocks (declined* and refunded*, whichever applies). To read one declaration on its own, fetch it by id with adminEuWithdrawal(id:).

Released under the MIT License.