Fields
None. Any key with In-house inventory access can call it. To test a key that has only Products and changes, use the Store API's GET /key, which any key can call.
It answers even when the store's subscription is not active, and says so in license. Every other endpoint then answers 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_3f9a, to tell keys apart. |
| scopes | Every scope the key holds, for every permission it has, not only In-house inventory's: inventory:read, inventory:write for Read and write, and the Store API's, such as products:read or pricing_rules:write, when it has those too. The Store API's GET /key lists them as permissions as well. |
| license_id | The store the key belongs to. |
| rate_limit_per_minute | Requests this key may make a minute. |
| license | The store's subscription. status is active, pending, suspended or canceled. reason is null while it is active, and otherwise the reason the other endpoints refuse with: license_suspended, license_canceled or license_pending. |
Returns
- 200The calling key.
It can also answer 401 invalid_api_key, 403 product_not_included, 403 insufficient_scope (a key without In-house inventory) and 429 rate_limited. It never answers 403 license_not_active: license says why the other endpoints do.