PhysicalProductStockService - getStockAvailabilityByOwner
Revision
Date | Description |
| As of February 1, 2022, CB will no longer support TLS 1.0 and 1.1 |
| Initial document moved to wiki.cb.nl |
| Initial document |
Introduction
(Web) shops selling physical products to their customers place great value in fulfilling their client commitments. Important aspect is understanding the currently available stock. On this basis, the (web) shop is able to provide their customers with the correct delivery indication.
This operation allows the (web) shop to request the physically available stock of one or multiple products.
Requirements:
- This operation concerns available stock of the owner ready to be delivered.
- No account is taken of buyer restrictions such as delivery agreements, credit checks etc.
- No account is taken of agreed logistical constraints like cut-off times.
This operation only supports REST.
Authentication for this webservice
This operation needs authentication.
Operation getStockAvailability
Request
Parameter | Description | Cardinality | Approved values |
---|---|---|---|
Product | Product composite | 1..1000 | |
ProductId | Identification of the product for which the available stock is requested | 1..1 | Maximum length 250 characters. Supported characterset Windows-1252 |
ProductIdType | The identification type of the product | 1..1 | OWN - Productidentification as provided by the owner of the product |
OwnerId | Identification of the owner of the product for which the available stock is requested | 1..1 |
Reply
Parameter | Description | Cardinality | Approved values |
---|---|---|---|
StockAvailabilityByOwner | Stock availability by owner composite | 1..n | |
ProductId | Identification of the product for which the available stock is requested | 1..1 | |
ProductIdType | The identification type of the product | 1..1 | OWN - Productidentification as provided by the owner of the product |
OwnerId | Identification of the owner of the product for which the available stock is requested | 1..1 | |
QuantityAvailable | The number of products available at the time of this request and ready for delivery | 1..1 |
Specific messages (type/code/text) for this webservice
Type | Code | Text | Explanation |
---|---|---|---|
E | WMS-00020 | The field productId is mandatory. | |
E | WMS-00021 | Invalid value for productIdType. | |
E | WMS-00022 | The field productIdType is mandatory. | |
E | WMS-00023 | At least one product required | |
E | WMS-00024 | The number of products is greater than maximum 1000 | |
E | WMS-00025 | n product(s) not found or no stock | Products which never had stock will not be reported with an amount of 0, but will be reported with this message. |
E | WMS-00026 | The field OwnerId is mandatory. | |
E | WMS-00027 | The field length of productId is greater than maximum 250 | |
E | WMS-00028 | The field OwnerId must be numeric. | |
E | EBS-11001 | Something went wrong in processing the request. |
General webservice information
Content-Type
The content/body in the request and the response has to be / will be in json format.
Content-Type | application/json |
Servers | |
---|---|
Production | https://services.cb.nl |
Test | https://testservices.cb.nl |
Supported SSL/TLS protocols | |
---|---|
TLS Protocols | TLS1.2 |
TLS1.3 |
Authentication
CB uses message level authentication based on header parameters “UserName” and “Password”. These will be provided when you sign up for this service at CB.
Response messages
If a webservice is technical able to process, it will respond 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/information about the answer (MessageType “I”).
A message contains of:
A message contains of: | |
---|---|
MessageType | E or I |
MessageCode | format XXX-99999 |
MessageText | Textual information/reason |
The following generic error (E) messages are defined: | |
---|---|
WMS-00002 | Invalid username/password combination |
WMS-00004 | Not authorized to use this service |
WMS-00005 | No username and/or password provided by the caller |
EBS-11000 | Something went wrong in processing the request |
EBS-11001 | Something went wrong in processing the request |
Optional parameter
For any optional attribute one of the following options applies:
- be filled with the correct value
- be left out
- be filled with “” (read empty)
An optional parameter may therefore never be filled with the value null.
Articles available for test | ||||
ISBN | Titel | DiscountCode | ProductAvailability | Stock YES/NO |
---|---|---|---|---|
9789029511537 | MediaOrderB2C Title 1 | A | Reprint/Herdruk | NO |
9789029585071 | MediaOrderB2C Title 2 | A | Announced/Aangekondigd | NO |
9789063055998 | MediaOrderB2C Title 3 | O | Not available/Uitverkocht | NO |
9789045119731 | MediaOrderB2C Title 4 | S | In stock/Verschenen | YES |
9789045119755 | MediaOrderB2C Title 5 | A | In stock/Verschenen | YES |
9789025307349 | MediaOrderB2C Title 6 | A | In stock/Verschenen | YES |
9789025308339 | MediaOrderB2C Title 7 | A | In stock/Verschenen | YES |
9789025309640 | MediaOrderB2C Title 8 | A | In stock/Verschenen | YES |
9789025309954 | MediaOrderB2C Title 9 | A | In stock/Verschenen | YES |
9789029505598 | MediaOrderB2C Title 10 | A | In stock/Verschenen | YES |
9789029506182 | MediaOrderB2C Title 11 | A | In stock/Verschenen | YES |
9789029506335 | MediaOrderB2C Title 12 | A | In stock/Verschenen | YES |
9789029506885 | MediaOrderB2C Title 13 | A | In stock/Verschenen | YES |
ONIX file with Product records: Testarticles-ini-1van1_onx.xml |
Volume limits and performance requirements
Metric | Value | Unit | Interval | Explanation |
---|---|---|---|---|
Maximale response time | 2 | second | ||
Availability | 24 x 7 x 365 | The general availability of the service equals an average of 99.95% in prime time (08:00 - 01:00) in the standard time zone: UTC GMT +1. Outside this window, the web service availability may be lower, but never less than 95%. Planned maintenance by CB will be executed outside prime time and will be announced at least five working days in advance. Exception: CB can start planned maintenance four times a year at 23:00 hours. | ||
Planned downtime | 10 | hour | year | |
Unplanned downlime | 10 | hour | year |
Performance
The average service response time is no less than 2 seconds in prime time (08:00 -01:00). Inside this window, 99.95% of the requests will be dealt with. Outside prime time, 99% of the requests will be dealt with within 6 seconds.