pixiGetOrderlineHistory · Pixi API documentation

Reads all entries from the orderhistory table that belong to the order line given in OrderlineKey (column OrderLineRef).

For each status change the call returns:

the date of the change,
the status that was set,
the user who made the change,
whether the customer was notified,
the key of the history entry.

Rows are sorted by StatusChangeDate ascending, so the oldest change comes first. If the order line has no history entries or does not exist, an empty result set is returned.

Notes

The table is read with NOLOCK, so uncommitted changes may be visible.
No error is raised for an unknown order line key; the result is simply empty.
The column UpdateEmp is returned as UpdateUser and OrderHistKey as OrderlineHistKey.

Tables used

orderhistory · Read

Parameter	Type	Default	Description
`OrderlineKey` Required	int	–	Key of the order line whose status history is returned (matched against `OrderLineRef` in `orderhistory`). Example: `123456`

Result set 1 · Always; empty if no history entries exist for the order line.

One row per status change of the order line, oldest first.

Column	Type	Description
`StatusChangeDate` Nullable	dateTime	Date and time of the status change.
`Status` Nullable	string	Status of the order line set by this change.
`UpdateUser` Nullable	string	User who made the change (column `UpdateEmp`).
`ClientNotified` Nullable	string	Indicates whether the customer was notified about the status change.
`OrderlineHistKey`	int	Key of the history entry (column `OrderHistKey`).

Response example

<SqlRowSet1>
  <row>
    <StatusChangeDate>2024-03-11T09:15:22</StatusChangeDate>
    <Status>AUF</Status>
    <UpdateUser>API</UpdateUser>
    <ClientNotified>0</ClientNotified>
    <OrderlineHistKey>987001</OrderlineHistKey>
  </row>
  <row>
    <StatusChangeDate>2024-03-12T14:02:10</StatusChangeDate>
    <Status>AUS</Status>
    <UpdateUser>lager01</UpdateUser>
    <ClientNotified>1</ClientNotified>
    <OrderlineHistKey>987245</OrderlineHistKey>
  </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:pixiGetOrderlineHistory>
      <OrderlineKey>123456</OrderlineKey>
    </ns1:pixiGetOrderlineHistory>
  </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:pixiGetOrderlineHistory>
      <OrderlineKey>123456</OrderlineKey>
    </ns1:pixiGetOrderlineHistory>
  </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 = [
    'OrderlineKey' => '123456',
];

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

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