pixi Developer & Integration Documentation

pixiGetItemLogistics

Description

Returns item data for fulfillment partner synchronization. Only active, non-bundle items are included. Results are paginated by item ID using StartKey and RowCount.

To retrieve all items, call repeatedly: pass the last received ItemKey as the next StartKey and repeat until the number of rows returned is less than RowCount.

The VPE field (packing unit) reflects the item's order unit when the item is the sole component of exactly one bundle whose quantity matches the item's order unit. Otherwise VPE is 1.


Request Parameters

#

Name

Type

Required

Example

Description

1

StartKey

int

0

0

Returns items with an ItemKey greater than this value. Use 0 to start from the beginning. Pass the last received ItemKey to fetch the next page.

2

RowCount

int

0

1000

Maximum number of items to return per call. Defaults to 1000.


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:pipiGetItemLogistics>
<dem:StartKey>0</dem:StartKey>
<dem:RowCount>1000</dem:RowCount>
</dem:pipiGetItemLogistics>
</soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Item Logistics Data

#

Name

Type

Description

1

ItemKey

int

Item ID. Use as the StartKey value for the next page request.

2

ItemName

varchar(120)

Item name.

3

VPE

int

Packing unit. Set to the item's order unit when the item is the sole component of a single-component bundle matching its order quantity; otherwise 1.

4

Tags

varchar(8000)

Pipe-separated list of tags assigned to the item. Empty string if no tags are assigned.


Additional Notes

Only active, non-bundle items are returned (items flagged as enabled and not marked as bundles).

Results are ordered by ItemKey ascending. To paginate through all items:
1. Call with StartKey = 0
2. Note the last ItemKey in the response
3. Call again with StartKey = {last ItemKey}
4. Repeat until the number of rows returned is less than RowCount