Page tree
Skip to end of metadata
Go to start of metadata


Description

(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.

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

Request

Parameter
Description
Cardinality
Approved values
ProductProduct composite1..1000 
ProductId

Identification of the product for which the available stock is requested

1..1

 

ProductIdTypeThe identification type of the product 1..1 EAN

Example request

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
StockAvailabilityStock availability composite1..n 
ProductIdIdentification of the product for which the available stock is requested1..1

 

ProductIdTypeThe identification type of the product1..1EAN
QuantityAvailable24hrsThe number of products available at the time of this request and ready for delivery within 24 hours.1..1 
QuantityAvailable48hrsThe 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 

Example reply

Without message

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

 

With message

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

 

Message

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