pixiImportFindXML

Searches the XML import log C_XMLLog for the latest entry that contains a given ID and returns it with request, response and status information.

If Id is empty or NULL, a status row with StatusCode 400 is returned and nothing else happens.
Type is compared case-insensitively:
- order: looks up the operation type OrderImport in C_OperationTypes and searches log entries whose XmlResponseXml contains an ORDER_ID element (at any depth) whose value equals Id.
- item: looks up the operation type ItemImport and searches for an SUPPLIER_AID element (at any depth) whose value equals Id.
- Any other value returns a status row with StatusCode 400.
Additional filters for both types:
- If Channel is given, only entries with that ChannelRef are considered; if it is NULL, all channels are searched.
- Entries with Status = XNI are excluded.
The result is sorted by XMLLogKey descending and only the first row (the newest matching log entry) is returned. If no entry matches, the result set is empty.

Notes

All reads use NOLOCK, so uncommitted log entries may be returned.
The ID match is an exact string comparison against the element value inside XmlResponseXml using an XPath exist() with a descendant search (//). This is evaluated for every candidate log row and can be slow on large log tables; using Channel narrows the search.
The Id check happens before the Type check, so an empty Id always yields the ID error message even if Type is invalid.
If the operation type OrderImport or ItemImport does not exist in C_OperationTypes, no rows are returned.
The meaning of the status value XNI is not defined in the code.
Response is the XML column XmlResponseXml converted to varchar(max).

Tables used

C_OperationTypes · Read C_XMLLog · Read

Parameter Type Default Description

Parameter	Type	Default	Description
`Type` Required	varchar(10) string	–	Kind of import to search in (case-insensitive). Allowed values `order` – Search order imports (`OrderImport`) by `ORDER_ID`. `item` – Search item imports (`ItemImport`) by `SUPPLIER_AID`. Example: `order`
`Id` Required	varchar(50) string	–	Value to search for: the order ID (`ORDER_ID`) for `order`, or the supplier article number (`SUPPLIER_AID`) for `item`. Must not be empty. Example: `100004711`
`Channel`	int	NULL	Optional channel key (`ChannelRef`) to restrict the search; `NULL` searches all channels. Example: `3`

Type

Required

varchar(10)
string

–

Kind of import to search in (case-insensitive).

Allowed values

order – Search order imports (`OrderImport`) by `ORDER_ID`.
item – Search item imports (`ItemImport`) by `SUPPLIER_AID`.

Example: order

Id

Required

varchar(50)
string

–

Value to search for: the order ID (ORDER_ID) for order, or the supplier article number (SUPPLIER_AID) for item. Must not be empty.

Example: 100004711

Channel

int

NULL

Optional channel key (ChannelRef) to restrict the search; NULL searches all channels.

Example: 3

Result set 1 · If `Id` is empty or `NULL`, or if `Type` is neither `order` nor `item`

Status row describing the validation error.

Column	Type	Description
`StatusCode`	int	Always 400.
`StatusMessage`	varchar(55) string	Error text.

Result set 2 · If `Id` is set and `Type` is `order` or `item`; zero or one row

The newest matching XML import log entry.

Column	Type	Description
`XMLLogKey`	int	Key of the log entry in `C_XMLLog`.
`Request` Nullable	string	Original import request (`XMLRequest`).
`Response` Nullable	varchar(max) string	Content of `XmlResponseXml` converted to text.
`Status` Nullable	string	Processing status of the log entry (never `XNI`).
`CreateDate` Nullable	dateTime	Creation time of the log entry.
`UpdateDate` Nullable	dateTime	Last update time of the log entry.
`Error` Nullable	string	Error information stored for the import.
`XmlResponseCastErrorNr` Nullable	int	Error number from converting the response to XML, if any.
`XmlResponseCastErrorMessage` Nullable	string	Error message from converting the response to XML, if any.

Response example

<SqlRowSet1>
  <row>
    <XMLLogKey>58231</XMLLogKey>
    <Request>&lt;ORDER&gt;...&lt;/ORDER&gt;</Request>
    <Response>&lt;ORDER&gt;&lt;ORDER_HEADER&gt;&lt;ORDER_INFO&gt;&lt;ORDER_ID&gt;100004711&lt;/ORDER_ID&gt;&lt;/ORDER_INFO&gt;&lt;/ORDER_HEADER&gt;&lt;/ORDER&gt;</Response>
    <Status>OK</Status>
    <CreateDate>2024-03-12T10:15:22</CreateDate>
    <UpdateDate>2024-03-12T10:15:25</UpdateDate>
    <Error/>
    <XmlResponseCastErrorNr>0</XmlResponseCastErrorNr>
    <XmlResponseCastErrorMessage/>
  </row>
</SqlRowSet1>

Status	Message	Cause
400	You have to specify an ID to search for	`Id` is empty or `NULL`. Pass a non-empty order ID or supplier article number.
400	You have to specify XML type (either "order" or "item")	`Type` is neither `order` nor `item`. Pass one of these two values.

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:pixiImportFindXML>
      <Type>order</Type>
      <Id>100004711</Id>
      <!-- <Channel>3</Channel> -->
    </ns1:pixiImportFindXML>
  </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:pixiImportFindXML>
      <Type>order</Type>
      <Id>100004711</Id>
      <!-- <Channel>3</Channel> -->
    </ns1:pixiImportFindXML>
  </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 = [
    'Type' => 'order',
    'Id' => '100004711',
    // 'Channel' => '3',
];

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

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

Notes

Tables used

Result set 1 · If Id is empty or NULL, or if Type is neither order nor item

Result set 2 · If Id is set and Type is order or item; zero or one row

Response example

Result set 1 · If `Id` is empty or `NULL`, or if `Type` is neither `order` nor `item`

Result set 2 · If `Id` is set and `Type` is `order` or `item`; zero or one row