storefrontApi - Storefront API - WEBSALE Dokumentation

The storefrontApi node bundles the configuration options for the storefront API.

`storefrontApi*` - Basic structure

The basic structure of the storefrontApi node is shown below:

{
  "storefrontApi": {
    "redirects": {},
    "catalogApiSettings": {}
  }
}

Parameter description

Parameter	Description
`redirects`	Defines template redirects (`identifier` → target template).
`catalogApiSettings`	Controls the catalogue endpoints of the storefront API and the fields that can be delivered through them.

`storefrontApi.redirects` - Template redirect

The storefrontApi.redirects node defines which name (identifier) points to which template in the shop.

Example configuration

{
  "identifier": "checkout",
  "targetTemplateName": "checkout.htm",
  "parameters": {
    "step": "1"
  }
}

Parameter description

Parameter	Type	Description
`identifier`	string	Free name of the redirect; used as `viewIdentifier` in the API call. More about this: Storefront API session handling
`targetTemplateName`	string	Path / name of the target template file (e.g. `checkout.htm`).
`parameters`	object	Optional values that are appended to the generated link as query parameters. In the template, they are available like all URL parameters, for example via `$wsViews.current.paramList`. Through this, a multi-step target page receives its entry step.

With the example configuration above, session/prepareRedirect returns a link of the form:

https://your-shop.de/checkout?step=1&sessionKey=...

The values in parameters are fixed in the configuration and identical for every call. Values that differ per call are instead passed in the request body of session/prepareRedirect — those land in the session, not in the URL.

`storefrontApi.catalogApiSettings` - Control of the catalogue endpoints

The storefrontApi.catalogApiSettings node controls which catalogue endpoints are available in the storefront API and which fields may be returned via them.

Example configuration

{
  "categoryFieldWhitelist": null,
  "enableCategoryDataEndpoint": true,
  "enableCategoryWhitelist": false,
  "enableProductDataEndpoint": true,
  "enableProductWhitelist": false,
  "productFieldWhitelist": null
}

Parameter description

Parameter	Type	Description
`enableProductDataEndpoint`	bool	Enables / disables the product endpoint of the storefront API.
`enableCategoryDataEndpoint`	bool	Enables / disables the category endpoint of the storefront API.
`enableProductWhitelist`	bool	Activates an allowlist for product fields that may be returned. If `true`, only fields from `productFieldWhitelist` are returned. Default: `false`
`enableCategoryWhitelist`	bool	Activates an allowlist for category fields that may be returned. If `true`, only fields from `categoryFieldWhitelist` are returned. Default: `false`
`productFieldWhitelist`	multiAssoc	List of allowed product fields from `content.productField` and / or `content.customProductField`. Only takes effect if `enableProductWhitelist = true`.
`categoryFieldWhitelist`	multiAssoc	List of allowed category fields from `content.categoryField` and / or `content.customCategoryField`. Only takes effect if `enableCategoryWhitelist = true`.

​storefrontApi* - Basic structure

​Parameter description

​storefrontApi.redirects - Template redirect

​Example configuration

​storefrontApi.catalogApiSettings - Control of the catalogue endpoints

​Example configuration

​Parameter description

`storefrontApi*` - Basic structure

Parameter description

`storefrontApi.redirects` - Template redirect

Example configuration

`storefrontApi.catalogApiSettings` - Control of the catalogue endpoints

Example configuration

Parameter description