Fields
None. Any key can call it, whatever its permissions, and it answers whatever the subscription's status. Use it to show a person what their store still has to set up.
What it answers
| Field | Meaning |
|---|---|
| name | The store's name, as the FFL Monkey screens show it. |
| license | The subscription's status and reason, as GET /key gives them. |
| products | A list of what the store pays for with this licence, such as ["data_feed"]: data_feed or ffl_checkout. A store running both products holds two licences, each with its own keys. |
| domain | The address the licence is bound to, such as https://shop.example.com, or null before it is bound. |
| platform | The store's platform: woocommerce for a WordPress store, bigcommerce for a store connected through the BigCommerce app, custom for a store's own website run through this API. magento is reserved. More values may be added. |
| plugin | When the store's FFL Monkey plugin last reported (last_seen_at) and its version, or null if no plugin ever has. It says a plugin has talked to FFL Monkey, not that it is installed now. |
| webhook | Null, or who set up the store's webhook in managed_by: plugin, the store's FFL Monkey plugin, or api, with PUT /webhook. More values may be added. |
| setup | Each setup step, required steps first. See below. |
Each setup step
| Field | Meaning |
|---|---|
| key | Which step. Branch on it. Today activation and subscription for every store, distributors, pricing and updates for a Data Feed store, and website_key for an FFL Checkout store: a key for FFL Monkey's ready-made dealer picker, which runs only through the FFL Checkout plugin, so it is never required. updates is done while a webhook that is not paused is told when products change; reading GET /changes works as well, and this step cannot see it, so it is never required. More steps may be added. |
| done | Whether the step is done. |
| required | Whether the store needs it to be served. An optional step, such as a pricing rule, is worth doing but never blocks. |
| message | One sentence to show a person: what is done, or what to do. |
Returns
- 200The key's store.
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.