...
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 | Specificatie van de producten die de Bestelomgeving wil bestellen. | Zie object OrderLines | V |
Anchor | ||||
---|---|---|---|---|
|
Een OrderLine bevat een referentie naar het te bestellen product en het gewenste aantal.
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
purchase | string | string | Optioneel inkooporder-regelnummer van de Winkel | OW1234-2 | O | Waarde mag niet gewijzigd worden |
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. |
Anchor | ||||
---|---|---|---|---|
|
...
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel | |||||||
response | string | uuid | De referentie van het Ordersysteem leermiddelen voor dit bevestigingsbericht. | eacb81ef-c9d5-4bd8-a624-4088bee04b75 | V | Waarde mag niet gewijzigd worden. | sales | string | string | Verkoopordernummer van het Ordersysteem leermiddelen | OA678 | O | Waarde mag niet gewijzigd worden. |
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. | |||||||
sales | string | string | Verkoopordernummer van het Ordersysteem leermiddelen | OA678 | O | Waarde mag niet gewijzigd worden. | |||||||
purchase | string | string | Inkoopordernummer van de Bestelomgeving leermiddelen | OW1234 | 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 | Optioneel kan de Aanbieder per product terugkoppeling geven. | Zie object OrderConfirmationLine | O |
...
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 | V | |
quantity | integer | integer | Aantal producten dat de | Aanbieder bevestigd | 100 | O | ||
status | integer | ENUM | Status | 0 (=OK) | V | |||
statusMessage | string | string | Toelichting op status | - | O |
Anchor | ||||
---|---|---|---|---|
|
...
Op deze wijze kunnen zowel Bestelomgeving leermiddelen als Ordersysteem leermiddelen dit bericht relateren aan de oorspronkelijke OrderConfirmation die gecrediteerd gaat worden. Uiteraard is het afhankelijk van bilaterale afspraken tussen beide leveranciers of crediteren al dan niet mogelijk is en welke informatie in het verzoek opgenomen moet zijn.
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
request | string | uuid | Referentienummer voor het versturen van de |
CreditOrder | 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 events met betrekking tot een unieke aanvraag. | |||
purchase | string | string | Inkoopordernummer van de Bestelomgeving leermiddelen | OW1234 | V | Waarde mag niet gewijzigd worden |
sales |
OrderId | string | string |
Verkooporder- |
nummer van |
het Ordersysteem leermiddelen |
OA678 | O | Waarde mag niet gewijzigd worden |
response |
ReferenceId | string |
string
Verkooporder-nummer van het Ordersysteem leermiddelen
OA678uuid | Optionele verwijzing naar de responseReferenceId van de OrderConfirmation waarin het OrderVerzoek door het Ordersysteem leermiddelen is bevestigd. | eacb81ef-c9d5-4bd8-a624-4088bee04b75 | O | Waarde mag niet gewijzigd worden |
orderLines | array | Credit OrderLine | Optioneel kan de Bestelomgeving een deel van de Order crediteren | Zie object: CreditOrderLine | O |
Object:
Anchor | ||||
---|---|---|---|---|
|
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
purchase | string | string | Optioneel |
inkooporder-regelnummer van |
de Bestelomgeving leermiddelen |
OW1234-2 | O | Waarde mag niet gewijzigd worden |
sales |
OrderLineId | string | string |
Optionele verwijzing naar de CreditorderBevestiging (CreditOrderConfirmation) waarin het OrderVerzoek door het Ordersysteem leermiddelen is bevestigd.
eacb81ef-c9d5-4bd8-a624-4088bee04b75Optioneel verkooporder-regelnummer van het Ordersysteem leermiddelen | OA678-2 | O | Waarde mag niet gewijzigd worden | |||
productId | string | string | Verwijzing naar de unieke identifier voor het product | 871792713 | V | |
quantity | integer | integer | Aantal producten dat de Bestelomgeving wil crediteren | 100 | V |
Anchor | ||||
---|---|---|---|---|
|
...
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel | |||||||
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. | |||||||
response | string | uuid | De referentie van het Ordersysteem leermiddelen voor dit bevestigingsbericht. | eacb81ef-c9d5-4bd8-a624-4088bee04b76 | V | Waarde mag niet gewijzigd worden. | |||||||
purchase | string | string | Inkoopordernummer van de Bestelomgeving leermiddelen | OW1234 | V | Waarde mag niet gewijzigd worden | purchase | string | string | Optioneel inkooporder-regelnummer van de Bestelomgeving leermiddelen | OW1234-2 | O | Waarde mag niet gewijzigd worden |
sales | string | string | Verkoopordernummer van het Ordersysteem leermiddelen | OA678 | O | Waarde mag niet gewijzigd worden | sales | string | string | Optioneel verkooporder-regelnummer van het Ordersysteem leermiddelen | OA678-2 | O | Waarde mag niet gewijzigd worden |
processed | string | datetime | Tijdstip waarop het CreditOrderRequest 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. | |||||||
creditOrderStatus | string | ENUM | Een indicatie wat de status van verwerking van de CreditOrderRequest 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 | ||||||||
creditOrder ConfirmationLine | array | CreditOrderConfirmationLine | Optioneel kan Aanbieder per product terugkoppeling geven | Zie object CreditOrderConfirmationLine | O |
Object:
Anchor | ||||
---|---|---|---|---|
|
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
purchase | string | string | Optioneel inkooporder-regelnummer van de Bestelomgeving leermiddelen | OW1234-2 | O | Waarde mag niet gewijzigd worden |
sales | string | string | Optioneel verkooporder-regelnummer van het Ordersysteem leermiddelen | OA678-2 | O | Waarde mag niet gewijzigd worden |
productId | string | string | Verwijzing naar de unieke identifier voor het product | 871792713 | V | |
quantity | integer | integer | Aantal producten dat de Aanbieder crediteert | 100 | O | |
status | integer | ENUM | Status | 0 (=OK) | V | |
statusMessage | string | string | Toelichting op status | - | O |
Status- en foutcodes
Voor alle APIs uit het Afsprakenstelsel Edu-V zijn de status- en foutcodes beschreven op de pagina Status- en foutcodes. Hierbij is onderscheid gemaakt in algemene en voor de API specifieke status- en foutcodes.
...