Stores

Connect stores with their one-time code, and list or disconnect them.

POSTConnect a store with its one-time code
GETList connected stores
GETGet a connected store
POSTDisconnect a store

Connect a store with its one-time code

POST/v1/connections/claim

The store owner generates a code in the Scanimart retailer app (Settings → POS software → Connect your POS) and enters it in your POS. Exchange it here for access to that store. Codes expire after 15 minutes and work once. Claiming a store you are already connected to returns the existing link. Needs a company-wide key: the store joins your whole company.

Parameters

Idempotency-Keystring · header
Any unique string (a UUID is ideal). Retrying with the same key returns the first result instead of acting twice. Kept for 24 hours.

Request body

codestringrequired
The 8-character code the store generated in the Scanimart retailer app, e.g. K7Q2-M9XP.

Returns · StoreLink

Show 4 fields

objectstring
iduuidrequired
storeobjectrequired
- objectstring
- idintegerrequired
- namestringrequired
- statusstringrequired
  open, closed or renovation.
- activebooleanrequired
- servicesstringrequired
  offline_only or offline_online.
- gstinstringnullablerequired
- addressstringrequired
- areastringnullablerequired
- citystringnullablerequired
- latitudenumbernullablerequired
- longitudenumbernullablerequired
- connected_attimestamp
  When the store connected you. On list and get.
connected_attimestamprequired

Errors: 400, 403, in the standard error format.

Request
curl -X POST https://sandbox.api.scanimart.com/v1/connections/claim \
  -H "Authorization: Bearer $SCANIMART_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "K7Q2-M9XP"
  }'

Response · 200
{
  "object": "store_link",
  "id": "ORDER-1A2B3C4D5E",
  "store": {
    "object": "store",
    "id": 1,
    "name": "Aashirvaad Atta 5kg",
    "status": "string",
    "active": true,
    "services": "string",
    "gstin": "29ABCDE1234F1Z5",
    "address": "12, 4th Cross, Indiranagar",
    "area": "Indiranagar",
    "city": "Bengaluru",
    "latitude": 12.97,
    "longitude": 12.97,
    "connected_at": "2026-10-08T10:15:00+05:30"
  },
  "connected_at": "2026-10-08T10:15:00+05:30"
}

List connected stores

GET/v1/stores

Only stores with an active connection to the POS company authenticated by your API key, in that key's live or test mode. A store-scoped key returns only its own connected store. Unconnected stores, revoked connections and other POS companies' stores are never listed.

Returns · StoreList

Show 4 fields

objectstring
dataarray of objectrequired
- objectstring
- idintegerrequired
- namestringrequired
- statusstringrequired
  open, closed or renovation.
- activebooleanrequired
- servicesstringrequired
  offline_only or offline_online.
- gstinstringnullablerequired
- addressstringrequired
- areastringnullablerequired
- citystringnullablerequired
- latitudenumbernullablerequired
- longitudenumbernullablerequired
- connected_attimestamp
  When the store connected you. On list and get.
has_morebooleanrequired
next_cursorstringnullablerequired
Pass as cursor to get the next page.

Request
curl https://sandbox.api.scanimart.com/v1/stores \
  -H "Authorization: Bearer $SCANIMART_KEY"

Response · 200
{
  "object": "list",
  "data": [
    {
      "object": "store",
      "id": 1,
      "name": "Aashirvaad Atta 5kg",
      "status": "string",
      "active": true,
      "services": "string",
      "gstin": "29ABCDE1234F1Z5",
      "address": "12, 4th Cross, Indiranagar",
      "area": "Indiranagar",
      "city": "Bengaluru",
      "latitude": 12.97,
      "longitude": 12.97,
      "connected_at": "2026-10-08T10:15:00+05:30"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Get a connected store

GET/v1/stores/{store_id}

Parameters

store_idinteger · pathrequired

Returns · Store

Show 13 fields

objectstring
idintegerrequired
namestringrequired
statusstringrequired
open, closed or renovation.
activebooleanrequired
servicesstringrequired
offline_only or offline_online.
gstinstringnullablerequired
addressstringrequired
areastringnullablerequired
citystringnullablerequired
latitudenumbernullablerequired
longitudenumbernullablerequired
connected_attimestamp
When the store connected you. On list and get.

Errors: 404, in the standard error format.

Request
curl https://sandbox.api.scanimart.com/v1/stores/1042 \
  -H "Authorization: Bearer $SCANIMART_KEY"

Response · 200
{
  "object": "store",
  "id": 1,
  "name": "Aashirvaad Atta 5kg",
  "status": "string",
  "active": true,
  "services": "string",
  "gstin": "29ABCDE1234F1Z5",
  "address": "12, 4th Cross, Indiranagar",
  "area": "Indiranagar",
  "city": "Bengaluru",
  "latitude": 12.97,
  "longitude": 12.97,
  "connected_at": "2026-10-08T10:15:00+05:30"
}

Disconnect a store

POST/v1/stores/{store_id}/disconnect

Stops all events for the store and revokes your access to it. The store can reconnect with a new code.

Parameters

store_idinteger · pathrequired

Returns · StoreLink

Show 4 fields

objectstring
iduuidrequired
storeobjectrequired
- objectstring
- idintegerrequired
- namestringrequired
- statusstringrequired
  open, closed or renovation.
- activebooleanrequired
- servicesstringrequired
  offline_only or offline_online.
- gstinstringnullablerequired
- addressstringrequired
- areastringnullablerequired
- citystringnullablerequired
- latitudenumbernullablerequired
- longitudenumbernullablerequired
- connected_attimestamp
  When the store connected you. On list and get.
connected_attimestamprequired

Request
curl -X POST https://sandbox.api.scanimart.com/v1/stores/1042/disconnect \
  -H "Authorization: Bearer $SCANIMART_KEY"

Response · 200
{
  "object": "store_link",
  "id": "ORDER-1A2B3C4D5E",
  "store": {
    "object": "store",
    "id": 1,
    "name": "Aashirvaad Atta 5kg",
    "status": "string",
    "active": true,
    "services": "string",
    "gstin": "29ABCDE1234F1Z5",
    "address": "12, 4th Cross, Indiranagar",
    "area": "Indiranagar",
    "city": "Bengaluru",
    "latitude": 12.97,
    "longitude": 12.97,
    "connected_at": "2026-10-08T10:15:00+05:30"
  },
  "connected_at": "2026-10-08T10:15:00+05:30"
}