Versions Compared

Old Version 66

changes.mady.by.user Wilma Valkis - Temminck

Saved on

compared with

New Version Current

changes.mady.by.user Wilma Valkis - Temminck

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Url naar yaml files toegevoegd

Table of Contents

CB Media Interface Description

Revisions

DateDescription

 

Added extra information authorisation: “Basic ”||"Base64 encoding of username and password joined by a single colon : "

 

Media Order B2C: Yaml file version 1.3.0

Changelog version 1.2.0 to version 1.3.0:

  • Add Article with ArticleId as product identification for dedicated stock
  • Use either EAN or Article in placeOrder (EAN is now optional), if both are supplied the EAN is used and Article is ignored
  • Report either EAN or Article in getOrderStatus based on provided input in placeOrder

MediaShipment: Yaml file version 1.0.0 version 1.1.0

Changelog version 1.0.0 to version 1.1.0:

  • Add ArticleId as product identification for dedicated stock
  • Report either EAN or ArticleId in getShippingUnit based on provided input in placeOrder

 

Authentication notify services, CB supports:

  • Basic - username/password
  • Token 

 

Test and order simulation added

 

Add Tag matrix for Green and Standard option

 

Update yaml file MediaOrderNotify v.1.0.2.yaml

 

Update generic error messages

 

Align with updated order notifications

 

Update yaml file MediaOrderB2C v1.2.0.yaml

 

Update MediaOrderB2C version

Correct resource for notifyOrder and notityShipment

 

Update yaml versions

 

Add volume limits and error messages; Correct typo in process flow diagrams

 

Add flows and sequence diagrams

 

Add operations

 

Initial document

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:

Mapping berichten naar webservices B2C.xlsx

The mapping from file based to webservice based messages
Tag matrix for Green and Standard option

CB has two options for submitting e-commerce orders:

  • Green option no document attached to shipment,
  • Standard option packing slip or invoice included with shipment
Expand
titleClick here for tag matrix

Include Page
Tags Green and Standard option
Tags Green and Standard option


yaml definition filesAn OpenAPI Specification file (yaml) for each resource

cb_org-MediaOrderB2C-1.3.0-swagger.yamlhttps://services.cb.nl/rest/api/v1/mediaorderb2c/swagger.yaml  Contains PUT (cancel), GET (status) and POST (place order)

MediaOrderNotify v1.0.2.yamlcb_org-MediaShipment-1.1.0-

https://services.cb.nl/rest/api/v1/mediashipment/swagger.yaml

MediaShipmentNotify v1.0.0.yaml

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.

...

Webservice name: MediaOrderNotify
Definition: MediaOrderNotify.yaml
Resource: 

Notifications

Operations provided by you:
notifyOrderCB calls your webservice to inform you about status updates of an order
Authentication modeCB supports:
  • Basic - username/password:password   “Basic ”||"Base64 encoding of username and password joined by a single colon : "
  • Token 

MediaShipment

Webservice name: MediaShipment
Definition: MediaShipment.yaml
Resource: 

ShippingUnits

Operations provided by CB:
getShippingUnit

Retrieve the shipment information for a shipping unit

...

Webservice name: MediaShipmentNotify
Definition: MediaShipmentNotify.yaml
Resource: 

Notifications

Operations provided by you:
notifyShipment

CB calls your webservice to inform you about a shipment for your order

Authentication modeCB supports:
  • Basic - username/password:password  “Basic ”||"Base64 encoding of username and password joined by a single colon : "
  • Token 

Process flows

This chapter contains the identified flows when using webservices to order physical books at CB. The most common and regular scenario is describes in the happy flow. In addition 7 frequent scenarios are described in alternative flows.

...

  • Processed ShippingUnit is ready for shipping

Include Page
General information CB webservice
General information CB webservice

Test environment


Include Page
Order simulation for test purpose
Order simulation for test purpose

...