Skip to content

API Documentatie POST /order

Voeg een nieuwe bestelling toe.

Met een call naar dit endpoint voegt u een nieuwe bestelling toe.

Resource URL

POST https://www.ib.nl/api/order/v1/order

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 is een Order object.

Order (POST Request)

Veld Verplicht 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. Indien deze wordt weggelaten wordt er automatisch een bestelnummer gegenereerd.
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.
Wanneer purchaserGln is opgegeven mag invoiceAddress null zijn of weggelaten worden.
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.

UserAddress (POST 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 POST request te doen met een leeg adres om te zien welke velden verplicht zijn, of Neem contact op met IB.

Veld Verplicht 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 (POST Request)

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

LineItem (POST Request)

Veld Verplicht 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.