Onboarding wizard

The onboarding wizard connects a Shopware shop to plinth. It takes you through the steps in order: connect, keys, sales channel, sign-in plugin and first import. After that it shows the optional setup steps, such as the AI key and the text style. This page also explains the page Shops, where shops and companies are managed.

Where to find it

• Help and administration > Shops, or click the shop name at the top left and choose Manage shops.
• Open a shop. At the top you see the section Set up this shop. Click Open the wizard, or Continue setup if steps are still open.
• The wizard page is titled Set up this shop followed by the shop name. Under the title you see the Shopware URL and, for a read-only shop, the word Read-only.

What you need

• The permission Manage shops. It applies to the whole installation, not to one shop.
• The shop must exist in plinth with its Shopware URL. If not, create it first (see below).
• One of these to connect:
  • a Shopware admin user name and password, or
  • the access key ID and secret access key of an integration in Shopware (Settings, System, Integrations).

How do I create a shop?

1. Open Help and administration > Shops and click New shop.
2. Fill in the section Basics: Name, Slug (URL) (the short name in the address), the Company (choose one, or type a name under or new company) and the Shopware URL. The other fields can stay as they are.
3. Decide whether the shop is Read-only (see below).
4. In the section Modules, switch on the areas the shop should have. No selection means all generic modules.
5. Click Save. The shop page now shows the section Set up this shop.

What is the difference between a read-only and a writable shop?

• A writable shop: plinth can change products, prices and pages in Shopware. The wizard creates the integration with administrator rights.
• A Read-only shop: plinth only reads. Shopware requests other than reads and searches are refused, and jobs that could write fail. The wizard creates the integration with a read-only role. Creating the integration is the only change the wizard makes in Shopware.

In a read-only shop the top bar shows the pill Read-only. You switch this in the shop's Basics.

How do I connect a shop with a Shopware login?

This is the simplest way. You do not have to copy any keys.

1. Open the wizard and go to step 1. Connect.
2. Under Option A: Shopware admin login, enter the Shopware admin user name and the Shopware admin password.
3. Click Sign in and create the keys.
4. plinth signs in once, creates its own integration called plinth in Shopware and stores the keys encrypted. The login is used for this one request and never stored.
5. Steps 1 and 2 are now marked done. Step 2. Keys is not needed in this case.

Note: If keys are already stored, tick Replace the stored keys to create a new integration. The old integration stays in Shopware; delete it there if nobody uses it.

How do I connect a shop with API keys?

Use this when you cannot give a login. You need an integration in Shopware and its two values.

1. In Shopware, open Settings, System, Integrations and create an integration, or open an existing one. Copy the access key ID and the secret access key. Shopware shows the secret only once, when the integration is created.
2. Optional: in step 1. Connect under Option B: existing Admin API token, paste a current token and click Test the token. plinth only tests it (Shopware version and rights) and does not keep it.
3. Go to step 2. Keys.
4. Enter the Access key ID. It starts with SWIA.
5. Enter the Secret access key.
6. Click Check and store the keys. plinth checks both values with a real request before it stores them. They are stored encrypted and never shown again.

Note: The shop page also has a section Credentials for manual entry. Normally you do not type anything there. If you must, add two entries with exactly these names in lowercase: shopware/client_id with the access key ID, and shopware/client_secret with the secret access key.

How do I go through the remaining steps?

1. 3. Sales channel: pick the Storefront sales channel that quality checks and product tools should use, then click Use this sales channel. If the shop has only one, it is preselected. If none of the shop's modules needs a sales channel, the step shows not needed.
2. 4. Sign-in plugin: optional. The plugin lets people open plinth straight from the Shopware administration. plinth does not install plugins in a shop; installing and configuring it is manual. Follow the three instructions on the page, then click Check the plugin.
3. 5. First import: click Start first import. See the next section.
4. 6. AI: optional. Enter the company's API key and click Save key, then Test key. See AI settings.
5. 7. Text style: optional. The text style steers every AI text of the products. Open takes you to the setting. See Products.
6. 8. Brand SKU codes: optional. Click Show brands without SKU code. See Brands.
7. 9. Merchant Center and feeds: optional. Open takes you to the connection. See Feeds.

The list on the left shows every step with a tick when it is done. Each step also shows its state: done, open, not needed, skipped or check.

How do I start the first import?

1. Connect the shop first (steps 1 and 2). Without keys the button is disabled.
2. In step 5. First import click Start first import.
3. The page lists the jobs with their state: not started, waiting, running, done, failed or not needed.
4. Click Refresh status to update the list, or Open the Jobs page to follow the progress there.

The import loads the shop data in a sensible order: the quality sync and the scans come first. The statistics load last, in the background, because they take the longest (the last 13 months and the orders). You can already work while they load. Starting the import twice does no harm: a job that is already waiting or running is not queued again.

How do I skip an optional step?

The steps sign-in plugin, AI, text style, brand SKU codes and feeds are optional.

1. In the step, open Skip.
2. Enter a Reason, for example "we do not use AI".
3. Click Skip. The step is shown as skipped with the reason, your name and the date.
4. To take it back, click Open again.

A skipped step stays open and can be done at any time. Connect, keys, sales channel and first import cannot be skipped.

What does the wizard show at the end?

After the first import, steps 6 to 9 show the setup places of the areas with their state and one line of detail, for example Key ..., tested on ... or No text style yet. People who may change a place see the button Open. Everyone else sees the state only. When nothing is open any more, the shop page shows All steps are done.

The same places are listed for everyone under Help and administration > Setup. See Setup.

How do I manage shops and companies?

1. Open Help and administration > Shops. The list shows all connected shops with Name, Company, Shopware URL, Modules and Status. Click a line to open a shop.
2. On the shop page:
   • Test connection checks whether the shop can be reached with the stored credentials. It changes nothing.
   • Basics: name, address and behaviour of the shop, including Read-only and Disable shop. A disabled shop cannot be opened by anybody; data and credentials are kept.
   • Modules: which areas the shop has.
   • Credentials: stored encrypted and never shown again.
   • White-label: Product name, Accent color, Custom domain and Logo of the company. Click Save whitelabel. This applies to every shop of the company.
3. The section Companies at the bottom of the list shows each company with its product name and domain.

Common errors and fixes

See also

• Setup
• Jobs
• Access
• AI settings
• Getting started