Integration Types
Stokkd connects to your point-of-sale or inventory system in one of two ways — API or Manual file import/export. Your integration type determines how sites are created, how stock enters a stocktake, and what happens when you finalize.
Overview
Every Stokkd account requires an integration type, selected during onboarding. The integration type determines how data moves between Stokkd and your point-of-sale (POS) or inventory system.
Two integration types are available:
- API — Stokkd connects directly to your POS and exchanges data automatically
- Manual — Data moves via files you upload and download at specific points in the workflow (supported: any system with import/export functionality)
Your integration type affects three workflows: how your sites are created, how stock data enters a stocktake, and what happens when you finalise.
API Integration
Site Setup
When you connect an API integration, your sites sync automatically from the connected POS system. All Shopify locations, for example, appear as sites in Stokkd without any manual entry.
Once the integration sets a site's key fields — name and external identifier — those fields become locked and cannot be edited inside Stokkd. Stokkd-specific fields, such as the short code, remain editable at any time.
Stock Import
When a stocktake is created, Stokkd automatically imports current stock quantities from the connected system. No file preparation or upload is needed.
Finalisation — Automatic Write-Back
When a stocktake is finalised and posted, Stokkd automatically writes counted quantities back to the connected POS. Stock levels are updated without any manual export or file import.
Manual Integration
Site Setup
Sites are created manually by your company administrator. All site fields remain fully editable at any time — there is no connected system to lock them.
Stock Import
When a stocktake is created, you upload a stock data file containing your current product list and expected quantities. Export this file from your POS before starting the stocktake. Stokkd validates the format on upload and flags issues before the stocktake proceeds.
Finalisation — Download Results File
After posting, Stokkd generates a results file available for download from the stocktake history page. Import this file into your POS system to update stock levels.
Comparison
Feature | API | Manual |
|---|---|---|
Supported systems | Shopify/Shopify POS | Any |
Site setup | Auto-synced; Stokkd fields editable | Created manually |
Stock import | Automatic on stocktake creation | Upload a file |
After finalization | Auto write-back to POS | Download results file and import to POS |
Changing Your Integration
Integration selection is required during onboarding — you must choose an integration type before you can continue setting up your account. Because the integration type affects so many other settings (site creation, stock import, finalisation, and field locking), it cannot be skipped.
Changing your integration after setup is possible but should not be done lightly. Depending on the change, it may affect your existing sites, stocktake history, and account configuration. In some cases, assistance from Stokkd Support is required to complete the change safely.
Not sure? Contact Stokkd Support before changing your integration type.
To review or update your integration, go to Settings → Integrations.
Best Practices
- API integration: Review your site list after connecting to confirm all locations synced correctly and short codes are meaningful.
- File-based: Export your stock file from your POS immediately before starting a stocktake — stale files produce inaccurate variance reports.
- File-based: Keep your export format consistent; if your POS changes its export layout, the Stokkd template will need to be updated to match.