Skip to content

EU Withdrawal Status

Tells you whether the store offers the EU right-of-withdrawal form on the current channel. Check it before showing the withdrawal option on orders.

Endpoint

GET /api/shop/eu-withdrawal-status

Authentication

Public — send the storefront key. No customer token is needed. See the Authentication page.

Response Fields

FieldTypeDescription
idstringChannel code.
channelstringChannel the setting was read for.
enabledbooleantrue when customers can file a withdrawal. The setting is per channel, so read it for the channel the customer is shopping.

Status Codes

StatusMeaning
200 OKThe EU withdrawal setting of the current channel.
401 UnauthorizedMissing or invalid storefront key.

Released under the MIT License.