| Table of Contents |
|---|
Inleiding
In dit document wordt de webservice MediaOrderB2C toegelicht. Deze webservice is ontwikkeld met REST/JSON.
Resources en operaties
In REST wordt gebruik gemaakt van Resources en Operaties. Een resource kan gezien worden als object, een operatie als activiteit op een object. De volgende resources zijn onderkent:
...
Resource
(object)
...
YAML
...
Operatie
(activiteit op een object)
...
Van
...
Naar
...
Beschrijving
...
Het versturen van een bestand (PDF) dat als bijlage aan een order gekoppeld is.
Het bestand wordt bij het gereed maken van de zending geprint en bijgevoegd in de doos. Het PDF bestand dient voorafgaand aan de order door CB ontvangen te zijn.
Opmerking: Deze operatie is nog niet beschikbaar.
...
Het versturen van een order naar CB.
De bestelling. Bij ontvangst van de order wordt een basis validatie uitgevoerd, indien er geen uitzonderingen zijn aangetroffen zal de order als ontvangen opdracht wordt vastgelegd en wordt er als reply een bevestiging naar de klant gestuurd.
...
Het opvragen van de status van de door de klant ingediende order.
Bij vooraf gedefinieerde statusveranderingen van een order (events) wordt een notify signaal naar de klant gestuurd, operatie notifyOrder. De klant kan vervolgens de gedetailleerde orderstatus bij CB opvragen. De orderstatus geeft informatie van de gehele oorspronkelijk ingediende opdracht.
...
Het opvragen van de levereenheden waarin de door de klant ingediende order is verstuurd.
Ten behoeve van een volledigheidscontrole kan de klant een overzicht van alle shippingunits/levereenheden opvragen waarin de artikelen van de order in verstuurd zijn.
Opmerking: Deze operatie is nog niet beschikbaar.
...
Het annuleren van een orderregel.
De klant kan een order of een orderregel annuleren, dit kan tot het moment dat de order gereed gemaakt wordt voor distributie.
...
Het melden dat er een shippingunit/levereenheid aan de vervoerder overgedragen is.
Voor elke levereenheid die klaar staat voor verzending wordt een notify signaal naar de klant gestuurd. De klant kan vervolgens de details van de levereenheid bij CB opvragen, operatie getShippingUnit.
...
Het opvragen van details van een shippingunit/levereenheid. In de details is per artikel een referentie naar de relevante orderregel opgenomen.
...
Het opvragen van orders die gedurende het maintenance window zijn geparkeerd en nog niet zijn verwerkt.
...
Schematische weergave webservice Media orders B2C
CB Media Interface Description
...
- Average response time within 2 seconds during prime-time (08:00-01:00 CET)
- Response within 3 seconds for 99,95% of the requests during prime-time
- Response within 6 seconds for 99% of the requests outside prime-time
MediaOrderB2C
| Webservice name: | MediaOrderB2C |
| Definition: | MediaOrderB2C.yaml |
| Resource: | Orders |
| Operations provided by CB: | |
| placeOrder | Send one (1) order to CB |
| cancelOrderLine | Cancel one (1) orderline |
| getOrderStatus | Retrieve the status of one (1) order |
Waardes voor lijsten
De webservice operaties gebruiken Engelse termen en human readable waardes voor lijsten.
...