pixiGetOrderChanges · Pixi API documentation

Collects change events for orders in the time window from DateFrom (inclusive) to DateTo (exclusive) and returns them as a flat list. It is meant for polling clients that synchronise orders into an external system.

If DateFrom is not given, it defaults to the current time minus one day. If DateTo is not given, it defaults to the current time.

Depending on ChangeType, one or all of these checks run:

CORDER: order headers whose CreateDate is in the window. Param1 is empty.
UORDER: order headers whose UpdateDate is in the window. Param1 is empty.
CORDERL: order lines whose CreateDate is in the window. One row per order line; Param1 holds the OrderlineKey.
UORDERL: order lines whose UpdateDate is in the window. One row per order line; Param1 holds the OrderlineKey.
IORDER: invoices whose InvDate is in the window. One row per order and invoice; Param1 holds the InvoiceNr.
SORDER: invoices whose ScanOutDate is in the window. One row per order and invoice; Param1 holds the InvoiceNr.

ALL (default) runs all six checks.

Optional filters:

ShopID: for header events, the shop of the order address (AddrShopId). For line events, the shop of the order line (OrdShopID). For invoice events, the shop of the invoice (InvShopID).
PaymentType: for header and line events, the payment type of the address (APayment). For invoice events, the payment type of the invoice (Payment).

Only rows with OrderNr > 0 are returned. Rows are sorted by OrderNr, then ChangeType, then Param1, all ascending.

Notes

All reads use NOLOCK, so uncommitted changes can appear and rows can be missed or duplicated under concurrent load.
The window is half-open (>= DateFrom, < DateTo). Use the previous DateTo as the next DateFrom to poll without gaps or overlaps.
Results are not de-duplicated. The same order can appear several times: with several change types, with several order lines or with several invoices.
CORDER/UORDER use an inner join on the order address. Order headers without a matching address are not reported.
Param1 is a varchar, so it sorts as text: OrderlineKey and InvoiceNr values sort alphabetically, not numerically.
An unknown ChangeType value raises no error; it simply returns an empty result.
No error rows are produced.

Tables used

OrderHeader · Read Addresses · Read Orderlines · Read Invoices · Read Invlines · Read

Parameter	Type	Default	Description
`ChangeType`	varchar(10) string	ALL	Type of change to report. `ALL` returns all types. Allowed values `ALL` – All change types `CORDER` – Order headers created in the window `UORDER` – Order headers updated in the window `CORDERL` – Order lines created in the window `UORDERL` – Order lines updated in the window `IORDER` – Orders invoiced in the window (by invoice date) `SORDER` – Invoices scanned out in the window (by scan-out date) Example: `ALL`
`ShopID`	varchar(3) string	NULL	Optional shop filter. It is applied to the address shop, the order line shop or the invoice shop, depending on the change type. `NULL` returns all shops. Example: `001`
`PaymentType`	char(1) string	NULL	Optional payment type filter. It is applied to the address payment type (`APayment`) or the invoice payment type (`Payment`). `NULL` returns all payment types. Example: `V`
`DateFrom`	datetime dateTime	NULL	Start of the time window (inclusive). Defaults to the current time minus one day. Example: `2024-05-01T00:00:00`
`DateTo`	datetime dateTime	NULL	End of the time window (exclusive). Defaults to the current time. Example: `2024-05-02T00:00:00`

Result set 1 · Always (may be empty)

One row per detected change, sorted by OrderNr, ChangeType and Param1.

Column	Type	Description
`OrderNr` Nullable	int	Order number of the affected order
`ChangeType` Nullable	varchar(10) string	Type of change: `CORDER`, `UORDER`, `CORDERL`, `UORDERL`, `IORDER` or `SORDER`
`Timestamp` Nullable	datetime dateTime	Time of the change. This is the create date, update date, invoice date or scan-out date, depending on the change type.
`Param1` Nullable	varchar(100) string	Additional reference: `OrderlineKey` for `CORDERL`/`UORDERL`, `InvoiceNr` for `IORDER`/`SORDER`, `NULL` for `CORDER`/`UORDER`.

Response example

<SqlRowSet1>
  <row>
    <OrderNr>100245</OrderNr>
    <ChangeType>CORDER</ChangeType>
    <Timestamp>2024-05-01T09:15:22</Timestamp>
  </row>
  <row>
    <OrderNr>100245</OrderNr>
    <ChangeType>CORDERL</ChangeType>
    <Timestamp>2024-05-01T09:15:23</Timestamp>
    <Param1>587311</Param1>
  </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:pixiGetOrderChanges>
      <!-- <ChangeType>ALL</ChangeType> -->
      <!-- <ShopID>001</ShopID> -->
      <!-- <PaymentType>V</PaymentType> -->
      <!-- <DateFrom>2024-05-01T00:00:00</DateFrom> -->
      <!-- <DateTo>2024-05-02T00:00:00</DateTo> -->
    </ns1:pixiGetOrderChanges>
  </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:pixiGetOrderChanges>
      <!-- <ChangeType>ALL</ChangeType> -->
      <!-- <ShopID>001</ShopID> -->
      <!-- <PaymentType>V</PaymentType> -->
      <!-- <DateFrom>2024-05-01T00:00:00</DateFrom> -->
      <!-- <DateTo>2024-05-02T00:00:00</DateTo> -->
    </ns1:pixiGetOrderChanges>
  </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 = [
    // 'ChangeType' => 'ALL',
    // 'ShopID' => '001',
    // 'PaymentType' => 'V',
    // 'DateFrom' => '2024-05-01T00:00:00',
    // 'DateTo' => '2024-05-02T00:00:00',
];

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

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