...
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
request | string | uuid | Referentienummer voor het versturen van de order | eacb81ef-c9d5-4bd8-a624-4088bee04b73 | V | Dit nummer wordt gebruikt door de event mediator van de Bestelomgeving leermiddelen om een logboek bij te houden van verzonden en ontvangen meldingen met betrekking tot een unieke aanvraag. |
purchase | string | string | Inkooporder-nummer van de Winkel | OW1234 | V | Waarde mag niet gewijzigd worden |
purchase OrderType | string | string | Optioneel veld om ordertypes te ondersteunen die bilateraal zijn afgesproken | VSO | O | In het voorbeeld staat VSO voor voor seizoensorder. |
contractId | string | string | Optionele unieke identifier van een contract tussen de leveranciers waarbinnen deze Order valt | 2022-12-v1 | O | Waarde mag niet gewijzigd worden. |
deliveryLocation | object | Address | Optioneel afleveradres waar de leermiddelenverkoper (bijvoorbeeld in welk magazijn) de folio leermiddelen geleverd wil hebben. | Zie object Address | O |
|
deliveryDate | string | date | De gewenste afleverdatum voor levering van de folio leermiddelen. | 2024-03-11 | O |
|
orderLines | array | Order Lines | Zie object OrderLines | V |
Anchor | ||||
---|---|---|---|---|
|
...
Object: OrderLines
Een OrderLine bevat een referentie naar het te bestellen product en het gewenste aantal.
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel | orderLineId | string | uuid | Referentienummer van de orderLine. | eacb81ef-c9d5-4bd8-a624-4088bee04b73V | Dit nummer wordt gebruikt in het OrderConfirmation bericht om naar de betreffende order-line te verwijzen. | ||||||||
purchase | string | string | Optioneel inkooporder-regelnummer van de Winkel | OW1234-2 | O | Waarde mag niet gewijzigd worden | ||||||||||||||
purchase OrderType | string | string | Optioneel veld om ordertypes te ondersteunen die bilateraal zijn afgesproken | VSO | O | In het voorbeeld staat VSO voor voor seizoensorder. | ||||||||||||||
productId | string | string | Referentie naar de Product-beschrijving in de Catalogue API van het Leermiddel | 871792713 | V | Een Order verwijst naar exact 1 Product-Beschrijving( Leermiddel- of Setbeschrijving) Waarde mag niet gewijzigd worden | ||||||||||||||
quantity | integer | integer | Aantal producten dat de Bestelomgeving leermiddelen wil inkopen. | 100 | V | Waarde mag niet gewijzigd worden. | contractId | string | string | Optionele unieke identifier van een contract tussen de leveranciers waarbinnen deze Order valt | 2022-12-v1 | O | Waarde mag niet gewijzigd worden. | deliveryLocation | object | Address | Optioneel afleveradres waar de leermiddelenverkoper (bijvoorbeeld in welk magazijn) de folio leermiddelen geleverd wil hebben. | Zie object Address | O |
|
deliveryDate | string | date | De gewenste afleverdatum voor levering van de folio leermiddelen. | 2024-03-11 | O |
|
Anchor | ||||
---|---|---|---|---|
|
...
Object Address
Alle adresgegevens zijn samengevoegd in een blok. Dit adres kan in Nederland en ook in het buitenland zijn.
...
Een Ordersysteem leermiddelen reageert op een OrderRequest bericht met een OrderConfirmation bevestigingsbericht. In dit bevestigingsbericht wordt de requestReferenceId die door de Bestelomgeving leermiddelen is aangemaakt opgenomen. In aanvulling hierop wordt optioneel de informatie uit de order (puchaseOrderId) en de OrderLines (product, aantal, purchaseOrderId en purchaseOrderLineId) ook bevestigd. Het Ordersysteem leermiddelen heeft de mogelijkheid om een eigen verkoopordernummer (salesOrderId en salesOrderLineId) toe te voegen aan de orderbevestiging. Dit verkoopnummer kan gebruikt worden door de Bestelomgeving leermiddelen in het geval van supportvragen over de orderbevestiging. Door een tijdstempel op te nemen kan dit bevestigingsbericht worden gezien als een formele afspraak tussen beide leveranciers.
Veld
Type
Format
Omschrijving
Voorbeeld
O/V
Vullingsregel
orderLineId
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel | |||||||
requestresponse | string | uuid | De referentie van de Bestelomgeving het Ordersysteem leermiddelen waarop voor dit bevestigingsbericht een antwoord is. | eacb81ef-c9d5-4bd8-a624-4088bee04b734088bee04b75 | V | Waarde mag niet gewijzigd worden. | |||||||
responsesales | string | uuidstring | De referentie Verkoopordernummer van het Ordersysteem leermiddelen voor dit bevestigingsbericht. | eacb81ef-c9d5-4bd8-a624-4088bee04b75 | V | OA678 | O | Waarde mag niet gewijzigd worden. | orderConfirmationLines | array | OrderConfirmationLine | Zie object OrderConfirmationLine | V |
object: OrderConfirmationLine
request | string | uuid |
De referentie van de Bestelomgeving leermiddelen waarop dit bevestigingsbericht een antwoord is. | eacb81ef-c9d5-4bd8-a624-4088bee04b73 | V | Waarde mag niet gewijzigd worden |
productId
string
string
Verwijzing naar de unieke identifier voor het product
871792713
0834
O
Optioneel kan de Aanbieder het productId echo-en
quantity
integer
integer
. |
O
Optioneel kan de Aanbieder het aantal echo-en
purchase | string | string | Inkoopordernummer van de Bestelomgeving leermiddelen | OW1234 | O |
Waarde mag niet gewijzigd worden
purchase
OrderLineId
string
string
Optioneel inkooporder-regelnummer van de Bestelomgeving leermiddelen
OW1234-2
O
Waarde mag niet gewijzigd worden
sales
OrderId
string
string
Verkoopordernummer van het Ordersysteem leermiddelen
OA678
O
Waarde mag niet gewijzigd worden
sales
OrderLineId
string
string
Optioneel verkooporder-regelnummer van de Ordersysteem leermiddelen
OA678-2
O
Optioneel kan de Aanbieder het purchaseOrderId echo-en. | ||||||
processed | string | datetime | Tijdstip waarop het OrderRequest bericht is verwerkt door het Ordersysteem leermiddelen. | 2017-07-21T17:32:28Z | V | Het tijdstip kan afwijken van het versturen van het bevestigingsbericht. Intentie is om aan te geven wanneer het bericht is verwerkt. |
orderStatus | string | ENUM | Een indicatie wat de status van verwerking van de OrderRequest is. | pending | V | Status pending wordt gecommuniceerd zodra de leverancier extra controles uit gaat voeren (bijvoorbeeld credit check). Een bevestigingsbericht wordt op termijn opgevolgd door een nieuw bevestigingsbericht met de status approved of declined. Indien declined, dan wordt de foutcode gespecificeerd in statusMessage. |
success | boolean | boolean | Indicatie of het Ordersysteem leermiddelen het bericht heeft kunnen verwerken | True | V | False indien het Ordersysteem leermiddelen niet akkoord is of er een fout is opgetreden. |
status | integer | ENUM | Status | 0 (=OK) | V | |
statusMessage | string | string | Toelichting op status | - | O | |
orderConfirmationLines | array | OrderConfirmationLine | Zie object OrderConfirmationLine | O |
Object:
Anchor | ||||
---|---|---|---|---|
|
Een OrderConfirmationLine stelt het Ordersysteem in staat om op het niveau van OrderLines terugkoppeling over de Order te geven. Zodoende kan het Bestelsysteem inzicht krijgen in om bijvoorbeeld welk product een Order is afgewezen.
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
sales | string | string | Optioneel verkooporder-regelnummer van de Ordersysteem leermiddelen | OA678-2 | O | Waarde mag niet gewijzigd worden |
purchase | string | string | Optioneel inkooporder-regelnummer van de Bestelomgeving leermiddelen | OW1234-2 | O | Optioneel kan de Aanbieder het purchaseOrderLineId echo-en |
productId | string | string | Verwijzing naar de unieke identifier voor het product | 871792713 | O | Optioneel kan de Aanbieder het productId echo-en |
quantity | integer | integer | Aantal producten dat de Bestelomgeving leermiddelen wil inkopen. | 100 | O | Optioneel kan de Aanbieder het aantal echo-en |
status | integer | ENUM | Status | 0 (=OK) | V | |
statusMessage | string | string | Toelichting op status | - | O |
...