Breeze

How to connect your Breeze account: what you need and how to connect.

🚨 Prerequisites

Before you start, make sure you have these four values for the store you want to connect:

• Your Breeze subdomain: the part before .breezepos.net (for example, mycompany for mycompany.breezepos.net)
• The store id of the store
• An API code and an API key for the Breeze API

---

⚡️ Connection

A connection covers one store. To connect several stores, create one connection per store.

1. Name your connection

   Choose a name you will recognise later. If there is no name field, skip this step.

2. Fill in the connection form

   Field	What to enter
   Subdomain	Your Breeze subdomain only, without .breezepos.net. It may contain letters, digits and hyphens.
   Store id	The id of the store to connect
   API code	Your Breeze API code
   API key	Your Breeze API key

3. Click Connect

   The connection is checked against Breeze and created straight away.

---

❓ Troubleshooting

Invalid API key or API code. Please check them and try again.

Breeze refused the API code or the API key.

Check both values for typing errors or extra spaces, then click Connect again.

The store id is invalid or does not exist. Please check it and try again.

Breeze does not recognise the store id for this subdomain.

Check the store id, and check that the subdomain is the one of the account that owns this store.

The subdomain may only contain letters, digits and hyphens

The Subdomain field contains something else, often the full address.

Enter only the part before .breezepos.net: mycompany, not https://mycompany.breezepos.net.