Versions Compared

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

...

Version

...

...

De webservices Media orders (B2C) zijn nog in ontwikkeling. Wij verwachten deze nieuwe functionaliteit niet eerder dan begin Q1-2022 op te leveren. Voor meer informatie kunt u vast onderstaande documentatie bekijken. Wanneer we de webservices Media orders B2C lanceren zullen wij onze klanten daarover informeren. Bent u nog geen klant van CB en wilt u geïnformeerd worden wanneer deze functionaliteit live gaat? Laat dit dan aan ons weten door een bericht aan FABCS@cb.nl.

The web services Media orders (B2C) are still under construction. We do not expect to deliver this new functionality until the beginning of Q1-2022. For more information, please see the documentation below. When we launch the web services Media orders B2C, we will inform our customers about this. Are you not yet a customer of CB and would you like to be informed when this functionality goes live? Please let us know by sending a message to FABCS@cb.nl.

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
1.3

-10-

 

Update yaml file MediaOrderNotify v.1.0.2.yaml
1.319-08-2021

 

Update generic error messages
1.2

-05-

 

Align with updated order notifications
1.1

-11-2020 

 

Update yaml file MediaOrderB2C v1.2.0.yaml
1.108-06-2020

 

Update MediaOrderB2C version

Correct resource for notifyOrder and notityShipment
1.0

-04-

 

Update yaml versions
0.6

-03-2020 

 

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

-01-2020 

 

Add flows and sequence diagrams
0.311-11-2019 

 

Add operations
0.130-08-2019 

 

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:
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

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

MediaOrderNotify v1.0.2.yamlMediaShipment v1.0.0

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 calls your webservice to inform you about status updates of an order
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   “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  “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

...