Revision
Date | Description |
|---|---|
New version due to move to a new server. URL change and yaml version | |
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 |
Information
This webservice supports the order process for customers buying digital products. The service has the following operations:
Operation: checkOrderable
Web shops display the range they want to sell in their shop window to their customers. Once the customer wants to checkout the products in the shopping cart, the online shop needs assurance that the item is available and orderable. This moment ideally comes just before payment. If the desired item cannot be ordered/delivered and the customer has already paid, the webshop has extra work to correct the payment and the customer will have a negative experience with the webshop. This method is used to ensure that an e-book can be ordered/delivered. The answer indicates a Yes or No (Y or N).
Request | |||
Parameter | Description | Optionality | Allowed values |
EAN | The EAN of which availability and deliverability needs to be checked | Mandatory | 13 positions |
DeliveryChannel | The method the subscriber uses to read the digital product | Optional | CBW (CB registered web shop) |
Response | |||
Parameter | Description | Optionality | Allowed values |
Orderable | Indicates orderability of the requested digital product through the desired channel | Mandatory | Y (Yes = Orderable) |
Operation: placeOrder
Web shops want to deliver digital products to a customer. The web shop therefore needs to place an order with CB for the required article. CB will give feedback as to where the digital product is available.
Request | |||
Parameter | Description | Optionality | Allowed values |
EAN | The EAN which is ordered | Mandatory | 13 positions |
DeliveryChannel | The method the subscriber uses to read the digital product | Optional | CBW (CB registered web shop) |
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 the digital product | Optional | |
Operation: getContentUrl
This operation offers the CB-customer the possibility to retrieve the link to the content based on an existing order.
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 | |
Test | ||
Supported SSL/TLS protocols | TLS1.2 |
|
TLS1.3 |
Authentication & Authorisation
Authentication | Username |
Authorisation | Password |
URL
Definition |
| |
‘Optional’ parameter | For any optional attribute one of the following options applies:
An optional parameter may therefore never be filled with the value null | |
URL Test | ||
URL |
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. |
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
Availability: 99% measured over the last 12 months, excluding planned maintenance.
The response time is a maximum of 2000 ms in 95% of the cases, measured as an average over 10 minutes.