Content Comparison

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

request
ReferenceId

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
OrderId

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
Tender
Small

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

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

orderLineId

string

uuid

Referentienummer van de orderLine.

eacb81ef-c9d5-4bd8-a624-4088bee04b73

V

Dit nummer wordt gebruikt in het OrderConfirmation bericht om naar de betreffende order-line te verwijzen.

purchase
OrderLineId

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
Tender
Small

O

productId

string

string

Referentie naar de Product-beschrijving in de Catalogue API van het Leermiddel

871792713
0834

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

.

2024-03-11

O

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

requestresponse
ReferenceId

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.

responserequest
ReferenceId

string

uuid

De referentie van het Ordersysteem de Bestelomgeving leermiddelen voor waarop dit bevestigingsbericht een antwoord is.

eacb81ef-c9d5-4bd8-a624-4088bee04b75

V

Waarde mag niet gewijzigd worden.

orderConfirmationLines

array

OrderConfirmationLine

Zie object OrderConfirmationLine

V

4088bee04b73

V

Waarde mag niet gewijzigd worden.

sales
OrderId

string

string

Verkoopordernummer van

het Ordersysteem leermiddelen

OA678

O

Waarde mag niet gewijzigd worden.

purchase

OrderId

string

string

Inkoopordernummer van de Bestelomgeving leermiddelen

OW1234

O

Optioneel

kan de Aanbieder het purchaseOrderId echo-en.

processed
Timestamp

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
approved
declined

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
False

V

False indien het Ordersysteem leermiddelen niet akkoord is of er een fout is opgetreden.

status

integer

ENUM

Status

0 (=OK)

V

Zie status en foutcodes

statusMessage

string

string

Toelichting op status

-

O

Zie status en foutcodes

orderConfirmationLines

array

OrderConfirmationLine

Optioneel kan de Aanbieder per product terugkoppeling geven.

Zie object OrderConfirmationLine

O

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

sales
OrderLineId

string

string

Optioneel verkooporder-regelnummer van de Ordersysteem leermiddelen

OA678-2

O

Waarde mag niet gewijzigd worden

purchase
OrderLineId

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
0834

V

quantity

integer

integer

Aantal producten dat de Aanbieder bevestigd

100

O

status

integer

ENUM

Status

0 (=OK)

V

Zie status en foutcodes

statusMessage

string

string

Toelichting op status

-

O

Zie status en foutcodes

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

request
ReferenceId

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
OrderId

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

uuid

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

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

purchase
OrderLineId

string

string

Optioneel

inkooporder-regelnummer van

de Bestelomgeving leermiddelen

OW1234-2

O

Waarde mag niet gewijzigd worden

sales

OrderLineId

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
0834

V

quantity

integer

integer

Aantal producten dat de Bestelomgeving wil crediteren

100

V

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

request
ReferenceId

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
ReferenceId

string

uuid

De referentie van het Ordersysteem leermiddelen voor dit bevestigingsbericht.

eacb81ef-c9d5-4bd8-a624-4088bee04b76

V

Waarde mag niet gewijzigd worden.

purchase
OrderId

string

string

Inkoopordernummer van de Bestelomgeving leermiddelen

OW1234

V

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 het Ordersysteem leermiddelen

OA678-2

O

Waarde mag niet gewijzigd worden

processed
Timestamp

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
approved
declined

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
False

V

False indien het Ordersysteem leermiddelen niet akkoord is of er een fout is opgetreden.

status

integer

ENUM

Status

0 (=OK)

V

Zie status en foutcodes

statusMessage

string

string

Toelichting op status

-

O

Zie status en foutcodes

creditOrder ConfirmationLine

array

CreditOrderConfirmationLine

Optioneel kan Aanbieder per product terugkoppeling geven

Zie object CreditOrderConfirmationLine

O

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

purchase
OrderLineId

string

string

Optioneel inkooporder-regelnummer van de Bestelomgeving leermiddelen

OW1234-2

O

Waarde mag niet gewijzigd worden

sales
OrderLineId

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
0834

V

quantity

integer

integer

Aantal producten dat de Aanbieder crediteert

100

O

status

integer

ENUM

Status

0 (=OK)

V

Zie status en foutcodes

statusMessage

string

string

Toelichting op status

-

O

Zie status en foutcodes