Description
Returns the current stock quantity for an item across all bin locations in the warehouse. Use this call to query bin-level stock quantities for one or more items at a time.
At least one identification parameter (ItemKey, EAN, ItemNrSuppl, ItemNrInt, or ItemXML) must be provided. If none is supplied, the call returns an error result set. When no matching items are found, an error result set is also returned.
For bulk queries, use the ItemXML parameter to query multiple items in a single call. Stock quantities are aggregated by bin, location, batch number, and best before date.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
ItemKey |
int |
0 |
365 |
Item ID. At least one identification parameter must be provided. A value of 0 is treated as not provided. |
2 |
EAN |
varchar(13) |
0 |
2000000000091 |
Item barcode (EAN/UPC). At least one identification parameter must be provided. |
3 |
ItemNrSuppl |
varchar(50) |
0 |
mg316 |
Item supplier number. At least one identification parameter must be provided. |
4 |
ItemNrInt |
varchar(50) |
0 |
54e46dd1dc2c30a39.01766786 |
Item shop number. At least one identification parameter must be provided. |
5 |
ItemXML |
varchar(max) |
0 |
Check additional information |
XML structure for querying multiple items in a single call. See Additional Notes for the XML format and supported tags. |
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:pipiGetItemStockBins>
<dem:ItemKey>365</dem:ItemKey>
<dem:EAN></dem:EAN>
<dem:ItemNrSuppl></dem:ItemNrSuppl>
<dem:ItemNrInt></dem:ItemNrInt>
<dem:ItemXML></dem:ItemXML>
</dem:pipiGetItemStockBins>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Bins with Current Item Stock
# |
Name |
Type |
Description |
1 |
BinName |
varchar(50) |
Name of the bin. |
2 |
Quantity |
int |
Total current stock quantity of the item in this bin. |
3 |
BinSortNum |
int |
Bin sort order number. |
4 |
EAN |
varchar(13) |
Item barcode (EAN/UPC). |
5 |
ItemNRInt |
varchar(50) |
Item shop number. |
6 |
LocID |
varchar(3) |
Location identifier of the bin. |
7 |
BatchNumber |
varchar(50) |
Batch number of the item. Empty string if not applicable. |
8 |
BestBeforeDate |
varchar(25) |
Best before date of the item (format: YYYY-MM-DD HH:MM:SS.mmm). Empty string if not applicable. |
9 |
BinGroup |
varchar(20) |
Bin group the bin belongs to. |
10 |
TransportBin |
bit |
Indicates whether the bin is a transport bin (1 = yes, 0 = no). |
Body 2: Status Output
# |
Name |
Type |
Description |
1 |
Status |
varchar(20) |
Execution status. Value is Error when this result set is returned. |
2 |
Message |
varchar(200) |
Description of the error. Possible values: Specify at least one parameter to identify the item. — no identification parameter was provided; No items found with given parameters. — no items match the given identifiers. |
Additional Notes
Multiple items can be queried in a single call using the ItemXML parameter.
XML structure for ItemXML:
<ITEMS>
<ITEM><ITEMKEY>365</ITEMKEY></ITEM>
<ITEM><EAN>2000000000091</EAN></ITEM>
<ITEM><ITEMNRINT>54e46dd1dc2c30a39.01766786</ITEMNRINT></ITEM>
<ITEM><ITEMNRSUPPL>mg316</ITEMNRSUPPL></ITEM>
</ITEMS>
Supported XML tags (case-sensitive, must be uppercase):
ITEMKEY - Item ID
EAN - Item barcode
ITEMNRINT - Item shop number
ITEMNRSUPPL - Item supplier number
Each ITEM element must contain at least one identification tag.
Multiple ITEM elements can be included for batch processing.
Results are ordered by location (LocID) and bin name.