ZAGIS Price API¶

POST Request the applicable price for a specific product.

Users of ZAGIS can request the applicable price for a specific product from their own system via an API. This price API is a REST API with a single endpoint and one possible action.

Access

Available to ZAGIS users only.

Endpoint¶

TestProduction

POST https://demo.zagis.nl/api/zagis/prijsCheck

POST https://www.zagis.nl/api/zagis/prijsCheck

Authentication¶

This API uses:

IP whitelisting for security
An API key for authentication & rate limiting
HMAC for integrity checking

Send the following headers:

Header	Description
`x-zagis-key`	The API key issued to your organisation.
`x-zagis-hmac`	Hexadecimally encoded SHA-512 HMAC of the request body.

Request¶

Requests are POST requests with a JSON payload:

{
    "zindexNummer": 12345678, // The Z-Index number of the article to check
    "route": "direct", // 'direct' or 'groothandel'
    "datum": "01-01-2018" // Date in Dutch notation for which the applicable price is determined
}

curl -X POST https://demo.zagis.nl/api/zagis/prijsCheck \
  -H "x-zagis-key: <your-api-key>" \
  -H "x-zagis-hmac: <hmac>" \
  -d '{"zindexNummer": 12345678, "route": "direct", "datum": "01-01-2018"}'

Response¶

Code	Meaning
`200`	Correct request.

Example of a response to a successful & correct request:

{
    "result" : "success",   // 'success' or 'error'
    "errorMessage" : "",    // Error message on failure
    "errorCode" : 0,        // Error code on failure
    "zindexNummer" : "12345678", // The checked Z-Index number
    "route" : "direct", // The checked delivery method
    "datum" : "01-01-2018", // The checked date
    "soortPrijs" : "aip", // aip, gip or contract
    "basisPrijsVerpakking" : 0, // Base price excl. VAT per package
    "toeslagenVerpakking" : 0, // Total surcharges per package
    "btwBedrag" : 0, // VAT per package
    "btwPercentage" : 0, // Applicable VAT percentage on purchase
    "totaalPrijsVerpakkingExBtw" : 0, // Total price excl. VAT per package
    "totaalPrijsVerpakkingIncBtw" : 0, // Total price incl. VAT per package
    "verpakkingsHoeveelheid" : 0, // Number of counting units (tablets/ampoules/vials etc) per package
    "aantalBasiseenheden" : 0, // Number of base units (tablets/millilitres/units) per package
    "contractPartij" : "", // Supplier name of the article (Contract party for contract, "Groothandel" for GIP, Registration holder for AIP)
    "contractPartijNaam" : "", // Supplier name of the article (Contract party for contract, "Groothandel" for GIP, Registration holder for AIP)
    "contractPartijNummer" : "", // G-Standaard NAW number of the article (Contract party for contract, empty for GIP, Registration holder for AIP)
    "artikelIsActief" : false, // Is the article active in the G-Standaard
    "artikelUnKode" : "", // UN code from the G-Standaard for a discontinued article
    "artikelUnDatum" : "", // Date on which the UN code takes effect for a discontinued article
    "ziekenhuis" : "" // Name of the hospital
}

Example of a response to a substantively invalid request:

{
    "result": "error",
    "errorMessage": "Onbekend Z-Index nummer",
    "errorCode": 2
}

Fields¶

Field	Type	Description
`result`	string	`success` or `error`.
`errorMessage`	string	Error message on failure.
`errorCode`	integer	Error code on failure.
`zindexNummer`	string	The checked Z-Index number.
`route`	string	The checked delivery method.
`datum`	string	The checked date.
`soortPrijs`	string	`aip`, `gip` or `contract`.
`basisPrijsVerpakking`	number	Base price excl. VAT per package.
`toeslagenVerpakking`	number	Total surcharges per package.
`btwBedrag`	number	VAT per package.
`btwPercentage`	number	Applicable VAT percentage on purchase.
`totaalPrijsVerpakkingExBtw`	number	Total price excl. VAT per package.
`totaalPrijsVerpakkingIncBtw`	number	Total price incl. VAT per package.
`verpakkingsHoeveelheid`	number	Number of counting units (tablets/ampoules/vials etc) per package.
`aantalBasiseenheden`	number	Number of base units (tablets/millilitres/units) per package.
`contractPartij`	string	Supplier name of the article (Contract party for contract, "Groothandel" for GIP, Registration holder for AIP).
`contractPartijNaam`	string	Supplier name of the article (Contract party for contract, "Groothandel" for GIP, Registration holder for AIP).
`contractPartijNummer`	string	G-Standaard NAW number of the article (Contract party for contract, empty for GIP, Registration holder for AIP).
`artikelIsActief`	boolean	Is the article active in the G-Standaard.
`artikelUnKode`	string	UN code from the G-Standaard for a discontinued article.
`artikelUnDatum`	string	Date on which the UN code takes effect for a discontinued article.
`ziekenhuis`	string	Name of the hospital.

Notes

ZAGIS maintains separate price agreements for delivery via wholesaler and direct delivery. The requesting system must determine per request which price is being requested.

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