List suppliers

Cursor-paginated list of the tenant’s suppliers (excluding the hidden Default supplier and archived rows). Use the returned supplierId values when referencing suppliers on the products endpoint — for example to scope a per-variant supplier list or to set per-(variant, supplier) minimum order quantities (MOQ).

Requires the suppliers:read scope.

GET/api/v1/suppliers

Authorization

AuthorizationBearer token (bloomcount_...) · headerrequired

Query parameters

fieldsstring

Comma-separated list of the fields to return, so a caller can ask for the parts of an object it actually uses. A dotted path reaches inside a collection, so `variants.sku` keeps the variants array with only each variant's SKU. The object's own id comes back whether or not it is listed, which keeps a trimmed response addressable. A name that the resource hasn't got returns 422 `unknown_fields:` followed by the names that did not resolve. Omit the parameter for the full object.

cursorstring

Continuation cursor from a previous response.

limitinteger

min 1 · max 100 · default: 25

qstring

Case-insensitive substring search on supplier name.

Responses

200Suppliers page.

itemsListedSupplier[]required

Show properties

Array of ListedSupplier

supplierIdstringrequired

namestringrequired

contactNamestring | null

contactEmailstring | null

contactPhonestring | null

websitestring | null

addressstring | null

isDonebooleanrequired

cursorstring | nullrequired

Pass this back as `?cursor=` to fetch the next page; `null` when `isDone` is true.

401Missing or invalid API key, or revoked / expired.

errorstringrequired

403Authenticated, but the key lacks the required scope or the tenant has no API access.

errorstringrequired

429Per-minute rate limit (60/min) or per-month cap exceeded.

errorstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (bloomcount_...)Remember on this deviceInclude my values in samples

Parameters

fieldsqueryComma-separated list of the fields to return, so a caller can ask for the parts of an object it actually uses. A dotted path reaches inside a collection, so `variants.sku` keeps the variants array with only each variant's SKU. The object's own id comes back whether or not it is listed, which keeps a trimmed response addressable. A name that the resource hasn't got returns 422 `unknown_fields:` followed by the names that did not resolve. Omit the parameter for the full object.cursorqueryContinuation cursor from a previous response.limitqueryqqueryCase-insensitive substring search on supplier name.

Request

curl -X GET "https://app.bloomcount.com/api/v1/suppliers" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://app.bloomcount.com/api/v1/suppliers", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://app.bloomcount.com/api/v1/suppliers",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "items": [
    {
      "supplierId": "sup_77p3v2k6m4t1r5z9c8w0y7b3",
      "name": "GardenBros Wholesale",
      "contactName": "Aly Bardon",
      "contactEmail": "orders@gardenbros.example",
      "contactPhone": "string",
      "website": "https://gardenbros.example",
      "address": "string"
    }
  ],
  "isDone": true,
  "cursor": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}