🟦
Square POS Integration Guide
Step-by-step setup — create a Square developer app and connect it to invyra
Prerequisites: A Square account (any plan) and access to developer.squareup.com.
1
Create a Square Developer App
You need to create an application in the Square Developer Console. This generates the API credentials invyra needs.
- 1Go to the Square Developer Console Open developer.squareup.com/apps and sign in with your Square account (use the same account you use for your POS).
- 2Create a New Application Click the Create Application button (top-right). Name it something like "invyra sync" and click Create.
- 3Open Your Application Click on the app you just created to open its settings.
- 4Navigate to the Credentials Page In the left sidebar, click Credentials (or API Keys in older versions).
- 5Copy Your Application ID Under Application ID, click the copy icon. This is your Application ID — you'll paste it into invyra.
- 6Generate Your Access Token Under Personal Access Token (Production section), click Generate or Reveal Token. Copy the token that starts with EAAAE (Production) or EAAA (Sandbox).
Production vs Sandbox
| Type | Token Prefix | Use Case |
|---|---|---|
| Production | EAAAE... | Real store, real data |
| Sandbox | EAAA... | Test data, no real charges |
Toggle between Production and Sandbox at the top of the Credentials page to generate each.
Security: Your Personal Access Token grants full API access to your Square account. Store it securely (like a password). Never share it or commit it to code.
2
Get Your Square Location ID(s)
Location IDs identify your physical stores or business locations. invyra needs this to sync inventory to the right place.
- 1Log in to your Square Dashboard.
- 2Go to Settings → Business → Locations.
- 3You'll see a list of your locations (e.g., "Main Street Store", "Warehouse").
- 4Click a location name. The URL will contain the Location ID:
squareup.com/dashboard/locations/L3EYT32QB1NZC. - 5Alternatively, once connected to invyra, click "Fetch Locations" in the connect form to auto-detect all available locations.
Tip: In the invyra connect form, click "Fetch Locations" after entering your Access Token and Application ID. invyra will fetch all your Square locations and let you pick one from a dropdown.
3
Connect to invyra
Enter your Square credentials into invyra:
- 1Go to invyra → Integrations → Square POS (or Settings → POS Integration).
- 2Choose your environment: Toggle Production if using a production token (EAAAE...), or Sandbox if testing.
- 3Enter your Square Access Token (from the Developer Console).
- 4Enter your Application ID (from the Developer Console).
- 5Click "Fetch Locations" to load your Square locations, then select the one to sync.
- 6Click Connect — invyra will test the connection and sync your catalog.
4
(Optional) Set Up Webhooks for Real-Time Sync
Webhooks let invyra receive instant updates when sales happen in Square, instead of waiting for periodic syncs.
- 1In your Square Developer Console, open your app and click Webhooks in the left sidebar.
- 2Click "Add Webhook" and enter the webhook URL from the invyra integration page (e.g.,
https://yourdomain.com/api/pos-integration/webhook). - 3Subscribe to these events:
inventory.count.updated,order.created,catalog.object.updated. - 4Click Save — Square will send a test verification to the webhook URL.
Webhooks are optional but recommended. Without them, invyra syncs periodically. With webhooks, inventory updates are near-instant.