FurniOpsDocs
API referenceCategories

Set a source's category rules

Sets or removes the rules given; other rules stay as they are. A rule covers its path and every path below it until a more specific rule. The source's current snapshot is replayed to apply them. An unknown category answers 422; a source with an active run, or a paused or disabled one, answers 409, and then nothing is saved.

POST/v1/sources/{id}/categories

Sets or removes the rules given; other rules stay as they are. A rule covers its path and every path below it until a more specific rule. The source's current snapshot is replayed to apply them. An unknown category answers 422; a source with an active run, or a paused or disabled one, answers 409, and then nothing is saved.

Authorization

apiKey
AuthorizationBearer <token>

An API key (fo_live_… / fo_test_…) as a bearer token

In: header

Path Parameters

id*string

Source (a vendor connection) ID

Match^src_[0-9A-Za-z]{22}$

Header Parameters

FurniOps-Version?string

Dated API version; pinned per organisation on first use and overridable per request

Value in

  • "2026-10-01"
  • "2026-10-04"
FurniOps-Mode?string

The data the request acts on: test is the organisation's sandbox. An OAuth token picks it (live by default); an API key's mode is fixed, and naming the other one is refused

Value in

  • "live"
  • "test"
Idempotency-Key*string

Unique key for this operation, reused on retries (24 h)

Length1 <= length <= 257
FurniOps-Dry-Run?string

Preview the write and change nothing: true answers the would-be response, explain a Preview (application/vnd.furniops.preview+json)

Value in

  • "true"
  • "explain"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Rules to set or remove; others stay as they are

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/sources/string/categories" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "rules": [      {        "path": [          "string"        ],        "category": "string"      }    ]  }'
{  "object": "category_rules",  "categories": [    {      "object": "source_category",      "path": [        "string"      ],      "products": 0,      "rule": {        "id": "string",        "path": "string"      },      "inherited": {        "id": "string",        "path": "string"      },      "suggestion": {        "id": "string",        "path": "string"      }    }  ],  "run": {    "object": "run",    "id": "string",    "source": "string",    "trigger": "schedule",    "stream": "catalogue",    "status": "queued",    "stage": "fetch",    "served_by": null,    "stats": {      "property1": 0,      "property2": 0    },    "error": {      "code": "fetch_refused",      "message": "string"    },    "waiting": {      "reason": "rate_limited",      "until": "2019-08-24T14:15:22Z",      "attempt": 1,      "detail": "string"    },    "problems": [      {        "sheet": "string",        "line": 1,        "column": "string",        "field": "string",        "problem": "missing",        "detail": "string"      }    ],    "created_at": "2019-08-24T14:15:22Z",    "started_at": "2019-08-24T14:15:22Z",    "finished_at": "2019-08-24T14:15:22Z"  }}

List a source's categories GET

Every category path the source's current products name, and every path above them, in path order: how many products sit at or below each, the rule set there, the rule inherited from above, or a same-name suggestion. Products under a path with no rule have no category.

Dismiss a review pair POST

Records that the two are different items: the pair is not offered again, however they are scored later. A pair that is not open answers 409.