Description
Returns current stock on a specified bin along with any picklist and box assignments for those items. Always returns four result sets — result sets 2 (picklist) and 3 (box) may be empty. Use the Status field in result set 4 to determine which data is present.
BinName is required. LocID should be provided when the bin belongs to a location — omitting it when the bin has a location ID set will return empty results.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
BinName |
varchar(50) |
1 |
A-01-01 |
Name of the bin to query. |
2 |
LocID |
varchar(3) |
0 |
001 |
Location ID of the bin. Should be provided when the bin belongs to a location — omitting it for location-assigned bins returns empty results. |
3 |
GroupItems |
bit |
0 |
0 |
0 (default) — returns one row per item per update date in result set 1. 1 — consolidates to one row per item with the most recent update date. |
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:pipiGetItemsOnStockBinPickList>
<dem:BinName>A-01-01</dem:BinName>
<dem:LocID>001</dem:LocID>
<dem:GroupItems>0</dem:GroupItems>
</dem:pipiGetItemsOnStockBinPickList>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Items on Stock
# |
Name |
Type |
Description |
1 |
ItemKey |
int |
Item ID. |
2 |
EANUPC |
varchar(13) |
Item barcode (EAN/UPC). |
3 |
ItemNRInt |
varchar(50) |
Item shop number. |
4 |
ItemNrSuppl |
varchar(50) |
Item supplier number. |
5 |
StockLevel |
int |
Total stock quantity on the bin for this item. |
6 |
UpdateDate |
datetime |
Date the stock entry was last updated. When GroupItems = 1, returns the most recent update date for the item. |
Body 2: Items on Picklist
# |
Name |
Type |
Description |
1 |
BinName |
varchar(50) |
Name of the bin. |
2 |
ArtNr |
varchar(50) |
Article number of the item. |
3 |
ItemRef |
int |
Item ID. |
4 |
PickListNr |
int |
Picklist ID. |
5 |
Sum_PickListItem |
int |
Number of order lines for this item on the picklist. |
Body 3: Items in Box
# |
Name |
Type |
Description |
1 |
ArtNr |
varchar(50) |
Article number of the item. |
2 |
BoxNr |
int |
Box ID. |
3 |
ItemRef |
int |
Item ID. |
4 |
sum_box_item |
int |
Total quantity of this item packed in the box. |
Body 4: Status
# |
Name |
Type |
Description |
1 |
Status |
varchar(4) |
Indicates which data is present. See Additional Notes for code definitions. |
Additional Notes
Status codes returned in Body 4:
1000 — no items on bin
1100 — items on bin; no picklists, no boxes
1101 — items on bin + items in boxes; no picklists
1110 — items on bin + items on picklists; no boxes
1111 — items on bin + items on picklists + items in boxes
Body 2 (picklist) includes only active, non-expired picklist entries. Cancelled and inactive order statuses (AUS, NLB, RET, STO, EIN) are excluded.
Body 3 (box) includes only items in EIN status (physically packed into a box).
GroupItems applies only to Body 1:
0 — one row per item per update date
1 — one row per item with MAX(UpdateDate)