pixiCheckPickListNr · Pixi API documentation

Validates a pick list (PLHeader) by its key PickListNr. The call delegates all work to the internal procedure Pixi_CheckPickListNr and always returns exactly one row.

Steps:

Scan state: It checks whether at least one item of the pick list (PLitem) refers to an order line with status EIN. If so, PicklistNotScannedYet is 0. If there is no such line, it is 1.
Number of orders: It counts the distinct order numbers of the pick list whose order lines are not expired (Expired = 0). Orders that already have a box in boxes with WaitForSend = 'N' are left out.
Validity: A pick list is valid if a PLHeader row with PLHkey = PickListNr exists and its PLHexpiryDate is later than the current server time.
- Invalid or expired pick list: the row contains ReturnValue = 0 and all other columns are 0.
- Valid pick list: the row contains ReturnValue = 1, the box range PLHfromBox/PLHtoBox, the 1SS flag (NULL becomes 0), and the values from steps 1 and 2.

Notes

All reads use NOLOCK. Values may reflect uncommitted changes made at the same time.
In the invalid branch the box columns are named PLHFromBox/PLHToBox. In the valid branch they are named PLHfromBox/PLHtoBox. XML element names are case-sensitive, so clients should read them case-insensitively.
The column name 1SS starts with a digit. In the SOAP/DataSet XML it is typically encoded as _x0031_SS.
A non-existing pick list cannot be told apart from an expired one; both return ReturnValue = 0.
Expiry is compared with the database server time (GETDATE()).

Tables used

PLitem · Read Orderlines · Read boxes · Read PLHeader · Read

Parameter	Type	Default	Description
`PickListNr` Required	int	–	Key of the pick list (`PLHeader.PLHkey`) to check. Example: `104523`

Result set 1 · Always; exactly one row. If the pick list is missing or expired, all values are 0.

Validation result for the pick list.

Column	Type	Description
`ReturnValue`	int	`1` if the pick list exists and has not expired, otherwise `0`.
`PLHfromBox` Nullable	int	First box number of the pick list (`PLHeader.PLHfromBox`). `0` for an invalid pick list, where the column is named `PLHFromBox`.
`PLHtoBox` Nullable	int	Last box number of the pick list (`PLHeader.PLHtoBox`). `0` for an invalid pick list, where the column is named `PLHToBox`.
`1SS`	bit boolean	Value of the `1SS` flag of the pick list header; `NULL` is returned as `0`.
`PicklistNotScannedYet`	bit boolean	`0` if at least one order line of the pick list has status `EIN`, otherwise `1`. Always `0` for an invalid pick list.
`NumberOfOrders`	int	Number of distinct orders on the pick list with non-expired order lines and no box with `WaitForSend = 'N'`.

Response example

<SqlRowSet1>
  <row>
    <ReturnValue>1</ReturnValue>
    <PLHfromBox>1</PLHfromBox>
    <PLHtoBox>24</PLHtoBox>
    <_x0031_SS>false</_x0031_SS>
    <PicklistNotScannedYet>true</PicklistNotScannedYet>
    <NumberOfOrders>18</NumberOfOrders>
  </row>
</SqlRowSet1>

Status	Message	Cause
0	ReturnValue = 0	No `PLHeader` row with this key exists, or its `PLHexpiryDate` is not later than the current time. Pass the key of an existing, non-expired pick list.

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:pixiCheckPickListNr>
      <PickListNr>104523</PickListNr>
    </ns1:pixiCheckPickListNr>
  </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:pixiCheckPickListNr>
      <PickListNr>104523</PickListNr>
    </ns1:pixiCheckPickListNr>
  </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 = [
    'PickListNr' => '104523',
];

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

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