API Documentatie

APIs

Documentatie

Aan de slag

Voor het verkrijgen van API toegang doorloopt u de volgende stappen:

Bemachtig een account op De Marie NV Platform
IB koppelt uw bedrijfsgegevens aan uw account.
IB activeert de API voor uw account.
U vraagt een API key aan.

API Documentatie PUT /order:orderId

Wijzig een bestelling.

Met een call naar dit endpoint wijzigt u de bestelling met het opgegeven orderId.

Resource URL

PUT https://nvdemarie.ib.nl/api/order/v1/order:orderId

Query parameters

dit endpoint heeft geen query parameters.

Resultaat

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

Veld	Datatype	Omschrijving
code	int	De status code.
message	string	Algemene foutmelding
messages	array	Een JSON-array met specifieke foutmeldingen.

Bij een 200 OK HTTP-status bevat de response body een Order object met de gewijzigde bestelling. Zie /:orderId voor specificaties.

Request body

De request body moet een Order bevatten. Alle eigenschappen van het Order object zijn optioneel, maar er moet minimaal één eigenschap aanwezig zijn.

Order (PUT Request)

Veld	Datatype	Omschrijving
status	string	Geeft de status aan van de order binnen het systeem van IB. De volgende codes kunnen voorkomen: complete Het bestelproces is volledig doorlopen.
orderId	string	Bestelnummer van deze bestelling. De opgegeven waarde overschrijft het bestaande bestelnummer.
email	string	Het e-mailadres voor communicatie met betrekking tot deze bestelling.
deliveryMethod	string	Code voor de wijze van levering. De volgende codes kunnen voorkomen: collect De bestelling wordt opgehaald. address De bestelling moet worden geleverd op het verzendadres.
deliveryAddress	`UserAddress`\|null	Het afleveradres voor deze bestelling. Indien er geen verzendmethode is gekozen vaarvoor een verzendadres is vereist, dat kan deliveryAddress null zijn. Wanneer purchaserGln is opgegeven mag deliveryAddress null zijn of weggelaten worden.
invoiceAddress	`UserAddress`	Het factuuradres voor deze bestelling.
cart	`Cart`	Het winkelwagentje behorende bij deze bestelling.
supplierSpecificInformation	array	Bevat informatie uit extra formulieren die als maatwerk voor een specifieke leverancier zijn opgenomen in het bestelproces. Specifiecaties voor de informatie in dit veld zijn op aavraag
orderDate	datum	De datum van het plaatsen van de bestelling.
orderStatus	`OrderStatus`	Een object met de status van iedere bestelbare regel in deze bestelling.

UserAddress (PUT Request)

De verplichte velden die hieronder zijn aangegeven zijn die van de standaard implementatie. Welke velden verplicht zijn kunnen afwijken per webshop. Raadpleeg de foutmeldingen van de API door een PUT request te doen met een leeg adres om te zien welke velden verplicht zijn, of Neem contact op met IB.

Veld	Datatype	Omschrijving
id	string	Een id voor dit adres.
title	string	De manier waarop deze persoon aangesproken dient te worden: Dhr. Mevr.
firstName	string	Voornaam.
middleName	string	Tussenvoegsels.
lastName	string	Achternaam.
companyName	string	Bedrijfsnaam.
street	string	Straatnaam.
houseNumber	int	Huisnummer.
houseNumberSuffix	string	Toevoeging huisnummer.
postalcode	string	Postcode. Let op: Dit kan ook een buitenlandse postcode zijn.
city	string	Plaats.
country	string	Twee-letterige landscode volgens de ISO 3166-1 standaard.

Cart (PUT Request)

Let op! U kunt via de API de cart niet wijzigen, maar alleen in zijn geheel vervangen door een nieuw Cart object. Hiervoor moet u de ibCode weten van ieder artikel in de cart. U kunt dus de cart alleen wijzigen als uw overeenkomst met IB toestaat ibCodes te gebruiken.

Let op! Wanneer u een nieuw Cart object toevoegd aan de bestelling krijgen alle regels in de cart een nieuw uuid en is er geen koppeling meer tussen cart en orderStatus. Hierdoor wordt de bestaande orderStatus ongeldig en zal deze via een apart request opnieuw ingesteld moeten worden.

Veld	Verplicht	Datatype	Omschrijving
lineItems		array	Een JSON-array met `lineItem` objecten. Deze bevat alle producten van de bestelling.

LineItem (PUT Request)

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. Dit veld is verplicht wanneer eanCode leeg is.
eanCode	string	De EAN code voor dit product en besteleenheid. Dit veld is verplicht wanneer ibCode leeg is.
orderUnitKey	string	De sleutel die door het systeem van IB gebruikt wordt om de besteleenheid aan te geven. Deze sleutel kan u door de data-afdeling van IB worden aangeleverd. U kunt ook de waarden `default` of `smallest` gebruiken om respectievelijk de standaard of de kleinste besteleenheid te gebruiken.
supplierGln	string	De GLN code van de leverancier. Dit veld is verplicht wanneer ibCode leeg is.
quantity	decimal	Het gewenste aantal besteleenheden voor dit artikel.

OrderStatus (PUT Request)

Let op! U kunt via de API de orderStatus niet wijzigen, maar alleen in zijn geheel vervangen door een nieuw OrderStatus object.

Veld	Verplicht	Datatype	Omschrijving
statusItems		array	Een JSON-array met `LineStatus` objecten.

LineStatus (PUT Request)

Veld	Datatype	Omschrijving
lineItemId	string	Het ID van de regel waaraan deze status gekoppeld is.
lineItemType	string	Het type regel regel waaraan deze status gekoppeld is. lineItem additionalLineItem Alleen regels van het type 'orderable' kunnen een status hebben.
statusItems	array	Een JSON-array met `LineStatusItem` objecten.

LineStatusItem (PUT Request)

Veld	Datatype	Omschrijving
quantity	decimal	Het aantal waarvoor deze status geldt. Het totaal aantal van de `LineStatusItem`s moet gelijk zijn aan het aantal van de orderregel.
statusCode	string	De status code. De volgende codes kunnen voorkomen: initial Bestelling ontvangen processing Wordt verwerkt notOnStock Niet op voorraad endOfLife Niet meer leverbaar onStock Op voorraad onOrder In bestelling ready Klaar voor verzending shipped Verzonden canceled Geannuleerd onHold Tijdelijk opgeschort other Overig partially Gedeeltelijk
statusInfo	object	Een JSON-object met key-value pairs. Dit object bevat extra informatie over de status van deze order. De volgende keys kunnen voorkomen: shippingDate (datum 'dd-mm-yyyy') Verzenddatum trackingNumber (string) Tracking nummer trackingUrl (url) Tracking URL forwarder (string) Transporteur remarks (string) Opmerkingen