Catalogs

De Catalogs API geeft toegang tot catalogi. Een catalogus is een verzameling producten voor een specifieke periode of doelgroep, gekoppeld aan een partner en app.

The catalog model

Properties

Name
id
Type
string
Description
Unieke identifier.
Name
name
Type
string
Description
Naam van de catalogus.
Name
app
Type
object
Description
Gekoppelde app met partner-informatie.
Name
_count
Type
object
Description
Aantal gekoppelde items (producten, etc.).

GET/v1/catalogs

List all catalogs

Haal een lijst van alle beschikbare catalogi op, inclusief het aantal items en partnerinformatie.

Request

GET

/v1/catalogs

curl https://api.example.nl/v1/catalogs \
  -H "Authorization: Bearer {token}"

Response

[
  {
    "id": "clx...",
    "name": "VO 2026-2027",
    "app": {
      "partner": {
        "name": "Boom Uitgevers"
      }
    },
    "_count": {
      "items": 342
    }
  }
]

GET/v1/catalogs/:id

Retrieve a catalog

Haal een enkele catalogus op.

Request

GET

/v1/catalogs/clx...

curl https://api.example.nl/v1/catalogs/clx... \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "clx...",
  "name": "VO 2026-2027",
  "_count": {
    "items": 342
  }
}

GET/v1/catalogs/:id/products

List products in a catalog

Haal een gepagineerde lijst van producten op binnen een specifieke catalogus.

Optional attributes

Name
take
Type
integer
Description
Aantal per pagina (standaard 10).
Name
skip
Type
integer
Description
Aantal over te slaan.
Name
include
Type
string
Description
Relaties: publisher, catalog, method.

Request

GET

/v1/catalogs/clx.../products

curl -G https://api.example.nl/v1/catalogs/clx.../products \
  -H "Authorization: Bearer {token}" \
  -d take=10 \
  -d include=publisher

Response

[
  {
    "ean": "9789493113862",
    "name": "POLARIS nask1 leerwerkboek vmbo-basis 3 deel A",
    "price": "29.95",
    "type": "physical",
    "publisher": {
      "name": "Boom Uitgevers"
    },
    "_count": {
      "salesOrderLines": 42
    }
  }
]

POST/v1/catalogs/:id/products

Add a product to a catalog

Voeg een product toe aan een catalogus.

Required attributes

Name
ean
Type
string
Description
EAN-code van het product.
Name
name
Type
string
Description
Productnaam.

Request

POST

/v1/catalogs/clx.../products

curl https://api.example.nl/v1/catalogs/clx.../products \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"ean": "9789493113862", "name": "POLARIS nask1 leerwerkboek vmbo-basis 3 deel A"}'

Response

{
  "ean": "9789493113862",
  "name": "POLARIS nask1 leerwerkboek vmbo-basis 3 deel A",
  "catalogId": "clx...",
  "inserted": "2026-03-24T10:00:00.000Z"
}