Description
Returns empty stock bins (bins containing no items). Supports two modes: a simple list mode returning the first available empty bins, and a proximity mode returning empty bins centered around a reference bin.
All parameters are optional. Without NearBinKey (or BinName + LocID), returns the first Rows empty bins ordered by sort number. With a reference bin, returns empty bins evenly spread before and after it.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
LocID |
varchar(3) |
0 |
001 |
Filter results to a specific location. Leave empty to return bins from all locations. |
2 |
Rows |
int |
0 |
10 |
Maximum number of empty bins to return. Defaults to 10. In proximity mode, returns up to Rows/2 bins before and Rows/2 after the reference bin. |
3 |
NearBinKey |
int |
0 |
4521 |
Bin ID of the reference bin for proximity search. When provided, returns empty bins centered around this bin. |
4 |
BinName |
varchar(50) |
0 |
A-01-01 |
Bin name of the reference bin. When provided together with LocID, the corresponding NearBinKey is resolved automatically. |
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:pipiGetStockBinsEmpty>
<dem:LocID>001</dem:LocID>
<dem:Rows>10</dem:Rows>
<dem:NearBinKey></dem:NearBinKey>
<dem:BinName></dem:BinName>
</dem:pipiGetStockBinsEmpty>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Empty Bins
# |
Name |
Type |
Description |
1 |
BinSortNum |
int |
Bin sort order number. Results are ordered by this value ascending. |
2 |
BinLocID |
varchar(3) |
Location ID of the bin. |
3 |
BinName |
varchar(50) |
Name of the bin. |
4 |
BinKey |
int |
Bin ID. |
5 |
BinGroup |
varchar(20) |
Bin group the bin belongs to. |
Additional Notes
Simple mode (no reference bin): returns the first Rows empty bins, ordered by BinSortNum ascending. Optionally filtered by LocID.
Proximity mode (NearBinKey provided, or BinName + LocID provided): returns empty bins centered around the reference bin — up to FLOOR(Rows/2) bins before and FLOOR(Rows/2) bins after it in sort order. For odd Rows values, the total returned may be Rows-1.
To use proximity search by bin name instead of bin key: provide both BinName and LocID. The bin key is resolved automatically.