BAbagisto
EU Withdrawal

File an EU right-of-withdrawal declaration (authenticated customer)

Records a withdrawal for one of the customer's own orders and triggers the durable-medium confirmation email. Idempotent — a second call for the same order returns the existing declaration. 404 if the order is not the customer's or the channel does not have EU withdrawal enabled.

post/eu-withdrawals

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_idinteger required
reason_textstring

Example request

{
  "order_id": 12,
  "reason_text": "Changed my mind."
}

Response

The created (or existing, idempotent) withdrawal declaration.

Changes

No recorded changes to this operation across all 13 revisions of this API.