List EU Withdrawals
Retrieve a list of the authenticated customer's own EU right-of-withdrawal declarations. Declarations are always scoped to the logged-in customer — a customer can never see another customer's declarations. Results are ordered newest first.
Endpoint
GET /api/shop/eu-withdrawalsAuthentication
This endpoint requires an authenticated customer — send the storefront key and a customer Bearer token. See the Authentication page.
Request Headers
| Header | Required | Description |
|---|---|---|
Content-Type | Yes | application/json |
X-STOREFRONT-KEY | Yes | Your storefront API key |
Authorization | Yes | Bearer token (customer login required) |
Response Fields (200 OK)
The response is a plain JSON array. Each item is a withdrawal declaration object.
| Field | Type | Description |
|---|---|---|
id | integer | Declaration ID. |
uuid | string | Stable public identifier for the declaration. |
orderId | integer | Numeric ID of the order the withdrawal applies to. |
orderIncrementId | string | Human-readable order number. |
isGuest | boolean | Whether the declaration was filed on a guest order. |
customerEmail | string | Email address tied to the declaration. |
status | string | Declaration status: received, declined, refunded. |
reasonText | string | The reason the shopper supplied, or null. |
receivedAt | string | ISO 8601 timestamp when the declaration was received. |
confirmationSentAt | string | ISO 8601 timestamp when the confirmation email was sent, or null. |
declinedAt | string | ISO 8601 timestamp when the withdrawal was declined, or null. |
declinedReason | string | Reason the store declined the withdrawal, or null. |
refundedAt | string | ISO 8601 timestamp when the order was refunded, or null. |
refundNote | string | Note attached to the refund, or null. |
createdAt | string | ISO 8601 creation timestamp. |
updatedAt | string | ISO 8601 last update timestamp. |
Empty Collection
When the customer has no declarations, the response is an empty array:
json
[]Status Codes
| Status | Meaning |
|---|---|
200 OK | Declarations returned. |
401 Unauthorized | Missing or invalid customer Bearer token. |
403 Forbidden | Missing or invalid storefront key. |