Lists

Lists are at the core of Studiewinkel. What learning materials are to be used for what course of a learning institution — they are the basic building blocks of your eCommerce offering with your customers. On this page, we'll dive into the different lists endpoints you can use to manage lists programmatically.

The list model

The list model contains all the information about the lists and learning materials used in courses at schools.

Properties

Name
slug
Type
string
Description
A unique quick code for the list. Distributed by marketing, schools, notification flows, ... to enable deeplinks, qr codes, ...
Name
breadcrumb
Type
array of string
Description
Defines the hiërarchical structure or position for this list in the collection of lists for the school
Name
name
Type
string
Description
The name for this list as given by the school.
Name
comment
Type
string
Description
The comment added to the list by the school
Name
school
Type
object
Description
The school this list belongs to.
Name
schoolYear
Type
integer
Description
DEPRECATED: The schoolyear the list is for. We use 2023 for schoolyear 2023-2024
Name
duoCode
Type
integer
Description
DUO code for the list
Name
comment
Type
string
Description
General remarks on this list
Name
status
Type
enum
Description
The status of the list. Valid values: concept, validated, published
Name
imported
Type
boolean
Description
Indicates whether a list was imported from an external source

GET/lml/v1/lists

Retrieve lists

This endpoint allows you to retrieve lists.

All lists are returned except ones with status ARCHIVED

Request

GET

/lml/v1/lists

curl -G https://lml-api.studiewinkel.nl/api/lml/v1/lists \
  -H "Authorization: Bearer {token}"

Response

[{
    "slug": "xJVox12l",
    "name": "Commerciële Economie Associate degree duaal/deeltijd",
    "status": "PUBLISHED",
    "imported": false,
    "breadcrumb": [
        "NHL Stenden Hogeschool",
        "Emmen",
        "2022-2023",
        "Academie Primair Onderwijs NHL Stenden",
        "Commerciële Economie Associate degree duaal/deeltijd"
    ]
}]

GET/lml/v1/lists/:slug

Retrieve a list

This endpoint allows you to retrieve a list by providing the list slug. Refer to the list at the top of this page to see which properties are included with list objects.

If the status of the list does not equal published a shortened version will be returned containing fields to enable a 'notify when available' workflow. Providing a valid previewToken WILL return the complete list. Be aware that no orders should be placed on this list.

Optional attributes

Name
include
Type
csv
Description
Include related models (school, items, breadcrumb)
Name
previewToken
Type
string
Description
Allows previewing of non published lists.

Request

GET

/lml/v1/lists/:slug

curl -G https://lml-api.studiewinkel.nl/api/lml/v1/lists/xJVox12l \
  -H "Authorization: Bearer {token}" \
  -d include=school,items,breadcrumb

Response

{
    "slug": "xJVox12l",
    "name": "Commerciële Economie Associate degree duaal/deeltijd",
    "comment": "You may have ordered several items in previous years",
    "schoolYear": "DEPRECATED",
    "status": "PUBLISHED",
    "imported": false,
    "duoCode": 1234,
    "school": {
        "name": "NHL Stenden Hogeschool",
        "duoCode: 'xxx',
    },
    "subjects": [
        {
            "name": "Algemeen",
            "comment": "comment hier",
            "listItems": [
                {
                    "type": "PRODUCT",
                    "name": "De overkappingsprothese op natuurlijke pijlerelementen en implantaten",
                    "comment": null,
                    "mandatory": true,
                    "recommended": false,
                    "deeplink": "https://www.studiewinkel.nl",
                    "allowDigitalAlternative": true,
                    "allowPrintAlternative": false,
                    "catalogItem": {
                        "catalog": {
                            "name": "CB"
                        },
                        "ean": "9789031311521",
                        "title": "De overkappingsprothese op natuurlijke pijlerelementen en implantaten",
                        "subTitle": "diagnostiek en behandeling",
                        "description": "Dit boek beschrijft de uitgangspunten bij de diagnostiek en behandeling van de pre-edentate patiënt en van de langdurig edentate patiënt. Er wordt aandacht besteed aan de toepassing van overkappingsprothesen op natuurlijke elementen alsook op implantaten, waarbij de klinische en tandtechnische procedures ruimschoots aan bod komen. De nadruk ligt vooral op de vraag waarom een bepaalde methodiek wordt toegepast. De vele klinische afbeeldingen maken De overkappingsprothese tot een heldere en overzichtelijke uitgave.",
                        "coverUrl": "https://cbonline.boekhuis.nl/pls/cover/p_get_cover_fe?p_hash=AC4EADC457B722DA13DD9E5D997B0FD0",
                        "language": {
                            "id": "nl",
                            "cbId": "dut",
                            "name": "Nederlands"
                        },
                        "edition": 1,
                        "publishingDate": "1994-06-30T22:00:00.000Z",
                        "pages": 272,
                        "publisher": {
                            "name": "Springer Media B.V."
                        },
                        "referencePrint": null,
                        "referenceDigital": "978123456782,
                    }
                },
                {
                   ...
                }
            ]
        }
    ],
    "breadcrumb": [
        "NHL Stenden Hogeschool",
        "Emmen",
        "2022-2023",
        "Academie Primair Onderwijs NHL Stenden",
        "Commerciële Economie Associate degree duaal/deeltijd"
    ]
}