Description
API call retrieves bin information including the number of items in each bin. Supports optional filtering by location and bin group, with optional pagination.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
LocID |
string |
0 |
001 |
Filter by location ID. If omitted, all locations are returned. |
2 |
RowCount |
integer |
0 |
100 |
Maximum number of rows to return. Set to 0 (or omit) to return all matching bins without pagination. |
3 |
Start |
integer |
0 |
0 |
Row offset for pagination. Only applied when RowCount is greater than 0. |
4 |
BinGroup |
string |
0 |
GROUP1 |
Filter by bin group. If omitted, all bin groups are returned. |
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:pixiGetStockBins>
<dem:LocID>001</dem:LocID>
<dem:RowCount>100</dem:RowCount>
<dem:Start>0</dem:Start>
<dem:BinGroup>GROUP1</dem:BinGroup>
</dem:pixiGetStockBins>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Bin information
# |
Name |
Type |
Description |
1 |
RowNr |
integer |
Row number. Only present when RowCount parameter is greater than 0 (pagination mode). |
2 |
BinKey |
integer |
Bin ID |
3 |
BinName |
string |
Bin name |
4 |
BinLocID |
string |
Location ID of the bin |
5 |
BinSortNum |
integer |
Internal sorting number for this bin. Reflects the order in which this bin appears on picklists. |
6 |
BinGroup |
string |
Bin group |
7 |
NrOfItemOnBin |
integer |
Total number of items currently on this bin |
Additional Notes
Pagination behaviour:
- If RowCount = 0 (default): all matching bins are returned. RowNr is not included in the response.
- If RowCount > 0: pagination is active. At most RowCount rows are returned, starting after row Start. RowNr is included in the response.
Results are ordered by BinSortNum, then BinKey.