Browse the docs
API reference
Scanimart Connect API
A JSON REST API over HTTPS. Generated from the OpenAPI 3.1 description — the same file the server's tests hold to its real responses, the SDKs are built on and the Postman collection is made from. Version 2026-10-01.
https://sandbox.api.scanimart.comsk_test_… keys. Your test store and simulators.
https://api.scanimart.comsk_live_… keys, after your company is approved.
Authentication
Send your secret key as a bearer token. Details in Keys and environments.
curl https://sandbox.api.scanimart.com/v1/ping \
-H "Authorization: Bearer sk_test_..."Endpoints
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.
- GET
/v1/stores/{store_id}/orders - GET
/v1/stores/{store_id}/orders/{order_id} - GET
/v1/stores/{store_id}/orders/{order_id}/delivery-options - POST
/v1/stores/{store_id}/orders/{order_id}/accept - POST
/v1/stores/{store_id}/orders/{order_id}/reject - POST
/v1/stores/{store_id}/orders/{order_id}/delivery-method - POST
/v1/stores/{store_id}/orders/{order_id}/courier/retry
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.
- POST
/v1/webhook-endpoints - GET
/v1/webhook-endpoints - GET
/v1/webhook-endpoints/{endpoint_id} - PATCH
/v1/webhook-endpoints/{endpoint_id} - DELETE
/v1/webhook-endpoints/{endpoint_id} - POST
/v1/webhook-endpoints/{endpoint_id}/roll-secret - POST
/v1/webhook-endpoints/{endpoint_id}/test - GET
/v1/webhook-endpoints/{endpoint_id}/deliveries - POST
/v1/webhook-deliveries/{delivery_id}/retry
Create test orders and sales in your test store. Test keys only.
Events pushed to your webhook endpoint are in the webhook event reference.