pixiGetOrdersReadyForPickup · Pixi API documentation

Lists orders that are ready for pickup by the customer at a point-of-sale location.

An order is returned if it has at least one order line that meets all of these conditions:

the order line's LocationID equals LocationId;
the line's location exists in Location and has a reservation location (ResLocID) that also exists in Location;
the line's CustRef refers to an existing customer in Customers;
a reservation exists for the line in Reservation (ResOrderlineRef = order line key);
the line status is ANG or HAL;
the order date is not older than the reservation expiry in days: ResExpDays of the reservation location, or, if that is NULL, the value of the setting ReservationExpiry.

In addition, the whole order is excluded if any of its order lines refers to an item that has no ItemLocationSpecific record for the reservation location. Only the existence of that record is checked, not stock quantities.

The result is distinct per order number and customer and is sorted by order number in ascending order.

Notes

If LocationId is omitted (NULL), the comparison with LocationID never matches and the result is always empty. Always pass a location.
Pitfall with the expiry fallback: the code falls back to 14 days only if the setting ReservationExpiry returns an empty string. fPIXI_GetSetting returns '0' when the setting does not exist, so without the setting and without ResExpDays on the reservation location only orders dated today are returned.
The expiry is measured in calendar days between the order date and the current server date (DATEDIFF in days).
All tables are read with NOLOCK, so uncommitted data may appear.
Read only; no data is changed.

Tables used

Orderlines · Read Location · Read Customers · Read Reservation · Read ItemLocationSpecific · Read Settings · Read

Parameter	Type	Default	Description
`LocationId`	varchar(50) string	NULL	ID of the POS location (`Location.LocID`) whose order lines are checked. Must be set; with NULL no rows are returned. Example: `POS`

Result set 1 · Always (may be empty)

One row per order ready for pickup, sorted by order number ascending.

Column	Type	Description
`ordernr`	int	Order number (`Orderlines.OrderNr`).
`CustRef`	int	Customer key of the order line (`Orderlines.CustRef`, refers to `Customers.CustKey`).

Response example

<SqlRowSet1>
  <row>
    <ordernr>100245</ordernr>
    <CustRef>5821</CustRef>
  </row>
  <row>
    <ordernr>100251</ordernr>
    <CustRef>6034</CustRef>
  </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:pixiGetOrdersReadyForPickup>
      <!-- <LocationId>POS</LocationId> -->
    </ns1:pixiGetOrdersReadyForPickup>
  </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:pixiGetOrdersReadyForPickup>
      <!-- <LocationId>POS</LocationId> -->
    </ns1:pixiGetOrdersReadyForPickup>
  </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 = [
    // 'LocationId' => 'POS',
];

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

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