Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 32 Next »


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

FileMediaFileplaceFileKlantCB

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.

Order



MediaOrderB2C


placeOrderKlantCB

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. 

getOrderStatusKlantCB

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.

getShippingUnitsKlantCB

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.

cancelOrderLineKlantCB

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.

MediaOrderNotifynotifyOrderCBKlantHet melden dat de order of orderregel een vooraf gedefinieerde status heeft bereikt.
ShipmentMediaShipmentNotifynotifyShipmentCBKlant

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

MediaShipmentgetShippingUnitKlantCB

Het opvragen van details van een shippingunit/levereenheid. In de details is per artikel een referentie naar de relevante orderregel opgenomen.

Postponed-order


OrderBeheer


getPostponedOrdersCBCB

Het opvragen van orders die gedurende het maintenance window zijn geparkeerd en nog niet zijn verwerkt.

placeSingleOrderCBCBHet doorzetten van een order nadat deze tijdelijk geparkeerd is tijdens het maintenance window.
getPostponedCancelOrderLinesCBCBHet opvragen van annuleringen voor orderregels die gedurende het maintenance window zijn geparkeerd en nog niet zijn verwerkt.
cancelSingleOrderLineCBCBHet doorzetten van een annulering voor een orderregel nadat deze tijdelijk geparkeerd is tijdens het maintenance window.


Schematische weergave webservice Media orders B2C

Media webservice operaties

CB Media Interface Description

Revisions

Version

DateDescription
0.1

30-08-2019 

Initial document
0.311-11-2019 Add operations
0.513-01-2020 Add flows and sequence diagrams
0.611-03-2020 Add volume limits and error messages

Introduction

This document contains a description of the standard interfaces for implementation of data exchange with CB via webservices.

The entire set for the standard data exchange with CB consists of the following documents and files:
The mapping from file based to webservice based messages
The functional description of the definitions in the operations
yaml definition filesAn OpenAPI Specification file (yaml) for each resource

Overview webservices

This chapter gives an overview of the available interaction patterns for data exchange with CB. The figure below gives an high level overview of the CB system landscape and the available webservice operations.

CB provides REST based webservices. In REST operations define the available activities.


Image  Overview operations

Waardes voor lijsten

De webservice operaties gebruiken Engelse termen en human readable waardes voor lijsten. 

 Klik hier voor overzicht met gebruikte termen voor lijsten in de webservice
ONTVANGEN OPDRACHT

OrderTypetype_kd

ShipBuyerLNAFN

ShipOwnerLNEIG

ShipSecundaryOwnerLMEONE


ShipmentDate / ShipmentPeriodlevertijd_kd

ShipmentDate = systeemdatumD

ShipmentDate = systeemdatum + 1

<geen datum opgegeven>

N

ShipmentDate > systeemdatum + 1

ShipmentPeriod

L


PartialShipmentdeellevering_kd

TRUEDIRECT

FALSE bij levertijd_kd=LBESCH_DEEL_PER

FALSE bij andere levertijd_kdCOMPLEET

ONTVANGEN_OPDRACHTREGEL

TransactionCategorytvwc_kd

DepotDistributionDUD

OwnerDistributionDIO

SpecialOfferingAANB


StockSelectionCodeme_kd

SecundaryOwnerStock1

SecundaryOrPrimary2

PrimaryOwnerStock3

PrimaryOrSecundary4

OPDRACHT AANSPREEKPUNT

PartyTypetype_kd

ReceiverAddressONT

DropSiteAddressAHP

InvoiceAddressOFA

OPDRACHT

IncludeStockTransfertype_kd

FALSELNEIG

TRUELNAFN

TRUE<overig>

Downloadable yaml files


 Klik hier voor Algemene informatie webservice Media en het servicelevel

Unable to render {include} The included page could not be found.

Unable to render {include} The included page could not be found.









  • No labels