The shop and the key

Test a connection and read the shop’s name, address and currency.

Updated 3 November 2026Live from Tocler

GET /v1/store Your shop’s API keystore:read

The shop this key belongs to: its name, address and the currency it sells in.

Errors

403 missing_scope — The key lacks store:read.
401 invalid_key — No key, a wrong key, or a revoked / expired key (key_revoked, key_expired).
429 rate_limited — Over the key’s requests per minute — wait for RateLimit-Reset.

curl -X GET 'https://api.tocler.com/v1/store' \
  -H 'Authorization: Bearer tk_live_…'

{
  "id": "665f1c2e9b1e8a0012345678",
  "object": "store",
  "name": "Test Store",
  "url": "https://teststore.tocler.com",
  "currency": "EUR",
  "status": "active"
}

GET /v1/key Your shop’s API key

What the key you are using may do, when it expires and its rate limit — use it to test a connection. Needs no scope.

Errors

401 invalid_key — No key, a wrong key, or a revoked / expired key (key_revoked, key_expired).
429 rate_limited — Over the key’s requests per minute — wait for RateLimit-Reset.

curl -X GET 'https://api.tocler.com/v1/key' \
  -H 'Authorization: Bearer tk_live_…'

{
  "object": "api_key",
  "key_id": "Ab3dEf6hJk9mN2pQ",
  "name": "Order server",
  "scopes": [
    "store:read",
    "orders:read"
  ],
  "ip_allow": [
    "203.0.113.0/24"
  ],
  "expires_at": "2027-11-03T10:00:00.000Z",
  "rate_per_minute": 120,
  "store": {
    "id": "665f1c2e9b1e8a0012345678",
    "name": "Test Store"
  }
}

Was this page helpful?