API Documentatie

API Documentatie GET /companies/:machineName

Toon gegevens voor een specifiek bedrijf.

Met een call naar dit endpoint ontvangt u de gegevens van een specifiek bedrijf.

Resource URL

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

Placeholder	Formaat	Omschrijving
:machineName	string `[\w_]+`	De identifier van het bedrijf. Zie `/companies` voor het verkrijgen van de beschikbare machine names.

Query parameters

Naam	Verplicht	Formaat	Standaard	Omschrijving
expand		bool	false	Zet deze op true om extra data zoals contact- en adresgegevens van de bedrijven te ontvangen.

Resultaat

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

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.