pixiGetItemLogisticsStock · Pixi API documentation

Calculates the stock of a single item for direct fulfillment (DF) purposes, as stated in the code comment: stock based on open DF orders.

Steps:

Sums BinItemQty of all bin entries in InvBinItem for the item @ItemKey whose bin (InvBin) belongs to the location @Location (BinLocId). This sum is returned as TotalQty (0 if there are no matching bins).
Sums Qty of all order lines in Orderlines for the item that
- have status FUT,
- have Qty > 0, and
- have no entry in OrderHistory with status FUT and ClientNotified = 'N'.
Returns TotalQty minus the order line sum as FulfillmentAvailableQty, together with the passed @Location.

The call always returns exactly one row, because the query aggregates without grouping.

Notes

If @Location is omitted (NULL), the comparison BinLocId = NULL never matches, so TotalQty is always 0 and FulfillmentAvailableQty is 0 or negative. Always pass a location.
The open order line quantity is not filtered by location: FUT order lines of all locations are subtracted from the stock of the given location.
FulfillmentAvailableQty can become negative when open FUT quantities exceed the bin stock.
An unknown @ItemKey does not cause an error; the call returns a row with 0 values.
All tables are read with NOLOCK, so the result may include uncommitted data.

Tables used

InvBinItem · Read InvBin · Read Orderlines · Read OrderHistory · Read

Parameter	Type	Default	Description
`ItemKey` Required	int	–	Internal key of the item whose stock is calculated (matched against `InvBinItem.BinItemRef` and `Orderlines.ItemRef`). Example: `10452`
`Location`	char(3) string	NULL	Location code (`InvBin.BinLocId`) whose bins are summed. Also echoed in the result. If NULL, no bins match and the stock is 0. Example: `001`

Result set 1 · Always (exactly one row)

Stock figures of the item at the requested location.

Column	Type	Description
`FulfillmentAvailableQty`	int	Bin stock at the location minus the quantity of open FUT order lines of the item (all locations). Can be negative.
`TotalQty`	int	Sum of `BinItemQty` of all bins of the item at the location; 0 if none.
`Location` Nullable	char(3) string	The location passed in `@Location`.

Response example

<SqlRowSet1>
  <row>
    <FulfillmentAvailableQty>37</FulfillmentAvailableQty>
    <TotalQty>45</TotalQty>
    <Location>001</Location>
  </row>
</SqlRowSet1>

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiGetItemLogisticsStock>
      <ItemKey>10452</ItemKey>
      <!-- <Location>001</Location> -->
    </ns1:pixiGetItemLogisticsStock>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiGetItemLogisticsStock>
      <ItemKey>10452</ItemKey>
      <!-- <Location>001</Location> -->
    </ns1:pixiGetItemLogisticsStock>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    'ItemKey' => '10452',
    // 'Location' => '001',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetItemLogisticsStock', $soapArguments);