Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Date

Description

New version due to move to a new server. URL change and yaml version. SOAP is deprecated

8 aug. 2022 

Delivery Channel BS (Bookshelf) is deprecated

22 feb. 2022 

As of July 1, 2022, CB will no longer support Bookshelf

3 mei 2021 

Specific messages (type/code/text) for this webservice:

Some of EBS-* error code will change to WMS-* codes 

29 apr. 2021 

As of May 17, 2021, CB will no longer support TLS 1.0 and 1.1

8 apr. 2021 

Initial document

...

Request

Parameter

Description

Optionality

Allowed values

OrderReference

This is an internal reference used by the CB-customer to identify the order. This identifier needs to be unique.

Mandatory

Max. 100 positions

Response

Parameter

Description

Optionality

Allowed values

CbOrderReference

Unique CB Internal reference to identify the customer’s order

Mandatory

EAN

The EAN of which the digital product is to be delivered

Mandatory

13 positions

URL

URL of the address where the digital product is available for delivery. This is an URL to download digital product

Mandatory

General webservice information

Content-Type

application/json

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

API

REST

Representational State Transfer

Servers

Production

https://services.cb.nl

Test

https://testservices.cb.nl

Supported SSL/TLS protocols

TLS1.2

 

TLS1.3

Authentication & Authorisation

Authentication

Username

Authorisation

Password

...

Webservice information

Webservice approache

REST - Representational State Transfer

Definition

View file
namecb_org-DigitalProductOrderService-1.0.1-resolved.yaml

Content type

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

‘Optional’ parameter

For any optional attribute one of the following options applies:

  • be filled with the corract value

  • be left out

  • be filled with ““ (read empty)

Note

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

URL Test

URL

Supported SSL/TLS protocols

TLS 1.2

TLS 1.3

Response messages

If a webservice is technical able to proces, it will respons with a HTTP status 200. the response can contain a message with additional information. It can be an error (MessageType”E”) in case it wasn’t possible to supply a functional answer or additional explanation/informatie about the answer (MessageType “T”).

HTTP code

Code

200

200

EBS-10003

A product with this EAN is not available

200

EBS-10004

This product is not available for delivery

200

EBS-10005

This OrderReference has already been used, use another reference

200

EBS-10006

This product may not be ordered

200

EBS-10009

This product may not be ordered

200

EBS-10017

Your credit limit has been exceeded

200

EBS-10077

No Order found with this OrderReference

400

CEP-200

An generic error code for syntactic errors.
<detail "invalid (based on swagger-definition) input" message>
Example fwhen a wrong DeliveryChannel is used: "[instance value (\"CBX\") not found in enum (possible values: [\"CBW\"])]"

400

CEP-002

<detail "invalid (based on swagger-definition) input" message>

401

CEP-003

You are not authenticated

404

CEP-004

Resource not available

500

EBS-11000

Something went wrong in processing the request. (<error-reference-code>)

500

"Internal server error"

Volume limits and performance requirements

Volume

Webservice calls are limited to a maximum of 5 web service calls per account at the same time.

Performance

...

Digital Product for test purposes

...