Catalogue

De Catalogue API wordt gebruikt om productinformatie (leermiddelen en sets van leermiddelen) te delen binnen het Edu-V Afsprakenstelsel. De API biedt de gegevens die nodig zijn voor het verwerven en in gebruik nemen van leermiddelen, inclusief toegangslinks voor het Leermiddelenportaal.

Deze API is beschikbaar als v1 (deprecated) en v2 (aanbevolen). Beide versies zijn functioneel identiek. Zie de EDU-V documentatie voor v1 en v2.

Het productmodel

Het Product-object beschrijft een leermiddel of set van leermiddelen die door een leverancier worden aangeboden.

Properties

Name
productId
Type
string
Description
Unieke identifier voor het product. ISBN/EAN voor verkoopbare producten, UUID voor overige.
Name
publisher
Type
string
Description
De organisatie die het leermiddel aanbiedt of exploiteert.
Name
type
Type
enum
Description
Producttype: physical, digital of combi.
Name
name
Type
string
Description
De productnaam.
Name
productFamilyName
Type
string
Description
Naam van de methode/productfamilie waar dit product bij hoort.
Name
edition
Type
string
Description
Editie- of versienummer.
Name
status
Type
enum
Description
Levenscyclusstatus: not-yet-available, limited-available, available, temporary-not-available, no-longer-available, will-never-be-available, not-available-or-usable.
Name
forSale
Type
boolean
Description
Geeft aan of het product verkoopbaar is.
Name
saleUnitSize
Type
integer
Description
Aantal eenheden per verkoop (minimaal 1).
Name
isConsumptionProduct
Type
boolean
Description
Geeft aan of het product een verbruiksmateriaal is met beperkte geldigheid.
Name
productUsages
Type
array[enum]
Description
Gebruiksvormen: leerboek, werkboek, examenbundel, oefenmateriaal, naslagwerk, docentenmateriaal, toets, examen, anders.
Name
intendedEndUserRole
Type
enum
Description
Doelgebruiker: student, educator, administrator.
Name
studies
Type
array[Study]
Description
Onderwijsprogramma's waarvoor dit product bestemd is.
Name
subjects
Type
array[Subject]
Description
Vakken/leergebieden die het product bestrijkt.
Name
price
Type
array[Price]
Description
Verkoopprijzen (publiek). Bevat vorige, huidige en/of toekomstige prijs.
Name
licensePeriod
Type
object
Description
Licentieduur met licenseVariant (days, schoolyear, year) en optioneel licenseDays.
Name
shortDescription
Type
string
Description
Korte omschrijving (1-80 tekens) voor zoekresultaten.
Name
longDescription
Type
string
Description
Uitgebreide productomschrijving.
Name
authors
Type
object
Description
Auteurs: individuals (array van personen) en/of organisations (array van namen).
Name
media
Type
object
Description
Media-objecten waaronder mainThumbnailUrl.
Name
followUpProduct
Type
string
Description
ProductId van het opvolgproduct.
Name
bundledProducts
Type
array[string]
Description
ProductId's van de onderdelen bij een set/comboproduct.
Name
firstPublishedDate
Type
date
Description
Marktintroductiedatum.
Name
dateCreated
Type
datetime
Description
Tijdstempel waarop de entiteit is aangemaakt.
Name
dateLastModified
Type
datetime
Description
Tijdstempel van de laatste wijziging.

GET/edu-v/v2/catalogue-api/products

Alle producten ophalen

Dit endpoint retourneert alle producten uit de leverancierscatalogus. Gebruik de optionele since-parameter om alleen producten op te halen die na een bepaald moment zijn gewijzigd (delta-synchronisatie).

Optionele parameters

Name
since
Type
datetime
Description
Alleen producten gewijzigd sinds dit tijdstip (ISO 8601). Maximaal 7 dagen terug.

Request

GET

/edu-v/v2/catalogue-api/products

curl -G https://api.wimpel.nl/edu-v/v2/catalogue-api/products \
  -d since=2026-03-01T00:00:00.000Z

Response

[
    {
        "productId": "9789464421408",
        "publisher": "Boom",
        "type": "physical",
        "name": "KERN Wiskunde leerboek vwo 5 wiskunde B deel 1",
        "productFamilyName": "KERN Wiskunde",
        "status": "available",
        "forSale": true,
        "saleUnitSize": 1,
        "isConsumptionProduct": true,
        "intendedEndUserRole": "student",
        "studies": [
            { "studyName": "vwo-gymnasium bovenbouw" },
            { "studyName": "vwo-athenium bovenbouw" }
        ],
        "subjects": [],
        "price": [
            {
                "priceExcl": 55.95,
                "priceIncl": 60.99,
                "priceCurrency": "EUR",
                "validFrom": "2026-03-09"
            }
        ],
        "shortDescription": "KERN Wiskunde leerboek vwo 5 wiskunde B deel 1",
        "media": {},
        "firstPublishedDate": "2026-03-09",
        "dateCreated": "2026-03-09T10:06:28.629Z",
        "dateLastModified": "2026-03-09T10:06:28.629Z"
    },
    {
        "productId": "9789492862433",
        // ...
    }
]

GET/edu-v/v2/catalogue-api/products/:productId

Product op ID ophalen

Dit endpoint retourneert een enkel product op basis van het productId (ISBN/EAN).

Request

GET

/edu-v/v2/catalogue-api/products/9789464421408

curl https://api.wimpel.nl/edu-v/v2/catalogue-api/products/9789464421408

Response

{
    "productId": "9789464421408",
    "publisher": "Boom",
    "type": "physical",
    "name": "KERN Wiskunde leerboek vwo 5 wiskunde B deel 1",
    "productFamilyName": "KERN Wiskunde",
    "status": "available",
    "forSale": true,
    "saleUnitSize": 1,
    "isConsumptionProduct": true,
    "intendedEndUserRole": "student",
    "studies": [
        { "studyName": "vwo-gymnasium bovenbouw" },
        { "studyName": "vwo-athenium bovenbouw" }
    ],
    "subjects": [],
    "price": [
        {
            "priceExcl": 55.95,
            "priceIncl": 60.99,
            "priceCurrency": "EUR",
            "validFrom": "2026-03-09"
        }
    ],
    "shortDescription": "KERN Wiskunde leerboek vwo 5 wiskunde B deel 1",
    "media": {},
    "firstPublishedDate": "2026-03-09",
    "dateCreated": "2026-03-09T10:06:28.629Z",
    "dateLastModified": "2026-03-09T10:06:28.629Z"
}

GET/edu-v/v2/catalogue-api/products-info

Productinfo ophalen (portaalweergave)

Dit endpoint retourneert een beknopte weergave van alle producten, bedoeld voor weergave in het Leermiddelenportaal. Bevat alleen de velden die nodig zijn voor zoeken en tonen.

Request

GET

/edu-v/v2/catalogue-api/products-info

curl https://api.wimpel.nl/edu-v/v2/catalogue-api/products-info

Response

[
    {
        "productId": "9789464421408",
        "name": "KERN Wiskunde leerboek vwo 5 wiskunde B deel 1",
        "publisher": "Boom",
        "type": "physical",
        "status": "available",
        "shortDescription": "KERN Wiskunde leerboek vwo 5 wiskunde B deel 1",
        "media": {}
    },
    {
        "productId": "9789492862433",
        // ...
    }
]

GET/edu-v/v2/catalogue-api/products-info/:productId

Productinfo op ID ophalen (portaalweergave)

Dit endpoint retourneert de beknopte productinformatie voor een enkel product op basis van het productId.

Request

GET

/edu-v/v2/catalogue-api/products-info/9789464421408

curl https://api.wimpel.nl/edu-v/v2/catalogue-api/products-info/9789464421408

Response

{
    "productId": "9789464421408",
    "name": "KERN Wiskunde leerboek vwo 5 wiskunde B deel 1",
    "publisher": "Boom",
    "type": "physical",
    "status": "available",
    "shortDescription": "KERN Wiskunde leerboek vwo 5 wiskunde B deel 1",
    "media": {}
}