Work through it in order. Each stage assumes the one before it is done.
Stage 1 — What we need from you
Before we can issue a Client Key, send us:
| We need | Why | Example |
|---|---|---|
| Your live site domain | Registered against your key | yourdispensary.com |
| Your staging domain, if you have one | Registered separately | staging.yourdispensary.com |
Whether you use www |
They are different domains | www.yourdispensary.com |
| Your AIQ Ecommerce account details | So we can attach the right credential | Account name or ID |
| Which venues you want on the licence | Decides what appears on the Venues tab | "Camden and Shoreditch" |
| Your technical contact | Who we talk to about the build | Name and e-mail |
| Your billing contact | Who we talk to about invoices | Name and e-mail |
Decide these too
Not required for the key, but the answers shape the build — and two of them are much cheaper to decide now than later:
| Question | Options | Where it is covered |
|---|---|---|
| Do customers buy on your site, or on your hosted menu? | Full storefront / Sync only | Choosing Your Plugin Mode |
| Do URLs include the location? | Localized / Universal | URL Structure |
| How often should products refresh? | 5 minutes → weekly | How Product Syncing Works |
| Which page builder? | Elementor / Bricks / Breakdance / none | Page Builder Guides |
Checklist:
- [ ] Live domain sent
- [ ] Staging domain sent, if applicable
- [ ]
wwwpreference confirmed - [ ] AIQ Ecommerce account details sent
- [ ] Venues confirmed
- [ ] Technical and billing contacts sent
- [ ] Plugin mode decided
- [ ] URL structure decided
Stage 2 — Receiving your key
We set up your licence and send:
- Your Client Key —
CLT_followed by 24 characters - The plugin ZIP —
dispense-products-1.1.0.zip - A link to this knowledge base
- Confirmation of your registered domains
When it arrives
- Store the key somewhere safe — a password manager, not a shared document.
- Check the registered domains in the e-mail match what you expect, including
wwwor its absence. - Do not share the key publicly. It is not a AIQ Ecommerce credential, but it is the only thing between a stranger and your catalogue.
Checklist:
- [ ] Client Key received and stored securely
- [ ] Plugin ZIP received
- [ ] Registered domains confirmed as correct
Stage 3 — Guided setup
3.1 Install and activate
- Plugins → Add New → Upload Plugin, choose the ZIP, Install Now.
- Activate.
- A yellow “not licensed yet” notice appears. Expected.
Full detail: Installing & Activating.
- [ ] Plugin installed
- [ ] Plugin activated
- [ ] AIQ Ecommerce Products appears in the admin menu
3.2 Enter your Client Key
- AIQ Ecommerce Products → API Settings → General.
- Paste the key into Client Key.
- Check the Registered domain line matches what we registered.
- Set the Sync Interval.
- Save Settings.
- [ ] Client Key saved
- [ ] Registered domain matches
- [ ] Sync interval set
3.3 Test the connection
Tools & Debug → Test Connection. You want two green notices:
- [ ] Test Connection passes
Any red message: look it up in Error Messages Explained.
3.4 Select your venues
Venues tab. Tick the locations you want, Save Venue Selection.
- [ ] Venues selected and saved
3.5 Set your plugin mode and URLs
Back on General:
- [ ] Plugin Mode set
- [ ] Store URL Structure set
- [ ] Base Slug set
- [ ] Offer Slug set
- [ ] Products Per Page set
3.6 Run your first sync
Tools & Debug → Sync Products Now. Wait, then check the Sync Status panel.
- [ ] Sync completed
- [ ] Sync Summary shows products imported
- [ ] Products visible under AIQ Ecommerce Products → All Products
- [ ] Brands, Categories and Offers populated
Full detail: Your First Product Sync.
3.7 Set up the storefront
In Full storefront mode:
- [ ] Checkout Page selected on the General tab
- [ ] The checkout page contains
[dispense_checkout_iframe] - [ ] Checkout Page Layout decided
- [ ]
[dispense_cart_icon]added to the header - [ ]
[dispense_view_cart]added to a global template area - [ ]
[dispense_add_to_cart]added to the product template - [ ] Cart Icon configured, if using a custom one
In Sync only mode:
- [ ] Product cards link to the Menu Link field
- [ ] Cart shortcodes removed from templates
3.8 Build the pages
- [ ] Product listing page
- [ ] Category archive template
- [ ] Brand archive template
- [ ] Single product template
- [ ] All-offers page with
[dispense_offers] - [ ] Offers Index Page setting pointed at it
- [ ] Single offer archive template
- [ ] Location picker, if multi-location
- [ ] Permalinks flushed — Settings → Permalinks → Save Changes
3.9 Style it
- [ ] Custom CSS added
- [ ] Product cards match the site design
- [ ] Cart sidebar branded
- [ ] Offer cards branded
- [ ] Everything checked on mobile
Stage 4 — Pre-launch checks
Do these on staging first, then repeat on live after launch.
Data
- [ ] Product count roughly matches AIQ Ecommerce
- [ ] Prices match AIQ Ecommerce
- [ ] Stock quantities match
- [ ] Product images display
- [ ] Brands, categories and cannabis types populated
- [ ] Offers imported and attached to products
- [ ] Sale prices display correctly
Pages
- [ ] Product listing works and paginates
- [ ] Filters and sorting work
- [ ] Category archives work
- [ ] Brand archives work
- [ ] Single product pages work
- [ ]
/offers/shows the index - [ ] Single offer pages work
- [ ] No 404s on any product
Cart and checkout — Full storefront only
- [ ] Cart icon appears on every page
- [ ] Clicking it opens the sidebar
- [ ] Add to cart works and shows the toast
- [ ] Quantity changes update the totals
- [ ] Remove works
- [ ] Reset works
- [ ] Checkout opens the right page
- [ ] The checkout frame loads and fits
- [ ] A test order completes
- [ ] The order appears in AIQ Ecommerce
- [ ] Everything above works logged out, in a private window
- [ ] Everything above works on a phone
Caching
This is the step most likely to be skipped, and the most likely to cause problems later.
- [ ]
admin-ajax.phpexcluded from the page cache - [ ] Checkout page excluded
- [ ]
PHPSESSID,dispense_cart_id,dispense_venue_idin the never-cache cookie list - [ ] Pages with live detail shortcodes excluded
- [ ] Cache lifetime no longer than the sync interval on price-bearing pages
- [ ] AIQ Ecommerce JavaScript excluded from delay/defer optimisation
- [ ] Cloudflare Rocket Loader off, if using Cloudflare
Full detail: Caching & Site Speed.
Analytics — Full storefront only
- [ ] GTM or GA4 installed
- [ ]
view_itemfires - [ ]
add_to_cartfires - [ ]
remove_from_cartfires - [ ]
begin_checkoutfires - [ ]
purchasefires with a transaction ID - [ ]
purchasemarked as a key event in GA4
Syncing
- [ ] Scheduled sync is running on time
- [ ] A real server cron is set up, if the site is quiet
- [ ] Sync duration is comfortably shorter than the interval
- [ ] PHP
max_execution_timeandmemory_limitare adequate
SEO
- [ ] Product URLs are as intended
- [ ] Sitemap includes products
- [ ] Checkout and thank-you pages are
noindex - [ ] Canonicals set, if using Localized URLs across locations
- [ ] Redirects prepared, if any URLs are changing
Stage 5 — Going live
Before the switch
- [ ] Live domain confirmed as registered — check the licence e-mail
- [ ]
wwwpreference matches what is registered - [ ] Backup taken
At launch
- [ ] Site live on the production domain
- [ ] Settings → General → Site Address (URL) is the live domain
- [ ] The Registered domain line on the General tab shows the live domain
- [ ] Test Connection passes on live
- [ ] Manual sync run on live and completed
- [ ] Permalinks flushed
- [ ] All caches cleared
Immediately after
- [ ] A product page loads
- [ ] A category page loads
- [ ]
/offers/loads - [ ] The cart works, logged out
- [ ] A real test order completes and appears in AIQ Ecommerce
- [ ] Analytics events fire
- [ ] Prices match AIQ Ecommerce
In the first week
- [ ] Scheduled syncs are running — check Sync Status daily
- [ ] No errors on the Licence tab
- [ ] No 404s in Search Console
- [ ] Prices and stock staying current
- [ ] Analytics recording purchases
- [ ] Staging domain deactivated, if it is no longer needed
Hand over
Whoever runs the site day to day should know:
- [ ] Where the settings are, and what the four tabs do
- [ ] How to run a manual sync
- [ ] How to read the Sync Status panel
- [ ] That a licence problem never takes the storefront offline
- ] Who to contact, and what to include — [Getting Help