Developers
Store

Get the store

GET
/store

Returns the store this API key belongs to and the key's own scopes. Use it to check that a key works and what it may do.

Authorization

apiKey
headerAuthorizationBearer <token>

A store API key from Settings → Developers → API keys, sent as Authorization: Bearer zk_live_….

Response Body

Success

application/json
  1. response
object*"store"
Value in"store"
id*string
name*string
slug*string
url*string

The storefront URL

currency*string
Length3 <= length <= 3
locale*string

Default language, e.g. ar or en

plan*string
Value in"free""pro""advanced"
api_key*

The key that made this request

curl -X GET "https://example.com/store"
{  "object": "store",  "id": "00000000-0000-4000-8000-0000000000f1",  "name": "Sara's Shop",  "slug": "saras-shop",  "url": "https://saras-shop.zaher.io",  "currency": "SAR",  "locale": "ar",  "plan": "pro",  "api_key": {    "id": "00000000-0000-4000-8000-0000000000d1",    "name": "ERP sync",    "prefix": "zk_live_ab12",    "scopes": [      "orders:read",      "bookings:read",      "products:read",      "customers:read"    ],    "expires_at": null  }}