pixiReadItemBinLog · Pixi API documentation

Reads rows from the bin location item log InvBinItemLog. Each row describes a quantity booking of an Artikel on a Lagerplatz.

Paging

ItemBinLogKey is an exclusive lower bound. Only rows with IBILkey greater than this value are returned. If it is omitted or NULL, 0 is used, so the call starts at the beginning of the log.
RowCount limits the number of rows. The default is 1000; NULL is also treated as 1000.
Rows are always sorted by IBILkey ascending. To read the next page, pass the highest IBILkey of the previous page as ItemBinLogKey.

Date filters

Only one group of date filters is used. The groups are checked in this order, and the first group with at least one value set wins:

CreateAndUpdateDateFrom / CreateAndUpdateDateTo: the lower bound matches if UpdateDate or ReportedDate is >= From. The upper bound matches if UpdateDate or ReportedDate is < To.
CreateDateFrom / CreateDateTo: filters on the column UpdateDate (>= From, < To).
UpdateDateFrom / UpdateDateTo: filters on the column ReportedDate (>= From, < To).

In each group, either bound can be omitted. Upper bounds are exclusive. If no date parameter is set, the call returns the next RowCount rows after ItemBinLogKey.

Notes

The table is read WITH (NOLOCK). Rows that are not yet committed can appear, and rows can be missing or appear twice.
ItemBinLogKey cannot fetch a single entry. Passing a key returns the rows after that key, never the row with that key. The code contains branches for an exact key lookup and for an empty result, but they are never reached, because ItemBinLogKey and RowCount are replaced with non-NULL values at the start.
The parameter names do not match the column names. CreateDate* filters on UpdateDate, and UpdateDate* filters on ReportedDate.
In the combined filter, the From and To conditions are evaluated independently. A row can match the lower bound through one column and the upper bound through the other.
Date parameters of a lower-priority group are ignored as soon as a higher-priority group has a value.
The column data types are not visible in the code, except IBILkey (compared with an int) and the date columns (compared with datetime values).

Tables used

InvBinItemLog · Read

Parameter	Type	Default	Description
`ItemBinLogKey`	int	NULL	Exclusive lower bound for `IBILkey`. Only rows with a greater key are returned. NULL is treated as 0. Example: `125430`
`CreateDateFrom`	datetime dateTime	NULL	Returns rows with `UpdateDate` >= this value. Ignored if a combined date filter is set. Example: `2024-05-01T00:00:00`
`CreateDateTo`	datetime dateTime	NULL	Returns rows with `UpdateDate` < this value (exclusive). Ignored if a combined date filter is set. Example: `2024-05-02T00:00:00`
`UpdateDateFrom`	datetime dateTime	NULL	Returns rows with `ReportedDate` >= this value. Used only if no combined or create date filter is set. Example: `2024-05-01T00:00:00`
`UpdateDateTo`	datetime dateTime	NULL	Returns rows with `ReportedDate` < this value (exclusive). Used only if no combined or create date filter is set. Example: `2024-05-02T00:00:00`
`CreateAndUpdateDateFrom`	datetime dateTime	NULL	Lower bound of the combined filter. A row matches if `UpdateDate` or `ReportedDate` is >= this value. This group has the highest priority. Example: `2024-05-01T00:00:00`
`CreateAndUpdateDateTo`	datetime dateTime	NULL	Upper bound of the combined filter (exclusive). A row matches if `UpdateDate` or `ReportedDate` is < this value. Example: `2024-05-02T00:00:00`
`RowCount`	int	1000	Maximum number of rows returned. NULL is treated as 1000. Example: `500`

Result set 1 · Always; can be empty if no rows match.

Log entries from InvBinItemLog, sorted by IBILkey ascending, at most RowCount rows.

Column	Type	Description
`IBILkey`	int	Primary key of the log entry; used for paging.
`LocID` Nullable	string	Location (warehouse) identifier.
`BinRef` Nullable	int	Reference to the Lagerplatz (bin location).
`Qty` Nullable	int	Booked quantity.
`ItemRef` Nullable	int	Reference to the Artikel.
`UpdateEmp` Nullable	string	Employee who made the booking.
`UpdateDate` Nullable	datetime dateTime	Timestamp of the entry. The `CreateDate*` parameters filter on this column.
`ReportedDate` Nullable	datetime dateTime	Reported timestamp. The `UpdateDate*` parameters filter on this column.
`ForOrderline` Nullable	int	Reference to the order line the booking belongs to, if any.
`Reason` Nullable	string	Reason of the booking.
`SMORef` Nullable	int	Reference value `SMORef` stored in the log. Its meaning is not visible in the code.
`SMTRef` Nullable	int	Reference value `SMTRef` stored in the log. Its meaning is not visible in the code.
`DeliveryId` Nullable	string	Delivery identifier linked to the booking.

Response example

<SqlRowSet1>
  <row>
    <IBILkey>125431</IBILkey>
    <LocID>001</LocID>
    <BinRef>4711</BinRef>
    <Qty>-2</Qty>
    <ItemRef>88213</ItemRef>
    <UpdateEmp>MM</UpdateEmp>
    <UpdateDate>2024-05-01T09:14:22.000</UpdateDate>
    <ReportedDate>2024-05-01T09:14:22.000</ReportedDate>
    <ForOrderline>553201</ForOrderline>
    <Reason>Pick</Reason>
    <SMORef>0</SMORef>
    <SMTRef>0</SMTRef>
    <DeliveryId>DL-20240501-17</DeliveryId>
  </row>
  <row>
    <IBILkey>125432</IBILkey>
    <LocID>001</LocID>
    <BinRef>4802</BinRef>
    <Qty>10</Qty>
    <ItemRef>88214</ItemRef>
    <UpdateEmp>JS</UpdateEmp>
    <UpdateDate>2024-05-01T09:20:05.000</UpdateDate>
    <ReportedDate>2024-05-01T09:20:05.000</ReportedDate>
    <ForOrderline>0</ForOrderline>
    <Reason>Booking</Reason>
    <SMORef>0</SMORef>
    <SMTRef>0</SMTRef>
    <DeliveryId/>
  </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:pixiReadItemBinLog>
      <!-- <ItemBinLogKey>125430</ItemBinLogKey> -->
      <!-- <CreateDateFrom>2024-05-01T00:00:00</CreateDateFrom> -->
      <!-- <CreateDateTo>2024-05-02T00:00:00</CreateDateTo> -->
      <!-- <UpdateDateFrom>2024-05-01T00:00:00</UpdateDateFrom> -->
      <!-- <UpdateDateTo>2024-05-02T00:00:00</UpdateDateTo> -->
      <!-- <CreateAndUpdateDateFrom>2024-05-01T00:00:00</CreateAndUpdateDateFrom> -->
      <!-- <CreateAndUpdateDateTo>2024-05-02T00:00:00</CreateAndUpdateDateTo> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiReadItemBinLog>
  </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:pixiReadItemBinLog>
      <!-- <ItemBinLogKey>125430</ItemBinLogKey> -->
      <!-- <CreateDateFrom>2024-05-01T00:00:00</CreateDateFrom> -->
      <!-- <CreateDateTo>2024-05-02T00:00:00</CreateDateTo> -->
      <!-- <UpdateDateFrom>2024-05-01T00:00:00</UpdateDateFrom> -->
      <!-- <UpdateDateTo>2024-05-02T00:00:00</UpdateDateTo> -->
      <!-- <CreateAndUpdateDateFrom>2024-05-01T00:00:00</CreateAndUpdateDateFrom> -->
      <!-- <CreateAndUpdateDateTo>2024-05-02T00:00:00</CreateAndUpdateDateTo> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiReadItemBinLog>
  </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 = [
    // 'ItemBinLogKey' => '125430',
    // 'CreateDateFrom' => '2024-05-01T00:00:00',
    // 'CreateDateTo' => '2024-05-02T00:00:00',
    // 'UpdateDateFrom' => '2024-05-01T00:00:00',
    // 'UpdateDateTo' => '2024-05-02T00:00:00',
    // 'CreateAndUpdateDateFrom' => '2024-05-01T00:00:00',
    // 'CreateAndUpdateDateTo' => '2024-05-02T00:00:00',
    // 'RowCount' => '500',
];

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

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