Shopware offers a holistic omnichannel digital commerce platform for sophisticated mid-market and lower enterprise merchants, with high flexibility and various options for B2C, D2C, B2B, as well as service-based use cases.

This app enables content editors to select products and categories from a connected Shopware instance and reference them in Storyblok.

Setup

If your Shopware instance uses the Shopware API v3, follow these steps:

1. Once installed, navigate to the block library and create a new field of the type plugin (in either a new or an existing block). Set the custom type to sb-shopware-64.
2. In the field configuration, define the following values:
   • endpoint (required): The API URL of the Shopware instance (for example, https://my-demo.store.shopware.store).
   • salesChannelKey (required): The generated Shopware access key. Learn more in the Shopware documentation.
   • limit (optional): The maximum number of items that can be selected.
   • selectOnly (optional): If left empty, editors can choose products and categories. If set to product, only products can be selected. If set to category, only categories can be selected.
3. Use the block containing the field in the Visual Editor, select one or multiple products or categories, save the story, and check the API response.

Otherwise, follow these steps:

1. Once installed, navigate to the block library and create a new field of the type plugin (in either a new or an existing block). Set the custom type to sb-shopware.

2. In the field configuration, define the following values:

   • endpoint (required): The API URL of the Shopware instance (for example, https://my-demo.store.shopware.store).
   • salesChannelKey (required): The generated Shopware access key. Learn more in the Shopware documentation.
   • accessKey (required): The access key ID.
   • secretAccessKey (required): The secret access key.

   Security note: accessKey and secretAccessKey are Admin API credentials with full read/write access, and they are used from the browser. Where possible, prefer the Store API path above (sb-shopware-64 with a salesChannelKey), which uses a client-safe, read-only Storefront key.

   • limit (optional): The maximum number of items that can be selected.
   • selectOnly (optional): If left empty, editors can choose products and categories. If set to product, only products can be selected. If set to category, only categories can be selected.

3. Use the block containing the field in the Visual Editor, select one or multiple products or categories, save the story, and check the API response.

Refer to the e-commerce concept for a detailed introduction to the topic.