Browse the docs
Documentation
Build on Scanimart Connect
One REST API and a stream of signed webhooks, so a POS can take a store's Scanimart orders, keep its shelf counts true, and book every sale. API version 2026-10-01.
Quickstart
From sign-up to your first accepted test order in about fifteen minutes.
Keys and environments
Test and live keys, the two hosts, store-scoped keys and rolling a key.
Connecting stores
How a store lets your POS in with a one-time code, and how it leaves.
Online orders
Accept or reject paid orders, then pick and pack them. The full lifecycle.
Delivery and commission
Store riders or a Scanimart courier, what each costs, and what to do when a courier fails.
Webhooks
Receive events, verify signatures, and survive retries and duplicates.
Inventory sync
Push stock counts and adjustments without putting sold stock back on the shelf.
Booking sales
Book every Scanimart sale -- online and in-store -- into your POS exactly once.
Errors, retries and limits
The error format, idempotency keys, pagination and the rate limit.
Sandbox and going live
The sandbox simulators, the go-live checklist, and what review looks at.
SDKs and Postman
Official Node.js and Python libraries, and a Postman collection for every endpoint.
API reference
Check which company and key a request runs as.
Connect stores with their one-time code, and list or disconnect them.
Accept or reject online orders, choose who delivers, and follow fulfilment.
Push stock counts and adjustments from the POS.
Book every Scanimart sale, and catch up on missed events.
Register where events are sent, and inspect deliveries.
Create test orders and sales in your test store. Test keys only.
Every event type, when it fires and what it carries.