| Table of Contents | ||
|---|---|---|
|
Revision
Date | Description |
|---|---|
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 | |
...
getContentUrl
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 | OpenID Connect (OIDC) | ||||
Authorisation | Bearer token | ||||
The token is requested via an API call with credentials known tot the customer. Credentials are specified as parameters Content-Type: application/x-www-form-urlencoded
| |||||
Kunnen we dit wel opnemen? | URL's voor opvragen token :
|
OpenAPI
Definition | DigitalProductOrderService UserId van Bookshelf komt in ieder geval nog voor. Sinds begin 2022 is dit al gestopt https://app.swaggerhub.com/apis/cb_org/DigitalProductOrderService/1.0.1#/CheckOrderableIn | ||
‘Optional’ parameter | For any optional attribute one of the following options applies:
| ||
URL Test | |||
URL |
Response messages
If a webservice is technical able to proces, it
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. The message then states what is incorrect with respect to the definition |
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" |
Operation: checkOrderable
Web shops display their assortment in their windows and want to sell it to their customers. As soon as the customer wants to check-out the products in the shopping cart, the web shop requires the certainty that the article can be ordered. This moment comes ideally just before payment. If the required article cannot be ordered/delivered and the customer already paid, the web shop has additional work in correcting the payment and the customer will have a negative experience with the web shop. This method is used to make sure an e-book can be ordered/delivered. The reply 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 (Download or On-line reading in the Cloud).
Response
...
Parameter
...
Description
...
Optionality
...
Allowed values
...
Orderable
...
Indicates orderability of the requested digital product through the desired channel.
...
Mandatory
...
Y (Yes = Orderable)
N (No = Not 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 (Download or On-line reading in the Cloud).
...
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.