Get a single supplier

One supplier, in the same shape the list returns.

Errors

404 supplier_not_found — an archived supplier, a cross-tenant ID, the hidden Default supplier, or an unknown one. Archived rows read as missing here, so re-listing after an archive is enough to confirm it.
422 wrong_id_type:expected_suppliers_got_<table> — the prefix isn’t sup_.

GET/api/v1/suppliers/{id}

Authorization

AuthorizationBearer token (bloomcount_...) · headerrequired

Path parameters

idstringrequired

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.

Responses

200OK

supplierIdstringrequired

namestringrequired

contactNamestring | null

contactEmailstring | null

contactPhonestring | null

websitestring | null

addressstring | null

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

404The requested resource doesn't exist or belongs to a different tenant.

errorstringrequired

422Request body or arguments failed validation.

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.idpath*

Request

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

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

import requests

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

Response

{
  "supplierId": "sup_77p3v2k6m4t1r5z9c8w0y7b3",
  "name": "GardenBros Wholesale",
  "contactName": "Aly Bardon",
  "contactEmail": "orders@gardenbros.example",
  "contactPhone": null,
  "website": "https://gardenbros.example",
  "address": null
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}