Get Inventory

Get Inventory

The inventory endpoint is a specific LVB/FBB endpoint; it only provides information about your Fulfillment by bol.com Inventory. This endpoint does not provide information about your own stock.

GET /services/rest/inventory/parameters

Parameters

The optional page parameter can be used to traverse the endpoint. The other optional parameters can be applied to filter the list of inventory that is returned from the API.

Name Type Values Description
page= integer n/a If the parameter is not given, the default value is 1.
quantity= n/a This optional parameter will return inventory that has stock within the given range. E.g. when the range 0-5 is given, it will return a list of inventory with stock between 0 and 5.
stock= sufficient, insufficient This optional parameter will return inventory that either has sufficient stock or insufficient stock.
state= saleable, unsaleable This optional parameter will return inventory that has either 0 NCK-Stock or >0 NCK-Stock.
query= string EAN, product title This optional parameter can be used to search for inventory based on the given EAN code or product title.

Example request 1

GET /services/rest/inventory?page=2

Example response 1

Status: 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<InventoryResponse xmlns="https://plazaapi.bol.com/services/xsd/v1/plazaapi.xsd">
 <TotalCount>144</TotalCount>
 <TotalPageCount>3</TotalPageCount>
 <Offers>
  <Offer>
   <EAN>9789076174143</EAN>
   <BSKU>1230000402640</BSKU>
   <Title>Harry Potter en de gevangene van Azkaban</Title>
   <Stock>0</Stock>
   <NCK-Stock>1</NCK-Stock>
  </Offer>
  <Offer>
   <EAN>9789076174198</EAN>
   <BSKU>1230000425793</BSKU>
   <Title>Harry Potter & de Vuurbeker</Title>
   <Stock>2</Stock>
   <NCK-Stock>0</NCK-Stock>
  </Offer>
  <Offer>
   <EAN>9789061697664</EAN>
   <BSKU>1230000889762</BSKU>
   <Title>Harry Potter en de halfbloed Prins</Title>
   <Stock>8</Stock>
   <NCK-Stock>0</NCK-Stock>
  </Offer>
  <Offer>
   <EAN>9789061697008</EAN>
   <BSKU>2950000418559</BSKU>
   <Title>Harry Potter en de orde van de Feniks</Title>
   <Stock>1</Stock>
   <NCK-Stock>0</NCK-Stock>
  </Offer>
  <Offer>
   <EAN>9781781103524</EAN>
   <BSKU>1230000425830</BSKU>
   <Title>Harry Potter en de Relieken van de Dood</Title>
   <Stock>20</Stock>
   <NCK-Stock>0</NCK-Stock>
  </Offer>
 </Offers>
</InventoryResponse>

Example request 2

GET /services/rest/inventory?quantity=0-250&state=saleable&query=0042491966861&page=1

Example response 2

Status: 200 OK
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<InventoryResponse xmlns="https://plazaapi.bol.com/services/xsd/v1/plazaapi.xsd">
<TotalCount>1</TotalCount>
<TotalPageCount>1</TotalPageCount>
<Offers>
<Offer>
<EAN>0042491966861</EAN>
<BSKU>1230001375936</BSKU>
<Title>Klembord Officemate met opbergruimte grijs</Title>
<Stock>0</Stock>
<NCK-Stock>0</NCK-Stock>
</Offer>
</Offers>
</InventoryResponse>

Return values explained

Name Type Description
TotalCount int The total amount of unique products.
TotalPageCount int The total amount of pages that can be requested.
EAN int  EAN of the product.
BSKU int  Unique bol.com identifier for the product.
Title string Title of the product.
Stock int The actual stock that can be sold.
NCK-Stock int The actual stock that can not be sold (unsalable stock).