Description

API call returns the current stock of the item, based on the provided parameters.

Request Parameters

#	Name	Type	Required	Example	Description
1	ItemKey	integer	0	12345	Filter: Item ID.
2	EAN	string	0	12345	Filter: Item barcode.
3	ItemNrSuppl	string	0	12345	Filter: Item supplier number.
4	ItemNrInt	string	0	12345	Filter: Item shop number.
5	LocationStock	boolean	0	1	Return stock per location.
6	OnlyEnabledItems	boolean	0	0	Return only if item is enabled.
7	ExcludeBinGroups	string	0	GroupX, GroupY, GroupZ	Exclude bin groups when calculating the stock.
8	ItemXML	string	0	Sample text	Filter: See additional information for XML structure

Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
   <soapenv:Header/>
   <soapenv:Body>
      <dem:pixiGetItemStock>
         <dem:ItemKey>12345</dem:ItemKey>
         <dem:EAN>12345</dem:EAN>
         <dem:ItemNrSuppl>12345</dem:ItemNrSuppl>
         <dem:ItemNrInt>12345</dem:ItemNrInt>
         <dem:LocationStock>1</dem:LocationStock>
         <dem:OnlyEnabledItems>0</dem:OnlyEnabledItems>
         <dem:ExcludeBinGroups>GroupX, GroupY, GroupZ</dem:ExcludeBinGroups>
         <dem:ItemXML>Sample text</dem:ItemXML>
      </dem:pixiGetItemStock>
   </soapenv:Body>
</soapenv:Envelope>

Response

Body 1: Item stock data. (parameter @LocationStock = 0)

#	Name	Type	Description
1	AvailableStock	integer	Current available stock considering settings: "Enable reservations", "Export Physical Stock for items (not bundles)" and "Export available stock - reservations are enabled".
2	PhysicalStock	integer	Current physical stock (without stock on locations marked as "special location".)
3	PhysicalStockAllLocations	integer	Current physical stock (with stock on locations marked as "special location".)
4	SupplPrice	number	Supplier price of the item.
5	ItemKey	integer	Item ID.
6	EANUPC	string	Item barcode.
7	ItemNrSuppl	string	Item supplier number.
8	ItemNrInt	string	Item shop number.
9	OpenOrderlineSum	integer	Sum of open orderline quantities for item

Body 2: Extended item stock data. (parameter @LocationStock = 1)

#	Name	Type	Description
1	AvailableStock	integer	Current available stock considering settings: "Enable reservations", "Export Physical Stock for items (not bundles)" and "Export available stock - reservations are enabled".
2	PhysicalStock	integer	Current physical stock (without stock on locations marked as "special location".)
3	PhysicalStockAllLocations	integer	Current physical stock (with stock on locations marked as "special location".)
4	SupplPrice	number	Supplier price of the item.
5	ItemKey	integer	Item ID.
6	EANUPC	string	Item barcode.
7	ItemNrSuppl	string	Item supplier number.
8	ItemNrInt	string	Item shop number.
9	Locations	string	Detail stock information per location. Only if parameter "LocationStock" is provided with value=1
10	OpenOrderlineSum	integer	Sum of open orderline quantities for item
11	OpenOrderlineSumLocations	string	Sum of open orderline quantities for item per location

Additional Notes

**Select multiple items with one call:**

 When using **ItemXML** parameter one can get the item info for **multiple items** with one call.
 Sample XML structure:

     <ITEMS>
    	<ITEM><ITEMKEY>365</ITEMKEY></ITEM>
    	<ITEM><EAN>2000000000091</EAN></ITEM>
    	<ITEM><ITEMNRINT>54e46dd1dc2c30a39.01766786</ITEMNRINT></ITEM>
    	<ITEM><ITEMNRSUPPL>mg316</ITEMNRSUPPL></ITEM>        
    </ITEMS>

 Only if parameter "LocationStock" is provided with value "1", column "Locations" is shown in the result set.

 You need to provide one of these parameters for the call to return data:

- ItemKey
- EAN
- ItemNrSuppl
- ItemNrInt
- The supplier price shown in "SupplPrice" in the result set is taken from the item info.

 This call recalculates the stock for the item when executed and updates "LastCalculationDate" for this item.
 If you execute the API call pixiGetChangedItemStock, this item is also shown because for pixi* this item has changed.

----------