Revision
Information
This webservice supports the order process for customers buying digital products. The service has the following operations:
checkOrderable
getContentUrl
placeOrder
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 grant_type=client_credentials&client_id=<client-id>&client_secret=<client-secret> | |
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:
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
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) |
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. | Mandatory | |