API Documentatie

API Documentatie GET /companies/:machineName/articles/:key

Toon artikelinformatie voor een specifiek artikel.

Het resultaat van dit endpoint is vergelijkbaar met de gegevens die u terug krijgt bij /companies/:machineName/articles, alleen kunt u dit endpoint gebruiken indien u artikelgegevens voor één specifiek artikel wenst op te halen.

Resource URL

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

Placeholder	Formaat	Omschrijving
:machineName	string `[\w_]+`	De identifier van het bedrijf dat het artikel levert. Zie `/companies` voor het verkrijgen van de beschikbare machine names.
:key	int\|string	Het id van het artikel. Bevoegde gebruikers mogen hier de IB-code of hun eigen artikelcode gebruiken. (Zie hiervoor de `match` query parameter.)

Query parameters

Naam	Verplicht	Formaat	Standaard	Omschrijving
expand		bool	false	Zet deze op `true` om de meest volledige artikelinformatie te krijgen. Gebruikt u de extra informatie niet? Dat kunt u deze boolean beter op `false` laten staan om zo de snelheid van de API te vergroten en bandbreedte te besparen.
match		string `guess\|key\|ibcode\|custom`	`guess`	Zet deze op `custom` indien u in `:key` uw eigen artikelcode opgeeft of op `ibcode` om artikelgegevens op basis van de IB-Code op te halen. Standaard probeert de API zelf een inschatting te maken.

Resultaat

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

Veld	Datatype	Omschrijving
ibCode	long	De door IB gehanteerde identifier voor dit specifieke artikel. Let op: Afhankelijk van uw overeenkomst met IB is dit veld wel of niet zichtbaar.
matchCode	string\|null	Uw eigen unieke artikelcode voor dit artikel. Indien onbekend is deze null.
parentIbCode	long	In geval van een handelsartikel staat hier de IB code van het artikel in het assortiment van de fabrikant. Let op: Afhankelijk van uw overeenkomst met IB is dit veld wel of niet zichtbaar.
productIbCode	long	In geval dat dit artikel onderdeel is van een product staat hier de IB code van dat product.
articleId	string	Het door de leverancier gehanteerde artikelnummer voor dit artikel.
description	string	De omschrijving van dit artikel.
extendedInfo	string	Uitgebreide artikelomschrijving. Deze kan meerdere regels omvatten.
availability	string	Beschikbaarheidscode van het artikel. De volgende codes kunnen voorkomen: 85E (Actueel) Dit artikel is leverbaar. 91E (Uitlopend) Dit artikel wordt binnenkort uit het assortiment verwijderd. 92E (Vervallen) Dit artikel is in dit assortiment niet meer beschikbaar.
modified	datum	Datum van de meest recente wijziging in de gegevens van dit artikel. 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 niet is bijgewerkt.
supplier	`Company`	Json-object met leveranciersgegevens.
manufacturer	`Company`	Json-object met fabrikantsgegevens.
units	array	Json-array van `TradeUnit` objecten. Bevat een opsomming van beschikbare verpakkingen en/of handelseenheden voor dit artikel. Verpakkingen worden altijd in een veelvoud van een kleinere verpekking omschreven.
unitRoles	array	Json-array van `TradeUnit` objecten. Bevat een opsomming van beschikbare verpakkingen en/of handelseenheden voor dit artikel. Verpakkingen worden altijd in een veelvoud van een kleinere verpekking omschreven.
images	array	Json-array van `Image` objecten. Bevat een opsomming van beschikbare afbeeldingen bij dit artikel.
documents	array	Json-array van `Document` objecten. Bevat een opsomming van beschikbare downloadbare documenten bij dit artikel.
properties	object	Bevat een opsomming van artikeleigenschappen in de vorm van een json-object met `Property` objecten gekeyed op naam.
availability_label	string	Beschikbaarheid van het artikel.
prices	array	Json-array van `Price` objecten. Bevat een lijst van beschikbare prijzen voor het artikel.
classification	array	Json-array van de `classificatie` van dit artikel. Bevat de classificatiecodes van verschillende classificatiebomen waartoe dit artikel behoort.
id	string	Unieke sleutel waarmee u in de API gegevens voor dit artikel kunt ophalen.
siteLink	url	URL naar de bijbehorende webpagina met artikelgegevens.
href	url	URL naar de API resource met de volledige informatie voor dit artikel.
parent

TradeUnit

Veld	Datatype	Omschrijving
unitLabel	string	Samenvoeging van aantal en eenheid waaruit de handelseenheid bestaat. (In geval van een doos van 50 stuks is deze waarde "50 st")
eanCode	string\|null	Door GS1 uitgegeven EAN code. Dit kan een code volgens het EAN-12, EAN-13 of EAN-14 formaat zijn.
unitAmount	decimal	Aantal deeleenheden in de handelseenheid. (In geval van een doos van 50 stuks is deze waarde "50")
packageName	string	Naam van de handelseenheid. (In geval van een doos van 50 stuks is deze waarde "doos")
unitName	string	Verwijzing naar een kleinere eenheid waaruit deze handelseenheid is opgebouwd. (In geval van een doos van 50 stuks is deze waarde "st")
orderable	bool	Geeft aan of deze eenheid als verpakking bestelbaar is. Niet bestelbare eenheden kunnen enkel als rekeneenheid voor prijzen en/of calculaties worden gebruikt.

Image

Veld	Datatype	Omschrijving
fileName	string	Originele bestandsnaam.
mimeType	string	Bestandsformaat aanduiding volgens het MIME formaat van de Internet Assigned Numbers Authority.
fileSize	int	Bestandsgrootte in bytes.
width	int	Breedte van de afbeelding in pixels.
height	int	Hoogte van de afbeelding in pixels.
download	url	Locatie waarop gemachtigde gebruikers de afbeelding kunnen downloaden.
thumb	url	Locatie van een thumbnail van de afbeelding. Deze heeft een resolutie van 100 x 100 pixels.
summary	string\|null	Omschrijving van de afbeelding.

Document

Veld	Datatype	Omschrijving
fileName	string	Originele bestandsnaam.
mimeType	string	Bestandsformaat aanduiding volgens het MIME formaat van de Internet Assigned Numbers Authority.
fileSize	int	Bestandsgrootte in bytes.
download	url	Locatie waarop gemachtigde gebruikers het document kunnen downloaden.
summary	string\|null	Omschrijving van het document.

Property

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.
value	string	De waarde van de eigenschap. Bij de eigenschap "Kleur" zou deze waarde bijv. "Blauw" kunnen zijn. Indien een eigenschap meerdere waarden bevat worden deze met een "\|"-symbool (pipe) gescheiden.

Price

Veld	Datatype	Omschrijving
priceUnitQuantity	decimal	Aantal eenheden in een prijseenheid. (Bij € 1,00 per 5 m2 is deze waarde "5").
priceUnitDescription	string	Naam van de prijseenheid. (Bij € 1,00 per 5 m2 is deze waarde "m2").
priceUnitLabel	string	Vervallen: Gebruik `priceUnitDescription` in plaats van dit gegeven. Dit veld komt per 1-1-2018 te vervallen.
price	decimal	De prijs per prijseenheid in euros. (Bij € 1,00 per 5 m2 is deze waarde "1").
startDate	datum\|null	Ingangsdatum voor deze prijs indien beschikbaar.
endDate	datum\|null	Einddatum voor deze prijs indien beschikbaar.
moq	decimal\|null	Aantal in de staffelondergrens. (Bij € 1,00 per 5 m2 vanaf 2 pallets is deze waarde "2")
moqUnit	string\|null	Staffeleenheid (Bij € 1,00 per 5 m2 vanaf 2 pallets is deze waarde "pallet")
label	string	Naam van het prijstype. Bijvoorbeeld Brutoprijs of Consumentenadviesprijs.
reference	string\|null	Uw referentie bij de prijs. Bijvoorbeeld het contractnummer waar de prijs van afkomstig is.
type	string	Sleutel van het prijstype.
companySpecific	bool	Boolean waarde die aangeeft of deze prijs gebonden is aan de afnemer.
active	bool	Boolean waarde die aangeeft of de huidige datum tussen de start en de einddatum valt.
summary	string	Leesbare tekst waarin de bovenstaande gegevens samengevoegd worden weergegeven.