Skip to content

API Documentatie GET /order:orderId

Toon een specifieke bestelling.

Met een call naar dit endpoint krijgt de bestelling behorende bij het opgegeven ID.

Resource URL

GET https://www.ib.nl/api/order/v1/order:orderId

Query parameters

Dit endpoint heeft geen query parameters.

Resultaat

Bij een 200 OK HTTP-status bevat de response body een Order object.

Order

Veld Datatype Omschrijving
id string Een unieke id voor deze order.
orderId string Een orderid met een opvolgend nummer voor iedere bestelling. Het is mogelijk dat in speciefieke gevallen er ook letters aanwezig zijn in het orderId.
status string Geeft de status aan van de order binnen het systeem van IB. De volgende codes kunnen voorkomen:
  • incomplete Het bestelproces is niet volledig doorlopen.
  • complete Het bestelproces is volledig doorlopen.
  • deleted Deze besteling is verwijderd.
orderId string Bestelnummer van deze bestelling.
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

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

Veld Datatype Omschrijving
total decimal Het totaalbedrag van de bestelling.
totalIsComplete boolean Waar wanneer alle items in de cart een prijs hebben, anders onwaar.
lineItems array Een JSON-array met lineItem objecten. Deze bevat alle producten van de bestelling.
additionalLineItems array Een JSON-array met additionalLineItem objecten. Deze bevat overige posten met betrekking tot deze bestelling. Zoals onder andere: Orderkosten, toeslagen en BTW. Maar ook eventuele extra services behorende bij producten zoals bijvoorbeeld het op maat zagen van een product of het toevoegen van een opdruk.

LineItem

Veld Datatype Omschrijving
uuid string Uniek ID voor deze orderregel.
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.
eanCode string De EAN code voor dit product en besteleenheid.
description string Een korte omschrijving van het artikel.
orderUnitKey string De sleutel die door het systeem van IB gebruikt wordt om de besteleenheid aan te geven.
orderUnitDescription string De besteleenheid.
orderUnitPrice decimal Prijs per besteleenheid.
articleId string|null Een leveranciers- of klantspecifieke artikel code. Let op: Afhankelijk van uw overeenkomst met IB is dit veld wel of niet zichtbaar.
articleUrl string Het artikel-specifieke deel van de url voor dit artikel. Maak deze url af door er 'https://www.ib.nl/article/' voor te plaatsen.
supplierId string Het ID van de leverancier.
supplierLabel string De naam van de leverancier.
supplierGln string De GLN code van de leverancier.
manufacturerLabel string De naam van de fabrikant.
quantity decimal Het gewenste aantal besteleenheden voor dit artikel.
lineTotal decimal Regeltotaal.

AdditionalLineItem

Veld Datatype Omschrijving
uuid string Uniek ID voor deze regel.
type string Het type voor deze regel.
  • orderable Deze regel bevat een bestelbaar item.
  • linked Deze regel is gekoppeld aan een lineItem met een uuid gelijk aan het parentId van deze regel.
  • costs Deze regel bevat kosten, zoals verzenkosten of orderkosten.
  • vat Deze regel bevat de BTW van deze bestelling.
itemKey string Verdere specificatie van wat deze regel is. itemKey vormt in combinatie met type een unieke code binnen deze order.
description string De omschrijving van deze regel.
supplierId string|null Het ID van de leverancier indien van toepassing.
supplierLabel string|null De naam van de leverancier indien van toepassing.
price decimal De prijs voor deze regel.
quantity int Het aantal.
parentId string|null Het ID van de lineItem waaraan deze regel is gekoppeld. Geldt alleen voor het type 'linked'
lineTotal decimal Het totaal van deze regel.

OrderStatus

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

LineStatus

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.
lineItemQuantity decimal Het aantal van de regel waaraan deze status gekoppeld is. Deze moet gelijk zijn aan lineItem.quantity of additionalLineItem.quantity afhankelijk van het type.
statusItems array Een JSON-array met LineStatusItem objecten.

LineStatusItem

Veld Datatype Omschrijving
quantity decimal Het aantal waarvoor deze status geldt. Het totaal aantal van de LineStatusItems 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