Orders

Met de Orders-API halen leveranciers/uitgevers de inkooporders op die een school aan hen heeft toegewezen. Gebruik /v1/orders om een lijst van orders op te halen en /v1/orders/:number om order(s) voor een specifiek ordernummer op te vragen.

Naast de API is er een uitgeversportaal beschikbaar voor het inzien en exporteren van orders (voor partijen die niet willen ontwikkelen). Neem contact op met je accountmanager voor toegang.

Het ordermodel

Een order bevat metadata over de order en één of meerdere orderregels.

Order

Name
number
Type
string
Description
Het ordernummer zoals bekend in het bronsysteem.
Name
orderDate
Type
date
Description
De orderdatum (YYYY-MM-DD).
Name
requestedReceiptDate
Type
date
Description
Gewenste ontvangstdatum (YYYY-MM-DD). Bij onbekend kan dit '0001-01-01' zijn.
Name
shipToName
Type
string
Description
Naam van de afleverlocatie.
Name
shipToContact
Type
string
Description
Naam van de contactpersoon op de afleverlocatie.
Name
shipToAddressLine1
Type
string
Description
Adresregel 1 voor aflevering.
Name
shipToAddressLine2
Type
string
Description
Adresregel 2 voor aflevering.
Name
shipToPostCode
Type
string
Description
Postcode van de afleverlocatie.
Name
shipToCity
Type
string
Description
Plaats van de afleverlocatie.
Name
lines
Type
array[OrderLine]
Description
De regels die onderdeel zijn van de order.

OrderLine

Name
sequence
Type
integer
Description
De regelsequentie.
Name
itemNo
Type
string
Description
Artikelnummer (ISBN/EAN of uitgeversproductcode).
Name
description
Type
string
Description
Omschrijving van het artikel.
Name
quantity
Type
integer
Description
Bestelde hoeveelheid.

GET/v1/orders

Lijst met orders ophalen

Deze endpoint retourneert een gepagineerde lijst met orders waar jij als leverancier toegang toe hebt.

Optionele parameters

Name
limit
Type
integer
Description
Maximum aantal orders dat wordt teruggegeven.
Name
cursor
Type
string
Description
Cursor voor de volgende pagina resultaten.
Name
since
Type
date
Description
Alleen orders gewijzigd of aangemaakt sinds deze datum (YYYY-MM-DD).

Request

GET

/v1/orders

curl -G https://api.wimpel.nl/v1/orders \
  -H "Authorization: Bearer {token}" \
  -d limit=10

Response

[
    {
        "number": "106073",
        "orderDate": "2025-08-10",
        "requestedReceiptDate": "2025-09-16",
        "shipToName": "ZuidWestHoek College",
        "shipToContact": "Erik Jansen",
        "shipToAddressLine1": "O Lv Vrouw ter Duinenln 201",
        "shipToAddressLine2": "",
        "shipToPostCode": "4641 RM",
        "shipToCity": "Ossendrecht",
        "lines": [
            {
                "sequence": 10000,
                "itemNo": "9789001022471",
                "description": "buiteNLand ed 5.0 havo/vwo 1 English edition FLEX boek + online",
                "quantity": 42
            }
        ]
    },
    {
        "number": "106046",
        "orderDate": "2025-08-08",
        "requestedReceiptDate": "2025-09-16",
        "shipToName": "'t Ravelijn'",
        "shipToContact": "Hendrik Jansen",
        "shipToAddressLine1": "Ravelijnstraat 2-A",
        "shipToAddressLine2": "",
        "shipToPostCode": "4651 DT",
        "shipToCity": "Steendbergen",
        "lines": [
            {
                "sequence": 10000,
                "itemNo": "9789001022471",
                "description": "buiteNLand ed 5.0 havo/vwo 1 English edition FLEX boek + online",
                "quantity": 42
            }
        ]
    },

]

GET/v1/orders/:number

Order(s) op nummer ophalen

Deze endpoint haalt order(s) op voor het opgegeven ordernummer. De response is een array met één of meer orders die bij dit nummer horen.

Request

GET

/v1/orders/:number

curl https://api.wimpel.nl/v1/orders/106016 \
  -H "Authorization: Bearer {token}"

Response

    {
        "number": "106073",
        "orderDate": "2025-08-10",
        "requestedReceiptDate": "2025-09-16",
        "shipToName": "ZuidWestHoek College",
        "shipToContact": "Erik Jansen",
        "shipToAddressLine1": "O Lv Vrouw ter Duinenln 201",
        "shipToAddressLine2": "",
        "shipToPostCode": "4641 RM",
        "shipToCity": "Ossendrecht",
        "lines": [
            {
                "sequence": 10000,
                "itemNo": "9789001022471",
                "description": "buiteNLand ed 5.0 havo/vwo 1 English edition FLEX boek + online",
                "quantity": 42
            }
        ]
    }

Webhook voor nieuwe orders

Voor leveranciers die realtime updates willen ontvangen, is er een webhook beschikbaar die een event verstuurt wanneer er een nieuwe order klaarstaat.

Name
event
Type
string
Description
Bijvoorbeeld order.created.
Name
payload
Type
object
Description
De payload bevat dezelfde structuur als hierboven beschreven (Order met lines).

Voorbeeld payload

POST

webhook (order.created)

{
  "id": "a056V7R7NmNRjl70",
  "type": "order.created",
  "payload": {
    "number": "106073",
    "orderDate": "2025-08-10",
    "requestedReceiptDate": "2025-09-16",
    "shipToName": "ZuidWestHoek College",
    "shipToContact": "Erik Jansen",
    "shipToAddressLine1": "O Lv Vrouw ter Duinenln 201",
    "shipToAddressLine2": "",
    "shipToPostCode": "4641 RM",
    "shipToCity": "Ossendrecht",
    "lines": [
      {
        "sequence": 10000,
        "itemNo": "9789001022471",
        "description": "buiteNLand ed 5.0 havo/vwo 1 English edition FLEX boek + online",
        "quantity": 42
      }
    ]
  }
}