pixi Developer & Integration Documentation

pixiGetItemsOnStockBin

Description

Returns stock information for all items on a specified bin or bin group. Either BinName or BinGroup must be provided — the call returns an empty result set if both are omitted.

Use GroupItems = 1 to consolidate multiple stock entries per item into a single row with the latest update date. Use GroupItems = 0 (default) to return individual rows preserving each entry's update date.


Request Parameters

#

Name

Type

Required

Example

Description

1

BinName

varchar(50)

0

A-01-01

Name of the bin to query. At least one of BinName or BinGroup must be provided.

2

LocID

varchar(3)

0

001

Location ID to further filter results. Optional.

3

GroupItems

bit

0

0

0 (default) — returns one row per item per update date. 1 — consolidates rows per item per bin/batch/best-before-date combination and returns the most recent update date.

4

BinGroup

varchar(20)

0

SHELF

Bin group to query. At least one of BinName or BinGroup must be provided.


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:pipiGetItemsOnStockBin>
<dem:BinName>A-01-01</dem:BinName>
<dem:LocID></dem:LocID>
<dem:GroupItems>0</dem:GroupItems>
<dem:BinGroup></dem:BinGroup>
</dem:pipiGetItemsOnStockBin>
</soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Items on Stock Bin

#

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 (and batch/best-before-date combination).

6

UpdateDate

datetime

Date the stock entry was last updated. When GroupItems = 1, returns the most recent update date for the group.

7

ItemName

varchar(120)

Item name.

8

InternalItemNumber

varchar(50)

Internal item number (pixi-specific code type). NULL if not assigned.

9

BinGroup

varchar(20)

Bin group the bin belongs to.

10

BinName

varchar(50)

Name of the bin.

11

BatchNumber

varchar(50)

Batch number of the item on this bin.

12

BestBeforeDate

datetime

Best before date of the item on this bin.


Additional Notes

At least one of BinName or BinGroup must be provided. Both can be supplied simultaneously to filter by a specific bin within a bin group.

GroupItems behaviour:
GroupItems = 0 — one row per item per update date; preserves each stock entry's timestamp
GroupItems = 1 — one row per item per bin/batch/best-before-date combination; returns MAX(UpdateDate)

Results are ordered by UpdateDate ascending.