Table of Contents |
---|
Revision
Date | Description |
---|---|
| Delivery Channel BS (Bookshelf) is deprecated |
| As of July 1, 2022, CB will no longer support Bookshelf |
| Specific messages (type/code/text) for this webservice: Some of EBS-* error code will change to WMS-* codes |
| As of May 17, 2021, CB will no longer support TLS 1.0 and 1.1 |
| Initial document |
...
- checkOrderable
- getContentUrl
- placeOrder
Path: /rest/api/v1/DigitalProductOrderService
Delivery channel: Bookshelf
A Bookshelf order must be seen as a request to send a specific e-book to a certain user on the Bookshelf platform. It is therefore necessary to include the information of the Bookshelf- user with the order. If the user does not already have a Bookshelf account, an account can be made through the registration form below:
https://bookshelf.vitalsource.com/#/user/registration
Specific messages (type/code/text) for this webservice:
Type | Code | Text | New code | New text
| |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
E | EBS-10001 | The field EAN is mandatory | WMS-00008 | [object has missing required properties ([\"EAN\"])] | |||||||||
E | EBS-10003 | A product with this EAN is not available | |||||||||||
E | EBS-10004 | This product is not available for delivery | |||||||||||
E | EBS-10005 | This OrderReference has already been used, use another reference | |||||||||||
E | EBS-10006 | This product can not be ordered yet | |||||||||||
E | EBS-10009 | This product may not be ordered yet | |||||||||||
E | EBS-10011 | This audio book is no longer available via CB. Please contact the publisher for more info | |||||||||||
E | EBS-10017 | Your credit limit has been exceeded | |||||||||||
E | EBS-10034 | This product is not available for the given reading method | |||||||||||
E | EBS-10038 | Vitalsource user account unknown | |||||||||||
E | EBS- | 10050The field DeliveryChannel is mandatory | WMS-00008 | [object has missing required properties ([\"DeliveryChannel\"])] | E | EBS-10056 | Invalid value for DeliveryChannel | WMS-00008 | [instance value (\"<onjuiste waarde>\") not found in enum (possible values: [\"CBW\" | ,\"BS\"])] | E | EBS-10057 | UserId is mandatory for Bookshelf order |
E | EBS-10060 | Product ordered but no price available yet, please try again tomorrow | |||||||||||
E | EBS-10073 | The field EAN must be 13 long | WMS-00008 | [ECMA 262 regex \"^([0-9]{13})$\" does not match input string \"<onjuiste waarde>\"] | |||||||||
E | EBS-10075 | The field OrderReference must be maximum 100 long | WMS-00008 | [string \"<onjuiste waarde>\" is too long (length: 168, maximum allowed: 100)] | |||||||||
E | EBS-10076 | The field OrderReference is mandatory | |||||||||||
E | EBS-10077 | No order found with this OrderReference |
...
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). | MandatoryOptional | CBW (CB registered web shop) |
UserId | The identification of the end user. Is used to authenticate the end user (subscriber of the customer) upon delivery of the digital product. | Optional | Max. 50 positions |
deprecated |
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) |
...
Situation | Orderable product at CB | |||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
Situation | Orderable product at Bookshelf | |||||||
---|---|---|---|---|---|---|---|---|
Code Block | ||||||||
| ||||||||
| ||||||||
Situation | Non-orderable product at CB | |||||||
| ||||||||
|
...
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). | MandatoryOptional | CBW (CB registered web shop) |
UserId | The identification of the end user. Is used to authenticate the end user (subscriber of the customer) upon delivery of the digital product. | Optional | Max. 50 positions |
deprecated | |||
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 |
...
Situation | Orderable product at CB | |||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
language | yml |
---|---|
title | Request |
|
|
|
|
|
|
language | yml |
---|---|
title | Response |
|
Situation | Non-orderable product at CB | |||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
...
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
...