Delivery API

De Delivery API faciliteert het delen van informatie over leveringsorders binnen het Edu-V Afsprakenstelsel. Leveringsorders beschrijven de levering van leermiddelen aan onderwijsorganisaties en individuele gebruikers.

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

Rol van de Licentieregistratie

Als Licentieregistratie ontvangen wij leveringsorders van de Bestelomgeving via de Aanspraakmanager. De leveringsorder bevat informatie over welk product, voor welke school of gebruiker, en met welk leveringstype het leermiddel beschikbaar moet worden gemaakt.

Scope: eduv.delivery.licensor

Het DeliveryOrder-model

Het DeliveryOrder-object beschrijft een leveringsopdracht voor een leermiddel.

Properties

Name
deliveryOrderId
Type
string (uuid)
Description
Unieke identifier voor de leveringsorder.
Name
productId
Type
string
Description
Product-ID (EAN/ISBN) uit de Catalogue API.
Name
deliveryType
Type
enum
Description
Leveringsvariant: school-all, school-studies, school-subjects, school-groups, school-students, school-employees, school-activationcodes, customer-user, customer-activationcode.
Name
school
Type
object
Description
Onderwijsorganisatie waarvoor de levering bestemd is.
Name
buyer
Type
object
Description
Koper (school of individuele gebruiker).
Name
activationPeriod
Type
object
Description
Start- en einddatum van de activeringsperiode.
Name
status
Type
enum
Description
Status: ordered, processed, licensed, cancelled.
Name
portalIds
Type
array[string]
Description
Identifiers van de leermiddelenportalen waar het product beschikbaar moet komen.
Name
contractId
Type
string
Description
Optionele verwijzing naar een contract.

PUT/edu-v/v2/delivery-api/delivery-orders

Leveringsorder ontvangen

Dit endpoint ontvangt een DeliveryOrderRequest van de Aanspraakmanager. De leveringsorder wordt gevalideerd en geregistreerd. Retourneert 202 Accepted bij succes.

Vereiste velden

Name
deliveryOrderReferenceId
Type
string (uuid)
Description
Unieke referentie voor deze leveringsorder.
Name
productId
Type
string
Description
Product-ID (EAN/ISBN).
Name
school
Type
object
Description
Onderwijsorganisatie.
Name
deliveryType
Type
string
Description
Leveringsvariant.

Request

PUT

/edu-v/v2/delivery-api/deliveryorders

{
    "deliveryOrderReferenceId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "productId": "9789464421408",
    "deliveryType": "school-all",
    "school": {
        "organisationMasterIdentifier": "16SK"
    },
    "activationPeriod": {
        "startDate": "2026-09-01",
        "endDate": "2027-08-31"
    }
}

Foutresponses

Alle endpoints retourneren een StatusResponse bij fouten. Zie EDU-V Foutcodes — Delivery API (41xx) voor het volledige overzicht van functionele foutcodes.