Prerequisites
Before connecting Zonal, ensure you have:- Zonal Aztec POS with iOrder API access
- iOrder Brand Token from your Zonal account manager
- iOrder User Device Identifier
- Admin access to your storekit dashboard
Contact your Zonal account manager to request iOrder API credentials. You’ll need the Brand Token and User Device Identifier to connect.
Setting Up the Connection
Step 1: Enter Zonal Credentials
- Go to Stores → your store → Settings → Integrations in your storekit dashboard
- Find Zonal and click Connect to Zonal
- Enter your iOrder credentials:
- iOrder brand token - Your iOrder brand authentication token
- iOrder user device identifier - Your unique device identifier
- Bundle identifier (optional) - Custom bundle ID if provided
- Under Table Service API (pay at table), enter your Integrator identity and Request HMAC secret if these credentials are enabled for your account
- Click Connect to Zonal
authCheck endpoint before saving.
Step 2: Select Your Venue and Payment Method
After authentication:- Go to Stores → your store → Settings → Integrations → Zonal
- In Orders, click Edit, then select the Zonal venue (site) that matches this storekit store
- Select the Payment method for online orders
- Click Save in the bar at the top of the page
- Switch on Enable Zonal in the page header
Step 3: Sync Your Menu
Once connected, import your menu from Zonal:- Go to Menus and open the store’s menu. The store needs a menu first. If it has none, go to Stores, click Create a menu on the store’s card and choose Enter Manually — the sync fills the empty menu (see Build your first menu)
- Click the Zonal button in the menu editor header, then Sync menu. To sync every Zonal menu on the account, click Sync all on the Menus page and choose Zonal menus instead
- storekit fetches menus from all sales areas
- Categories and products are imported with full modifier structure
Menu Sync
What Gets Synced
Sync Types
Full Sync: Imports the complete menu structure including categories, products, modifiers, and images. Use after significant menu changes. Lightweight Sync: Updates only prices and availability without re-importing the full structure. Much faster - ideal for frequent price changes or stock updates. Click the Zonal button in the menu editor header, then Sync price & availability.The Zonal button in the menu editor header only shows for accounts with the Zonal feature switched on. If you don’t see it, use Sync all → Zonal menus on the Menus page or contact support.
Sync Options
Set these options in the Zonal integration settings. In Orders, click Edit to set Enable coursing; in Menu, click Edit to set the other options. Click Save in the bar at the top of the page to apply your changes.Production instructions (items with
divisionId of 0 or isInstruction flag) are automatically imported as free modifiers, even if they have no supplement price. This allows customers to add special preparation instructions like “No Ice” or “Extra Hot” to their orders.Sales Area Restrictions
Zonal menus are organised by sales areas. During sync, storekit:- Fetches menus from all sales areas
- Merges identical menus across areas
- Creates category-level area restrictions
Portions (Sizes)
When a product has multiple portions in Zonal, storekit creates a “Size” modifier group:- Base product price is set to £0
- Each portion becomes a modifier with its price
- Customers must select a size to add the item
Order Injection
When a customer places an order, storekit sends it to Zonal via theplacePaidOrder method.
Order Flow
- Basket validation - storekit calls
checkBasketto validate items - Payment processed - Customer pays via storekit
- Order dispatched - Order sent to Zonal with basket ID
- Confirmation - Zonal returns receipt ID, order marked accepted
Service Types
You can choose a different Zonal service for each order type in Order types — see Sales area IDs for pickup and delivery.
Pre-Order Dispatch
For pre-orders, storekit calculates the optimal dispatch time:- Same-day orders: Dispatched immediately
- Future orders: Dispatched at 6am on the order day
What Zonal Receives
Each order includes:- Customer first name (up to 14 characters), email and phone
- All items with ingredient IDs, display record IDs, and portion type
- Modifiers as choice lines with nested structure
- Course assignments (if configured)
- Removal modifiers (for default items removed)
- Discount lines (percentage or fixed amount)
- Tip amount
- Delivery address (for delivery orders)
- Timeslot (for pickup)
- Custom order notes (via order note product)
Order Notes
Zonal only accepts customer notes as a line item, so an Order note product ID must be configured before notes can appear on Zonal tickets. In the Zonal integration settings, go to Orders → Edit → Show advanced and enter the Zonal product ID your Zonal account manager provides. You can also set the Order note template there. Click Save in the bar at the top of the page to apply the changes. storekit then adds a line item using that product with the formatted note attached. Notes are upper-cased and stripped of characters Zonal can’t display, and are truncated at 840 characters. Use Order note template (up to 250 characters) to control how the note is composed. Two storekit settings must also allow the note through:- Stores → [your store] → Settings → Operations → Order Notes must be Optional or Mandatory (not Hidden), otherwise customers never get a note field
- If you use order batching, Include order notes must be on, or notes are stripped from the merged order before it is sent to Zonal — see Customer notes on batched tickets
Basket Validation & Discounts
Zonal integration validates orders at checkout using thecheckBasket API.
How It Works
- Customer proceeds to checkout
- storekit sends basket to Zonal with all items and modifiers
- Zonal validates availability and calculates any discounts
- Discount amount is returned and applied to the order total
- Basket ID is stored and used when placing the order
Discount Configuration
Set both IDs in the Zonal integration settings under Orders → Edit → Show advanced, then click Save in the bar at the top of the page.Basket validation catches unavailable items before payment. If an item is sold out, the customer is notified immediately.
Auto-Snooze on Errors
IfcheckBasket returns a sold-out error (code -216 or -227), storekit automatically:
- Identifies the unavailable item
- Snoozes it for 6 hours
- Clears the menu cache
- Returns the item info to the customer
Floor Plan Sync
Sync your table layout from Zonal for dine-in ordering:- Go to Stores → your store → Settings → Integrations → Zonal
- In the page header, open More → Sync tables
- Areas (sales areas) and tables are imported
What Gets Synced
- Zonal table groups as storekit areas (tables with no group go into an area named after their sales area)
- Individual tables with numbers and names
Integration Settings
The Zonal integration settings are organised into Orders, Order types, and Menu. Click Edit in a group to show its fields. Changes across these groups are staged together; click Save in the bar at the top of the page to apply them. Enable Zonal in the page header turns the integration on and off, and saves straight away.Sales area IDs for pickup and delivery
By default, storekit uses sales area ID1 for pickup and delivery orders. If your Zonal configuration requires a specific sales area for these order types, click Edit in Order types, then set it. You can also choose a Zonal service for each type; leave either field blank to use its default:
Dine-in orders always use the sales area ID from the table’s venue area (synced via floor plan). The fulfillment sales area ID settings only apply to pickup and delivery orders that do not have a table assigned.
Testing Your Integration
Pre-Launch Checklist
-
Menu sync
- Categories imported from all sales areas
- Products have correct prices (including portion variants)
- Modifiers appear correctly
- Nested modifiers work
- Images display
-
Order flow
- Basket validates successfully
- Order appears in Zonal POS
- Items, modifiers, and courses are correct
- Timeslot appears on pickup orders
-
Discounts (if configured)
- Apply a discount code
- Verify amount matches Zonal calculation
-
Floor plan (if using dine-in)
- Tables synced correctly
- Orders route to correct tables
Troubleshooting
Connection Failed
- Verify Brand Token and User Device Identifier are correct
- Check credentials haven’t expired
- Contact Zonal support to confirm iOrder API access
Menu Not Syncing
- Ensure menus are published in Zonal
- Check products are assigned to display groups
- Verify sales areas are configured
- Check for sync errors in the dashboard
Orders Failing
- “Failed to refresh Zonal basket ID”: Basket validation failed when storekit tried to get a fresh basket - check item availability
- Error -238: Basket expired - storekit will retry with fresh basket
- Error -216 or -227: Item sold out - item is auto-snoozed
- Error -209: The basket was already placed - storekit treats the order as sent, so it isn’t duplicated
Modifiers Not Appearing
- Check choice groups are configured on products
- Verify modifiers have supplement prices (or turn on Import choices without a price under Menu → Edit)
- Re-sync menu after Zonal changes
Order Notes Not Appearing
- Check Order note product ID is set under Orders → Edit → Show advanced in the Zonal integration settings — without it no note line is sent
- Check Order Notes under Operations is Optional or Mandatory, not Hidden
- If order batching is on, check Include order notes is enabled
- Confirm the note product ID is valid in Zonal — Zonal rejects the order line if the product doesn’t exist
Wrong Prices
- Check portion configuration in Zonal
- Verify the correct portion is set as default
- For multi-portion products, check size modifier prices
Supported Features
Orders
Orders
Pay at Table
Pay at Table
Pay at table uses Zonal’s Table Service API, so enter the Integrator identity and Request HMAC secret when you connect.
Venue Setup
Venue Setup