EU Withdrawal

Request a guest withdrawal link

Changed on

Step 1 of a guest withdrawal. When the order number and email match a guest order on an EU-enabled channel, a signed link valid for 24 hours is emailed to that address. Pass that link to POST /api/shop/eu-withdrawals/guest to file the withdrawal. The response is the same whether or not the order matched, so it cannot be used to discover orders. Limited to 5 requests a minute per IP.

post/eu-withdrawals/guest/lookup

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

order_increment_idstring required
emailstring required

Example request

{
  "order_increment_id": "1000123",
  "email": "guest@example.com"
}

Response

Accepted. The same answer is returned whether or not the order matched.

Changes