EU Withdrawal

File an EU right-of-withdrawal declaration (guest)

Changed on

Step 2 of a guest withdrawal. Send the signed link emailed by POST /api/shop/eu-withdrawals/guest/lookup; it proves the guest owns the order email, as on the storefront. The link is valid for 24 hours. Idempotent: sending the same link again returns the existing declaration with its current status. Triggers the durable-medium confirmation email. Limited to 20 requests a minute per IP.

post/eu-withdrawals/guest

Request

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring
Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring
Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring
Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Request body

linkstring required
reason_textstring

Example request

{
  "link": "https://shop.example.com/withdraw/34/create?expires=1784539800&signature=3f1c…",
  "reason_text": "Changed my mind."
}

Response

The created (or existing, idempotent) guest withdrawal declaration.

Changes

    • breaking

      added the new required request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status