Versions Compared

Version Old Version 30 New Version 31
Changes made by

Wilma Valkis - Temminck

Wilma Valkis - Temminck

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

Revision

To be announced

Date

Description

New version due to move to a new server. URL change and new yaml versions MediaOrderB2C and MediaShipment

Functional changes:

  • MediaOrderB2C Get Orderstatus: The "OwnerName" has been included in the OpenApi specification. Up until now, this field was incorrectly not included as a tag and therefore also not as a value. In this new version, this is the case (if applicable).

  • MediaShipment Get ShippingUnit: The ShippingUnitId has been extended, so that it remains unique. Even over the years.

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

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

...

Authentication & Authorisation

MediaOrderB2C


S.v.p. checken en voorbeeld doorgevenBasic - username:password   “Basic ”||"Base64 encoding of username and password joined by a single colon : "

and Shipment

Header-parameters "Username" + "Password"  

Webservice information

Webservice approache

REST - Representational State Transfer

MediaOrderB2C

Definition

OpenAPI Specification

View file
namecb_org-MediaOrderB2C-2.0.

0

1-resolved.yaml

Resource

Orders

Operations provided by CB:

placeOrder

Send one (1) order to CB

cancelOrderLine

Cancel one (1) orderline

getOrderStatus

Retrieve the status if one (1) order

MediaOrderNotify

Definition:  is dit nog wel de juiste yaml versie?

OpenAPI Specification

View file
nameMediaOrderNotify v1.0.2.yaml

Resource: 

Notifications

Operations provided by you:

notifyOrder

CB calls your webservice to inform you about status updates of an order

Authentication mode

CB supports:

  • Basic - username:password   “Basic ”||"Base64 encoding of username and password joined by a single colon : "

  • Token 

MediaShipment

Definition

View file
namecb_org-MediaShipment-2.0.

0

1-resolved.yaml

Resource

ShippingUnits

Operations provided by CB:

getShippingUnit

Retrieve the shipment information for a shipping unit

MediaShipmentNotify

Definition: 

is dit nog wel de juiste yaml versie?

View file
nameMediaShipmentNotify v1.0.0.yaml

Resource: 

Notifications

Operations provided by you:

notifyOrder

notifyShipment

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

Authentication mode

CB supports:

  • Basic - username:password   “Basic ”||"Base64 encoding of username and password joined by a single colon : "

  • Token 

Content type

The content /body in the request and response has to be, will be in json format

‘Optional’ parameter

For any optional Attribute ons of th following options applies:

  • be filled with the correct value

  • be left out

  • be filled with ““ (read empty)

Note

An optional parameter may therefore never be filled with the value null

URL Test

Healthcheck niet opgenomen

MediaOrderB2C base: https://media.tst.cb-api.nl/mediaorderb2c

  • /v2/orders

  • /v2/orders/{OrderId}/status

  • /v2/orders/{OrderId}/orderlines/{OrderLineId}

MediaShipment base:  https://media.tst.cb-api.nl/mediashipment

  • /v2/shippingunit/{ShippingUnitId}

URL Production

Healthcheck niet opgenomen

MediaOrderB2C base: https://media.cb-api.nl/mediaorderb2c

  • /v2/orders

  • /v2/orders/{OrderId}/status

  • /v2/orders/{OrderId}/orderlines/{OrderLineId}

MediaShipment base: https://media.cb-api.nl/mediashipment

  • /v2/shippingunit/{ShippingUnitId}

Supported SSL/TLS protocols

TLS 1.2

TLS 1.3

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.

...