Fabric documentation
V1BrandsBrandidCatalog builderRunsId

Poll a run

GET
/v1/brands/{brandId}/catalog-builder/runs/{id}

Status, counts and progress. processed reaches total even when a third of the catalog is unfindable — every identity finishes, with a result or a failure.

Authorization

apiKey
AuthorizationBearer <token>

Your API key. X-Api-Key: <key> is accepted as an alternative.

A key belongs to an organization, not a user, so it outlives whoever created it. It carries two independent things, and both are checked: an org role (a member key cannot approve a publish or activate a mapping) and a set of scopes — catalog:read, catalog:write, enrichment:write, publishing:read, publishing:write, org:read, org:write. Holding a scope does not grant a role, and holding a role does not grant a scope.

GET /v1/me returns both for the key you are holding.

In: header

Path Parameters

brandId*string

Which of your brands this run belongs to. A brand outside your organization answers not found.

id*string

The run id from POST /runs.

Response Body

application/json

application/problem+json

application/problem+json

application/json

application/problem+json

curl -X GET "https://example.com/v1/brands/string/catalog-builder/runs/string"
{  "counts": {    "promote": -9007199254740991,    "reject": -9007199254740991,    "review": -9007199254740991  },  "processed": -9007199254740991,  "status": "cancelled",  "total": -9007199254740991}

Start a run POST

A batch of product identities in, a run id back. **202, not 200**: the work has been accepted, not done — poll `GET /runs/{id}`. Needs `catalog:write` and an `Idempotency-Key` header: a retried POST with the same key does not scrape the batch twice. Send NDJSON (one object per line, `application/x-ndjson`) or a JSON array. Lines are accepted or rejected **individually**: a batch of 5,000 with one bad row scrapes 4,999 and tells you which line failed. Every line needs a vendor SKU (`sku` or `vendorSku`) — it is what the supplier's site is indexed by, and a line without one is rejected. Each line needs something to scrape *against*: either a `categoryId` whose category has a golden mapping, or its own `attributes`. A line with neither is refused as `no_gold_match` rather than scraped for generic attributes.

Download results as CSV GET

Flat: one row per identity, one column per attribute found anywhere in the run. `ref`, `outcome`, `reviewScore`, `sourceUrl` and `failure` come first.