Shopware

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Experimental (how to enable).
  • Authentication: OAuth 2.0 (client credentials).
  • Connection: Veryfront obtains machine-to-machine tokens from the client ID and secret in the project's environment variables.
  • Provider documentation: Authentication reference.

Credentials

Set these per environment. See Connect an integration.

VariableRequiredDescription
SHOPWARE_CLIENT_IDYesAccess key ID of the integration (Admin > Settings > System > Integrations) Docs.
SHOPWARE_CLIENT_SECRETYesSecret access key of the integration (shown once at creation) Docs.
SHOPWARE_SHOP_DOMAINYesBare hostname of your Shopware shop without protocol, e.g. my-shop.example.com (the token endpoint and all tools live on this host)

Setup

  1. Get a Shopware 6 shop: Use an existing Shopware 6 instance, start a free Shopware cloud trial at https://www.shopware.com, or run a local instance (e.g. via Docker/devenv) for testing. Note the shop hostname and set it as SHOPWARE_SHOP_DOMAIN.
  2. Create an integration: In the shop administration go to Settings > System > Integrations and click Add integration. Give it a name and (if write tools are needed) enable write access / an appropriate role.
  3. Save the access keys: Copy the Access key ID as SHOPWARE_CLIENT_ID and the Secret access key as SHOPWARE_CLIENT_SECRET. The secret is shown only once.
  4. Verify access: Tokens are issued from https://<your-shop-domain>/api/oauth/token via the client_credentials grant (access tokens expire after 600 seconds (10 minutes) and are refreshed automatically). Run Search Products to confirm the integration works.

Provider notes

  • Integration credentials come from Admin > Settings > System > Integrations - not from a central Shopware portal
  • The OAuth token endpoint is per-shop and resolved from the SHOPWARE_SHOP_DOMAIN env var (https://<SHOPWARE_SHOP_DOMAIN>/api/oauth/token), so each shop issues its own tokens
  • Admin API search endpoints are POST requests with a criteria body; entity responses are wrapped in a data key
  • Order state transitions are constrained by the state machine - only transitions valid from the current state succeed

Provider API reference.

Tools

ToolAccessDescription
Search Products<br /><code className="reference-identifier">shopware__search_products</code>ReadSearch products
Search Orders<br /><code className="reference-identifier">shopware__search_orders</code>ReadSearch orders
Search Customers<br /><code className="reference-identifier">shopware__search_customers</code>ReadSearch customers
Get Order<br /><code className="reference-identifier">shopware__get_order</code>ReadGet order
Get Product<br /><code className="reference-identifier">shopware__get_product</code>ReadGet product
Create Product<br /><code className="reference-identifier">shopware__create_product</code>WriteCreate product
Update Product<br /><code className="reference-identifier">shopware__update_product</code>WriteUpdate product
Transition Order State<br /><code className="reference-identifier">shopware__transition_order_state</code>WriteTransition order state

Verify the connection

Call a read tool such as shopware__search_products with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.