pixi Developer & Integration Documentation

pixiGetItemLogisticsStock

Description

Returns the available stock quantity for an item at a specified fulfillment location, accounting for quantities already reserved by open Direct Fulfillment (FUT) orders that are pending dispatch notification to the fulfillment partner.

ItemKey is required. Location should always be provided — omitting it results in a TotalQty of 0 as no bins are matched.


Request Parameters

#

Name

Type

Required

Example

Description

1

ItemKey

int

1

3690

Item ID to check stock for.

2

Location

char(3)

0

001

Location ID of the fulfillment location to check. Should always be provided — omitting returns 0 stock.


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:pipiGetItemLogisticsStock>
<dem:ItemKey>3690</dem:ItemKey>
<dem:Location>001</dem:Location>
</dem:pipiGetItemLogisticsStock>
</soapenv:Body>
</soapenv:Envelope>


Response


Body 1: Fulfillment Stock Availability

#

Name

Type

Description

1

FulfillmentAvailableQty

int

Available quantity for fulfillment. Calculated as TotalQty minus quantities reserved by open Direct Fulfillment orders pending dispatch notification.

2

TotalQty

int

Total quantity of the item in bins at the specified location.

3

Location

char(3)

Location ID as supplied in the request.


Additional Notes

FulfillmentAvailableQty is calculated as:
TotalQty - SUM of open Direct Fulfillment (FUT) order quantities pending dispatch notification

A FUT order quantity is considered reserved (deducted) when the fulfillment partner has not yet been notified of the dispatch. Once notified, the quantity is no longer deducted.

If the item has no stock at the specified location, both FulfillmentAvailableQty and TotalQty return 0.