API Documentatie

API Documentatie GET /properties

Toon een lijst van alle beschikbare producteigenschappen.

Met een call naar dit endpoint krijgt u een lijst van alle beschikbare producteigenschappen die u kunt verwachten bij een product.

GET https://www.ib.nl/api/bulk/v1/properties

Naam	Verplicht	Formaat	Standaard	Omschrijving
offset		int	0	Gebruik deze query-parameter voor pagination.
limit		int	100	Deze query-parameter beperkt het aantal resultaten per response. Let op: De maximale waarde is 100.

Bij een 200 OK HTTP-status bevat de response body het volgende JSON object:

Veld	Datatype	Omschrijving
offset	int `0<=n`	Deze hoeveelheid aan resultaten zijn vanaf het begin overgeslagen. Indien er een offset query parameter is opgegeven zal deze waarde gelijk zijn aan de opgegeven waarde. De waarde kan echter niet negatief zijn.
offsetId	string\|null	De identifier van de huidige resultatenset, deze zal alleen gevuld zijn als in de request gekozen is voor het ophalen van de artikelen op basis van een offsetId.
nextOffsetId	string	De identifier van de volgende resultatenset. Deze kan men gebruiken in de query-parameter `offset-id` om de volgende set aan artikelen op te halen.
limit	int `1<=n<=100`	Geeft aan hoeveel resultaten er maximaal worden getoond. Indien er een limit query parameter is opgegeven zal deze waarde gelijk zijn aan de opgegeven waarde. De waarde is echter minimaal 1 en maximaal 100.
count	int `0<=n`	Het aantal items dat in totaal beschikbaar is over alle paginas.
changesSince	date	Geeft de datum weer die is opgegeven in de query-parameter `modified`, als deze niet is ingevuld zal dit veld `null` tonen.
items	array	Json-array van `Properties` objecten. Afhankelijk van de waarde van expand worden hierin enkel de basisvelden of alle velden getoond.
href	url	De URL naar de huidige pagina in de paginering.
next	url	De volledige URL naar de volgende pagina in de paginering of null als dit de laatste pagina is.
previous	url	De volledige URL naar de vorige pagina in de paginering of null als dit de eerste pagina is.

Veld	Datatype	Omschrijving
label	string	De leesbare naam van de eigenschap, bijv. "Kleur".
name	string `[\w_]+`	Een identifier voor de eigenschap bestaande uit kleine letters en underscores.
isList	boolean	Geeft aan dat het value veld een lijst met meerdere waardes kan bevatten, gescheiden door een "\|"-symbool (pipe)
groupLabel	string	Geeft aan binnen welke groep deze eigenschap valt.