Revision

Date	Description
05 Mar 2025	Webservice is moving to another server PhysicalProductStockService - getStockAvailability (CEP)
23 Dec 2021	As of February 1, 2022, CB will no longer support TLS 1.0 and 1.1
20 Dec 2021	Location initial document moved to wiki.cb.nl
19 Feb 2018	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 physically available stock ready to be delivered within 24 or 48 hours, products that do not meet this criteria show a stock of 0 (zero).
No account is taken of buyer restrictions such as delivery agreements, credit checks etc.
Product ownership is irrelevant in this operation. The only relevance is the physically available stock.
The QuantityAvailable24hrs availability is valid only during requests on workdays before the cut-off time.
Requests on workdays after the cut-off time and requests on non-workdays have to use the QuantityAvailable48hrs availability.

This operation only supports REST.

Authentication for this webservice

This operation does not need authentication. The UserName is only used for logging.

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
ProductIdType	The identification type of the product	1..1	EAN

POST https://testservices.cb.nl/rest/api/v1/PhysicalProductStockService/getStockAvailability HTTP/1.1
UserName: _SNIP_
Content-Type: application/json
  
{
    "Product": [
    {"ProductId": "9780582275225","ProductIdType": "EAN"},
    {"ProductId": "9783259011928","ProductIdType": "EAN"}
    ]
}

Reply

Parameter	Description	Cardinality	Approved values
StockAvailability	Stock availability 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	EAN
QuantityAvailable24hrs	The number of products available at the time of this request and ready for delivery within 24 hours.	1..1
QuantityAvailable48hrs	The number of products available at the time of this request and ready for delivery within 48 hours. This includes delivery within 24 hours.	1..1

{
  "StockAvailability": [
    {
      "ProductId": "9780582275225",
      "ProductIdType": "EAN",
      "QuantityAvailable24hrs": "54",
      "QuantityAvailable48hrs": "1554"
    },
    {
      "ProductId": "9783259011928",
      "ProductIdType": "EAN",
      "QuantityAvailable24hrs": "11",
      "QuantityAvailable48hrs": "11"
    }
  ]
}

{
  "Message": {
    "MessageType": "E",
    "MessageCode": "WMS-00011",
    "MessageText": "Invalid value for productIdType."
  }
}

Specific messages (type/code/text) for this webservice

Type	Code	Text
E	WMS-00010	The field productId is mandatory.
E	WMS-00011	Invalid value for productIdType.
E	WMS-00012	The field productType is mandatory.
E	WMS-00013	At least one product required
E	WMS-00014	The number of products is bigger than maximum 1000
E	WMS-00015	Product(s) not found
E	EBS-11001	Something went wrong in processing the request.

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.