pixi Developer & Integration Documentation

pixiItemSearch

Description

Searches for items with optional filtering by name, category, supplier, barcode, and location. Returns comprehensive item data including pricing, stock quantities, order statistics, and sales demand figures.

All parameters are optional. Use RowCount = 0 to return all matching items (no limit). Supplier prices are always included in the response.


Request Parameters

#

Name

Type

Required

Example

Description

1

RowCount

int

0

100

Maximum number of items to return. Use 0 (default) to return all matching items.

2

ItemName

varchar(100)

0

Bluetooth Speaker

Filter by item name. Leave empty to return all items regardless of name.

3

ConfigType

varchar(4)

0

ELEC

Filter by category ID. Leave empty to include all categories.

4

SupplNr

varchar(4)

0

S001

Filter by supplier code. Leave empty to include items from all suppliers.

5

EANUPC

varchar(13)

0

2000000000091

Filter by item barcode (EAN/UPC). Leave empty to include all items.

6

LocID

varchar(3)

0

001

Location ID used to calculate LocationQuantity. Defaults to 001.

7

ShowOnlyItemsForExactSupplier

bit

0

0

0 (default) — returns items linked to any supplier. 1 — returns only items linked to the exact SupplNr provided. Automatically set to 0 if SupplNr is empty.


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:pipiItemSearch>
<dem:RowCount>100</dem:RowCount>
<dem:ItemName></dem:ItemName>
<dem:ConfigType></dem:ConfigType>
<dem:SupplNr></dem:SupplNr>
<dem:EANUPC></dem:EANUPC>
<dem:LocID>001</dem:LocID>
<dem:ShowOnlyItemsForExactSupplier>0</dem:ShowOnlyItemsForExactSupplier>
</dem:pipiItemSearch>
</soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Item Data

#

Name

Type

Description

1

ItemKey

int

Item ID.

2

ItemName

varchar(120)

Item name.

3

ItemNrInt

varchar(50)

Item shop number.

4

TonTrText

varchar(50)

Category name.

5

IntLinkNr1

int

Internal link number.

6

MwStSatz

smallint

VAT class code (High, Low, Zero).

7

EANUPC

varchar(13)

Item barcode (EAN/UPC).

8

UPC

varchar(13)

Item UPC code.

9

ItemNrSuppl

varchar(50)

Supplier item number.

10

SupplNr

varchar(4)

Supplier code.

11

ConfigType

varchar(4)

Category ID.

12

Price

decimal

Item price including VAT.

13

Price_Net

decimal

Item price excluding VAT.

14

CurrencyID

smallint

Currency ID for item price.

15

Curr_Source

varchar(3)

Currency code for item price (e.g. EUR).

16

MusicType

varchar(4)

Deprecated. Always NULL.

17

TitleRef

int

Deprecated. Always NULL.

18

ArtistRef

int

Deprecated. Always NULL.

19

SupplPrice

money

Supplier price for the item.

20

SupplPriceCurrencyId

smallint

Currency ID for supplier price.

21

SupplPriceCurrency

varchar(3)

Currency code for supplier price (e.g. EUR).

22

Enabled

bit

Indicates whether the item is enabled (1 = enabled, 0 = disabled).

23

Manufacturer

varchar(100)

Manufacturer name.

24

MinOrderQty

int

Minimum order quantity for the item.

25

MinStockQty

int

Minimum stock quantity configured for the item.

26

SummaryQuantity

int

Total item quantity across all locations.

27

LocationQuantity

int

Item quantity at the location specified in the LocID parameter.

28

BundleItemsCnt

int

Number of bundles this item appears in as a component.

29

Weight

decimal

Item weight in grams.

30

VAT

decimal

VAT rate as a percentage.

31

Hal_Cust_O

int

Number of customer orders in HAL status containing this item.

32

Open_Cust_O

int

Number of open customer orders containing this item.

33

Open_Suppl_O

int

Number of open supplier orders containing this item.

34

SOrderlinesNote

varchar(1024)

Note from the supplier order line.

35

L30

int

Item demand (quantity sold) in the last 30 days.

36

L120

int

Item demand in the last 120 days.

37

L365

int

Item demand in the last 365 days.

38

IsAvailable

int

1 if the item's stock is at or above the minimum stock quantity; 0 otherwise.

39

Selected

bit

Deprecated. Always returns 0.

40

DispoSelected

bit

Deprecated. Always returns 0.

41

InternalItemCode

varchar(50)

Internal item code.

42

IsBundle

bit

Indicates whether the item is a bundle (1 = bundle, 0 = regular item).

43

Quantity

int

Item quantity exported to connected external systems.


Additional Notes

Use RowCount = 0 to retrieve all matching items without a row limit. For large item catalogues, consider using a non-zero RowCount to limit response size.

Fields MusicType, TitleRef, ArtistRef, Selected, and DispoSelected are deprecated and retained for backwards compatibility only.

When SupplNr is empty, ShowOnlyItemsForExactSupplier is automatically set to 0.