Get the storefront settings of the current channel
Changed onReturns the store settings a storefront needs before it renders a page: checkout and minimum order rules, the order number format and order creation retries, review rules, product listing and product page options, header and footer content, custom CSS and JavaScript, speculation rules, rich snippets, customer account, login and address rules, tax display and calculation, store information, privacy and cookie consent, returns and optional features. Secrets such as API keys, client secrets and mail credentials are never returned. Only non-secret values are returned. Send X-Channel or X-Locale to read another channel or language. Public endpoint — the storefront key is enough.
Request
- Base URLhttp://localhost:8000/api/shop
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Channel code to read. Defaults to the channel of the request host.
Locale code to read. Must be a locale of the channel.
Storefront API Key for authentication. Required for all shop/storefront API requests.
Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.
Response
The storefront settings.
Changes
- info
endpoint added
- info