pixiGetItemDeliveryInfo · Pixi API documentation

Looks up incoming supplier deliveries for an item.

Empty strings in EAN, ItemNrSuppl and ItemNrInt and the value 0 in ItemKey are treated as not set.
The item is identified by any of the given identifiers. The criteria are combined with OR: a supplier order line is returned if its item matches ItemKey, or the EAN/UPC (EANUPC), or the supplier item number, or the internal item number.
Only supplier order lines are returned whose supplier order has a status flagged as ordered/confirmed (IsOrderedConfirmed = 1, i.e. the statuses BES and BGT) and whose quantity is greater than 0.
For each line the supplier order number, the supplier number, the ordered quantity and the estimated delivery date are returned.

Sort order: lines with an estimated delivery date come first, sorted ascending by that date; lines without a delivery date come last.

If no identifier is passed, no rows are returned.

Notes

All tables are read with NOLOCK; uncommitted data may appear.
Because the identifiers are combined with OR, passing several identifiers that belong to different Artikel returns the lines of all of them. The result contains no item column, so the rows cannot be assigned to an item afterwards. Pass only one identifier to get unambiguous results.
SupplierOrderQty is the quantity of the supplier order line as stored; the code does not subtract quantities that have already been received.
EstimatedDelivery is converted to datetime and is empty if the line has no estimated delivery date.

Tables used

SupplierOrderLine · Read SupplierOrder · Read SupplierOrderStatus · Read Suppliers · Read items · Read

Parameter	Type	Default	Description
`ItemKey`	int	NULL	Internal key of the item (`ItemKey`). `0` is treated as not set. Example: `4711`
`EAN`	varchar(13) string	NULL	EAN/UPC of the item, compared with `EANUPC`. An empty string is treated as not set. Example: `4006381333931`
`ItemNrSuppl`	varchar(50) string	NULL	Supplier item number of the item (`ItemNrSuppl`). An empty string is treated as not set. Example: `LF-100-BLK`
`ItemNrInt`	varchar(50) string	NULL	Internal item number (`ItemNrInt`). An empty string is treated as not set. Example: `A-10023`

Result set 1 · Always; empty if no identifier is given or no matching ordered/confirmed supplier order line exists.

One row per matching supplier order line, lines with delivery date first (ascending), lines without delivery date last.

Column	Type	Description
`SupplierOrderNr`	int	ID of the supplier order (`SupplierOrder.Id`).
`SupplNr` Nullable	string	Supplier number of the supplier of the order.
`SupplierOrderQty`	decimal	Quantity of the supplier order line (always greater than 0).
`EstimatedDelivery` Nullable	datetime dateTime	Estimated delivery date of the line, converted to `datetime`; empty if not set.

Response example

<SqlRowSet1>
  <row>
    <SupplierOrderNr>10234</SupplierOrderNr>
    <SupplNr>L1001</SupplNr>
    <SupplierOrderQty>50</SupplierOrderQty>
    <EstimatedDelivery>2024-06-12T00:00:00</EstimatedDelivery>
  </row>
  <row>
    <SupplierOrderNr>10251</SupplierOrderNr>
    <SupplNr>L1007</SupplNr>
    <SupplierOrderQty>20</SupplierOrderQty>
  </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:pixiGetItemDeliveryInfo>
      <!-- <ItemKey>4711</ItemKey> -->
      <!-- <EAN>4006381333931</EAN> -->
      <!-- <ItemNrSuppl>LF-100-BLK</ItemNrSuppl> -->
      <!-- <ItemNrInt>A-10023</ItemNrInt> -->
    </ns1:pixiGetItemDeliveryInfo>
  </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:pixiGetItemDeliveryInfo>
      <!-- <ItemKey>4711</ItemKey> -->
      <!-- <EAN>4006381333931</EAN> -->
      <!-- <ItemNrSuppl>LF-100-BLK</ItemNrSuppl> -->
      <!-- <ItemNrInt>A-10023</ItemNrInt> -->
    </ns1:pixiGetItemDeliveryInfo>
  </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' => '4711',
    // 'EAN' => '4006381333931',
    // 'ItemNrSuppl' => 'LF-100-BLK',
    // 'ItemNrInt' => 'A-10023',
];

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

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