LPL lists¶

GET Retrieve the active LPL lists, including participants, from PharmaPortal.

Users of PharmaPortal can retrieve the active LPL lists, including participants, from their own system via an API. This is a REST API with a single endpoint.

Access

Available to PharmaPortal licence holders only.

Endpoint¶

TestProduction

GET https://demo.pharma-portal.nl/api/leverancier-prijs-lijst/overzicht

GET https://www.pharma-portal.nl/api/leverancier-prijs-lijst/overzicht

Authentication¶

This API uses IP whitelisting and an API key for authentication and rate limiting. Send the header:

Header	Description
`x-portal-key`	The API key issued to your organisation.

Request¶

Requests are GET requests.

curl https://demo.pharma-portal.nl/api/leverancier-prijs-lijst/overzicht \
  -H "x-portal-key: <your-api-key>"

Response¶

Code	Meaning
`200`	Correct request.
`401`	Invalid authentication or HMAC.

Example of a response to a successful and correct request:

[
    {
        "id": 15,
        "titel": "Lijstnaam",
        "omschrijving": "Omschrijving",
        "isGepubliceerdInZAGIS": true, // or false
        "deelnemers": [67123, 67124, 67125], // PI Codes the list is visible to
        "prijzen": [
            {
                "zindexNummer": 12345678,
                "prijs": 123.45,
                "actiefVan": "YYYY-MM-DD",
                "actiefTot": "YYYY-MM-DD",
                "levering": "direct" // or "groothandel"
            },
            {
                "zindexNummer": 23456789,
                "prijs": 123.45,
                "actiefVan": "YYYY-MM-DD",
                "actiefTot": "YYYY-MM-DD",
                "levering": "groothandel" // or "direct"
            }
        ],
        "createdAt": "YYYY-MM-DD HH:mm:ss",
        "updatedAt": "YYYY-MM-DD HH:mm:ss"
    }
]

Fields¶

Field	Type	Description
`id`	integer	Unique ID of the list.
`titel`	string	Name of the list.
`omschrijving`	string	Description of the list.
`isGepubliceerdInZAGIS`	boolean	Whether the list is published in ZAGIS.
`deelnemers`	int[]	PI Codes the list is visible to.
`prijzen`	object[]	Prices per Z-Index number (see below).
`prijzen[].zindexNummer`	integer	Z-Index number of the item.
`prijzen[].prijs`	number	Price.
`prijzen[].actiefVan`	string	Date from which the price is active.
`prijzen[].actiefTot`	string	Date until which the price is active.
`prijzen[].levering`	string	`direct` or `groothandel`.
`createdAt`	string	Date and time of creation.
`updatedAt`	string	Date and time of last update.

Notes

Want to test your integration? Contact us in good time at info@zagis.nl. We will prepare test data for you and provide an API key.