Skip to content

View EU Withdrawal

Retrieve a single EU right-of-withdrawal declaration owned by the authenticated customer. Ownership is resolved through the underlying order. If the declaration does not exist or belongs to a different customer, the endpoint returns HTTP 404 — a customer can only view their own declarations.

Endpoint

GET /api/shop/eu-withdrawals/{id}

Authentication

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

Request Headers

HeaderRequiredDescription
Content-TypeYesapplication/json
X-STOREFRONT-KEYYesYour storefront API key
AuthorizationYesBearer token (customer login required)

Path Parameters

ParameterTypeRequiredDescription
idintegerYesThe declaration ID.

Response Fields (200 OK)

FieldTypeDescription
idintegerDeclaration ID.
uuidstringStable public identifier for the declaration.
orderIdintegerNumeric ID of the order the withdrawal applies to.
orderIncrementIdstringHuman-readable order number.
isGuestbooleanWhether the declaration was filed on a guest order.
customerEmailstringEmail address tied to the declaration.
statusstringDeclaration status: received, declined, refunded.
reasonTextstringThe reason the shopper supplied, or null.
receivedAtstringISO 8601 timestamp when the declaration was received.
confirmationSentAtstringISO 8601 timestamp when the confirmation email was sent, or null.
declinedAtstringISO 8601 timestamp when the withdrawal was declined, or null.
declinedReasonstringReason the store declined the withdrawal, or null.
refundedAtstringISO 8601 timestamp when the order was refunded, or null.
refundNotestringNote attached to the refund, or null.
createdAtstringISO 8601 creation timestamp.
updatedAtstringISO 8601 last update timestamp.

Status Codes

StatusMeaning
200 OKDeclaration returned.
401 UnauthorizedMissing or invalid customer Bearer token.
403 ForbiddenMissing or invalid storefront key.
404 Not FoundThe declaration does not exist or is not owned by the customer.

Released under the MIT License.