Fields
None. Any key can call it, whatever its permissions, so it is the call to make first with a new key.
It answers even when the store's subscription is not active, and says so in license. The endpoints that read your store's data then answer 403 license_not_active, so this is the call that tells your integration why it stopped.
What it answers
| Field | Meaning |
|---|---|
| name | The name you gave the key. |
| key_prefix | The key's first 16 characters, such as ffl_sk_live_7Hq2, as the account's API keys page lists it. |
| permissions | The key's level in each permission it holds anything in, such as {"products": "read", "inventory": "read_write"}. A permission that is missing is No access. Always an object, {} when empty. New permissions may appear. |
| scopes | The same, as the scopes the endpoints name: products:read, pricing_rules:read, pricing_rules:write, restrictions:read, restrictions:write, distributors:read, distributors:write, inventory:read, inventory:write, webhook:read, webhook:write, dealers:read, ffl_orders:read, ffl_orders:write, subscription:read. A Data Feed store's key holds only Data Feed's and the two both products share, an FFL Checkout store's only FFL Checkout's and those two. |
| license_id | The store the key belongs to. |
| rate_limit_per_minute | Requests this key may make a minute, across the whole API. |
| license | The store's subscription. status is active, pending, suspended or canceled. reason is null while it is active, and otherwise the reason the data endpoints refuse with: license_suspended, license_canceled or license_pending. |
Returns
- 200The calling key.
It can also answer 401 invalid_api_key and 429 rate_limited. It never answers 403: any key may call it, in any licence status.