pixiGetPhysicalItemStock

Scalar function that returns a single integer: the value of LocationQuantity from the location-specific item data for the given location.

Steps:

The item identifiers are normalised: ItemKey = 0 and empty strings for EAN, ItemNrSuppl and ItemNrInt are treated as not set (NULL).
Location-specific item records (ItemLocationSpecific) are joined with the item master (Items) and filtered on LocID = LocationId.
A record matches if any of the supplied identifiers matches: ItemKey, EANUPC = EAN, ItemNrSuppl or ItemNrInt. The identifiers are combined with OR, not AND.
The LocationQuantity of the matching record is returned as Result.

If no record matches, or no identifier is supplied, the result is NULL.

Notes

Reads with NOLOCK, so the value may reflect uncommitted changes.
Because the identifiers are combined with OR, passing several identifiers that belong to different Artikel can match more than one record. In that case the function returns the quantity of one of them, and which one is not defined (no sort order). Pass only one identifier, ideally ItemKey, to get a deterministic result.
EAN, ItemNrSuppl or ItemNrInt may not be unique across items; the same ambiguity applies then.
LocationId has no default and must always be supplied.
The function returns the stored LocationQuantity only; it does not subtract reservations or open orders.

Tables used

ItemLocationSpecific · Read Items · Read

Parameter	Type	Default	Description
`ItemKey`	int	NULL	Internal key of the item. `0` is treated as not set. Example: `12345`
`EAN`	varchar(13) string	NULL	EAN/UPC of the item, compared with `EANUPC`. Empty string is treated as not set. Example: `4006381333931`
`ItemNrSuppl`	varchar(50) string	NULL	Supplier item number. Empty string is treated as not set. Example: `SUP-4711`
`ItemNrInt`	varchar(50) string	NULL	Internal item number. Empty string is treated as not set. Example: `ART-100200`
`LocationId` Required	char(50) string	–	Location (warehouse) ID, compared with `LocID` of the location-specific item data. Example: `001`

Result set 1 · Always (scalar return value; `NULL` if no matching record).

Physical stock quantity of the item at the given location.

Column	Type	Description
`Result` Nullable	int	`LocationQuantity` of the matching item at the location, or `NULL` if none matches.

Response example

<SqlRowSet1>
  <row>
    <Result>42</Result>
  </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:pixiGetPhysicalItemStock>
      <!-- <ItemKey>12345</ItemKey> -->
      <!-- <EAN>4006381333931</EAN> -->
      <!-- <ItemNrSuppl>SUP-4711</ItemNrSuppl> -->
      <!-- <ItemNrInt>ART-100200</ItemNrInt> -->
      <LocationId>001</LocationId>
    </ns1:pixiGetPhysicalItemStock>
  </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:pixiGetPhysicalItemStock>
      <!-- <ItemKey>12345</ItemKey> -->
      <!-- <EAN>4006381333931</EAN> -->
      <!-- <ItemNrSuppl>SUP-4711</ItemNrSuppl> -->
      <!-- <ItemNrInt>ART-100200</ItemNrInt> -->
      <LocationId>001</LocationId>
    </ns1:pixiGetPhysicalItemStock>
  </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' => '12345',
    // 'EAN' => '4006381333931',
    // 'ItemNrSuppl' => 'SUP-4711',
    // 'ItemNrInt' => 'ART-100200',
    'LocationId' => '001',
];

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

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

Notes

Tables used

Result set 1 · Always (scalar return value; NULL if no matching record).

Response example

Result set 1 · Always (scalar return value; `NULL` if no matching record).