pixi Developer & Integration Documentation

pixiReport_ItemsOnStockWithBatchManagement

Description

Returns the pixi report Items on stock with BN/BBD: all items tagged for batch number (BN) or best before date (BBD) that are currently on stock, with their batch number, best before date, bin, bin group, and quantity per bin.

Use the best before date range to find stock that expires soon, or BatchNumber to find where a specific batch is stored. Use LocId and BinGroup to limit the report to areas of your warehouse, and ItemTag, Category, SupplierNr, Ean, or ItemNrInt to limit it to specific items. All parameters are optional and can be combined.

Every filter value you provide is checked first. If a value does not exist in pixi, the call returns Body 2 with Status = Error and a message naming the invalid value, and no report data. On success, the call returns Body 1.


Request Parameters

#

Name

Type

Required

Example

Description

1

BatchNumber

string

0

LOT2026-0815

Filter: batch number. Must exist in stock. If empty, all batch numbers are returned.

2

BestBeforeDateFrom

datetime

0

2026-10-01

Filter: best before date from (inclusive). Default: 1900-01-01. The time part is ignored.

3

BestBeforeDateTo

datetime

0

2026-12-31

Filter: best before date to (inclusive). Default: 2100-12-31. The time part is ignored.

4

LocId

string

0

001

Filter: location ID (max. 3 characters). Must be an existing location. If empty, all locations are returned.

5

Ean

string

0

4006381333931

Filter: item barcode (EAN/UPC, max. 13 characters). Must be an existing item barcode. If empty, all items are returned.

6

ItemTag

integer

0

-7

Filter: item tag. Allowed values: -6 (Batch Number) or -7 (Best Before Date). If empty, items with either tag are returned.

7

SupplierNr

string

0

ABCD

Filter: supplier number (max. 4 characters). Must be an existing supplier. Returns items from this supplier.

8

BinGroup

string

0

A-01

Filter: bin group. Must be an existing bin group. If empty, all bin groups are returned.

9

Category

string

0

123

Filter: item category, by category ID or category name. Must be an existing category. If empty, all categories are returned.

10

ItemNrInt

string

0

ITEM-1001

Filter: shop item number. Must be an existing shop item number. If empty, all items 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:pixiReport_ItemsOnStockWithBatchManagement>
<dem:BatchNumber>LOT2026-0815</dem:BatchNumber>
<dem:BestBeforeDateFrom>2026-10-01</dem:BestBeforeDateFrom>
<dem:BestBeforeDateTo>2026-12-31</dem:BestBeforeDateTo>
<dem:LocId>001</dem:LocId>
<dem:Ean>4006381333931</dem:Ean>
<dem:ItemTag>-7</dem:ItemTag>
<dem:SupplierNr>ABCD</dem:SupplierNr>
<dem:BinGroup>A-01</dem:BinGroup>
<dem:Category>123</dem:Category>
<dem:ItemNrInt>ITEM-1001</dem:ItemNrInt>
</dem:pixiReport_ItemsOnStockWithBatchManagement>
</soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Items on stock with BN/BBD

#

Name

Type

Description

1

ItemKey

integer

pixi item ID.

2

ItemNrSuppl

string

Supplier item number.

3

ItemNrInt

string

Shop item number.

4

EANUPC

string

Item barcode (EAN/UPC).

5

ItemName

string

Item name.

6

BatchNumber

string

Batch number of the stock in this bin. Empty if the item has no batch number.

7

BestBeforeDate

datetime

Best before date of the stock in this bin. Empty if the item has no best before date.

8

BinName

string

Name of the bin where the item is stored.

9

BinGroup

string

Bin group of the bin.

10

QtyInBin

integer

Quantity of the item in this bin for this batch number and best before date.


Body 2: Error response

#

Name

Type

Description

1

Status

string

Always Error. Returned only when validation fails or an unexpected error occurs.

2

Message

string

Description of the error. See Additional Notes for the possible messages.


Additional Notes

Best before date filter:
- If BestBeforeDateFrom and BestBeforeDateTo are omitted, no date filter is applied (defaults 1900-01-01 to 2100-12-31).
- If only one of them is provided, the other one uses its default. Example: only BestBeforeDateTo = 2026-12-31 returns everything that expires by the end of 2026.
- Both dates are inclusive. The time part is ignored; only the date is used.
- Items without a best before date (for example, items managed by batch number only) are always included, also when a date range is provided.
- Since pixi 26.10, omitting the dates returns all best before dates. Before 26.10, the report was limited to the current day.

Category:
- Category accepts either the category ID or the category name.

ItemTag:
- -6 = Batch Number, -7 = Best Before Date. Any other value is rejected.

Error messages (Body 2, Status = Error):
- Location "{LocId}" does not exist.
- Only item tag with ID -6 and -7 are allowed.
- Item with EAN: "{Ean}" does not exist.
- Item with Shop item number: "{ItemNrInt}" does not exist.
- Bin group with number: "{BinGroup}" does not exist.
- Supplier with supplier number: "{SupplierNr}" does not exist.
- Category with ID: "{Category}" does not exist.
- Batch number: "{BatchNumber}" does not exist.
- Unexpected error while getting the report values. ({details})