Fields
None. Needs Distributors: Read, a permission of Data Feed stores.
Every distributor FFL Monkey offers, by name, and your store's connection to each, as your distributors screen shows them. It never shows a credential, nor any part of one: only whether yours are saved, and whether the distributor accepted them.
Each distributor
| Field | Meaning |
|---|---|
| slug | The distributor's name in the API: the address of PUT and DELETE /distributors/{slug}, a product's sourced_from, and the values of a pricing rule's or restriction's distributors. |
| name | Its name, as your FFL Monkey screens show it. |
| enabled | true while your store buys from it: its offers are priced for your store only while it is on. |
| credential_fields | What to send to connect it, in the order to ask a person for them. See below. Empty when it cannot be connected through the API yet. |
| credentials | none: nothing is saved for it, though it may still be on, from before connecting needed credentials. verified: the distributor accepted the saved credentials when they were sent, at credentials_checked_at. not_verified: saved before FFL Monkey checked credentials with the distributor. |
| credentials_checked_at | When the distributor accepted them, or null unless credentials is verified. |
What to send to connect one
Each entry of credential_fields is one value PUT /distributors/{slug} needs. Distributors ask for different things, so build the form from this list rather than assuming an email and a password.
| Field | Meaning |
|---|---|
| key | The name to send its value under: credentials.<key>. |
| label | What to call it to a person, such as Email. |
| secret | true for a password or a key: do not show it on screen. |
| hint | More help with the field when its label is not enough, or null. |
Returns
- 200Every distributor, in
data, by name.
This endpoint can also answer 401 invalid_api_key, 403 license_not_active, 403 product_not_included, 403 insufficient_scope and 429 rate_limited.