API Documentatie

API Documentatie GET /companies

Toon een lijst van alle bedrijven.

Met een call naar dit endpoint krijgt u een lijst van alle bedrijven die artikelgegevens aanbieden via IB. Tussen de informatie staat onderandere de machineName van het bedrijf welke u als identifier kunt gebruiken voor verdere calls.

Resource URL

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

Query parameters

Naam	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.
expand	bool	false	Zet deze op true om extra data zoals contact- en adresgegevens van de bedrijven te ontvangen.
modified	date	false	Indien u hier een datum opgeeft worden enkel de bedrijven getoond waarvan de bedrijfsgegevens sinds deze datum zijn gewijzigd. Het formaat kan gegeven worden als "YYYY-MM-DD" of als datum/tijd in het ISO 8601 formaat.
last-article-update	date	false	Indien u hier een datum opgeeft worden enkel de bedrijven getoond met artikelen waarvan de gegevens sinds deze datum zijn gewijzigd. Het formaat kan gegeven worden als "YYYY-MM-DD" of als datum/tijd in het ISO 8601 formaat. Let op: Deze functionaliteit biedt geen garantie dat er ook daadwerkelijk wijzigingen hebben plaatsgevonden.

Resultaat

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.
expanded	bool `true\|false`	Boolean waarde. Als deze false is worden enkel de basisvelden weergegeven, bij true wordt de volledige informatie getoond.
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 `Company` 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.

Company

Veld	Datatype	Omschrijving
id	string `[\w_]+`	De 'machine readable name' van het bedrijf. Deze naam wordt gebruikt voor de identificatie van het bedrijf.
name	string	Volledige bedrijfsnaam.
kvkNr	string\|null	KvK-nummer van het bedrijf.
email	string	Algemeen e-mailadres van het bedrijf.
website	url	URL naar de website van het bedrijf.
phoneNr	string	Algemeen telefoonnummer van het bedrijf.
faxNr	string	Algemeen faxnummer van het bedrijf.
modified	datum	Datum van laatste wijziging van de gegevens van dit bedrijf. Let op: Artikelupdates in het assortiment van dit bedrijf hebben geen invloed op deze datum.
articleCount		Aantal artikelen in het assortiment van dit bedrijf Let op: Soms bieden bedrijven aan specifieke afnemers extra artikelen aan. Hierdoor kan het voorkomen dat u tot minder artikelen toegang heeft als deze teller aan geeft.
lastArticleUpdate	datum	Datum van de meest recente artikelwijziging in dit assortiment. Let op: Wijzigingen kunnen zich ook voordoen in een deel van de gegevens die niet via de API inzichtelijk zijn. Een update in de wijzigingsdatum betekend dus niet per definitie dat er voor u gegevens zijn gewijzigd. Andersom kunt u er wel vanuit gaan dat er geen wijzigingen zijn zolang deze datum is bijgewerkt.
addresses	array	Json-array van `CompanyAddress` objecten.
href	url	URL naar de API resource met de volledige informatie voor dit bedrijf.
hrefArticles	url	URL naar de API resource met de artikelen in het assortiment van dit bedrijf.
siteLink	url	URL naar de bijbehorende webpagina met bedrijfsgegevens.
logo	url	URL naar een Jpeg- of PNG-afbeelding van het logo van dit bedrijf. Bij een eventuele wijziging van het bedrijfslogo wijzigd deze url gegarandeerd.
articlesLink	url	URL naar een pagina met zoekresultaten waarop enkel artikelen getoond worden die door dit bedrijf geleverd worden.

CompanyAddress

Veld	Datatype	Omschrijving
street	string	Straatnaam.
nr	string	Nummer inclusief eventuele toevoeging.
postalcode	string	Postcode. Let op: Dit kan ook een buitenlandse postcode zijn.
location	string	Plaatsnaam.
country	string	Twee-letterige landscode volgens de ISO 3166-1 standaard.
longitude	decimal	Oostelijke coördinaten worden met positieve en westelijke coördinaten worden met negatieve getallen weergegeven. Zie ook Decimal Degrees op Wikipedia.
latitude	decimal	Noordelijke coördinaten worden met positieve en zuidelijke coördinaten worden met negatieve getallen weergegeven. Zie ook Decimal Degrees op Wikipedia.