Skip to content

Get EU Withdrawal

GraphQL counterpart of GET /api/admin/eu-withdrawals/{id}. Returns a single withdrawal declaration with its full evidence timeline. Runs against the admin GraphQL endpoint POST /api/admin/graphql.

Operation

adminEuWithdrawal(id:) — an item query. Pass the declaration IRI (/api/admin/eu-withdrawals/{id}) as id, and select _id for the numeric id.

Permission

sales.eu_withdrawals

Fields

FieldDescription
_idDeclaration id.
uuidStable public identifier for the declaration.
orderId / orderIncrementIdThe order the declaration was filed against.
customerId / customerName / customerEmailWho filed the declaration.
isGuesttrue when filed by a guest (no customer account).
channelId / channelCodeThe channel the order was placed in.
localeThe locale the declaration was filed in (used for the confirmation email).
reasonTextThe customer's free-text reason for withdrawing.
statusreceived, declined, or refunded.
receivedAtWhen the declaration was received.
confirmationSentAtWhen the durable-medium confirmation email was sent.
finalConfirmationSentAtWhen a later confirmation was re-sent (if any).
confirmationErrorThe reason the confirmation email failed to send (if any).
declinedAt / declinedReason / declinedByUserId / declinedByNameDecline outcome details (populated only when declined).
refundedAt / refundedByUserId / refundedByName / refundNoteRefund outcome details (populated only when refunded).
createdAt / updatedAtRecord timestamps.

Released under the MIT License.