pixiCustomerSearch

Wrapper around the internal procedure Pixi_CustomerSearch. The call first normalizes the search parameters and then passes them on. The internal procedure produces the result.

Normalization:

Empty strings and NULL are replaced by the wildcard %. For Name and Address the replacement is %%.
CustNrExternal: if a value other than % is given, a trailing % is appended. This makes it a prefix search, for example K100 becomes K100%.
OrderNr: 0 (and NULL) is treated as no filter (NULL).

Parameter mapping to Pixi_CustomerSearch:

CustNrExternal is passed as @CustID, and @CustomerNrExternal is passed as NULL.
RowCount, eMail, Name, Address, City, Zip, Country, ShopID, OrderNr, OrderNrExternal and InvoiceNr are passed through after normalization.
The other filters of the internal procedure are fixed to NULL: CardNr, BoxNr, ItemName, ItemEAN, Status and ShipCode. SerialNr is fixed to %.

RowCount (default 1500) is passed to the internal procedure and most likely limits the number of returned rows.

Notes

The definition of Pixi_CustomerSearch is not attached. The columns of the result, the exact matching logic and the sort order cannot be derived from this code. The % defaults suggest LIKE pattern matching, but this is not confirmed.
Because the code compares OrderNr with an empty string, the value 0 is treated as NULL (no filter).
The header comment ("Template for getting items…") was copied from a template and does not describe this call.
The call itself writes no data. Whether the internal procedure has side effects is unknown.

Parameter	Type	Default	Description
`RowCount`	integer int	1500	Maximum number of rows. Passed to `Pixi_CustomerSearch`. Example: `100`
`CustNrExternal`	varchar(255) string	%	External customer number. A trailing `%` is appended, which makes it a prefix search. Passed as `@CustID`. Example: `K10023`
`eMail`	varchar(255) string	%	E-mail filter (wildcard pattern). An empty value means no filter. Example: `%@example.com`
`Name`	varchar(255) string	%%	Customer name filter (wildcard pattern). An empty value is replaced by `%%`. Example: `%Müller%`
`Address`	varchar(255) string	%%	Address/street filter (wildcard pattern). An empty value is replaced by `%%`. Example: `%Hauptstraße%`
`City`	varchar(255) string	%	City filter (wildcard pattern). Example: `München`
`Zip`	varchar(255) string	%	ZIP code filter (wildcard pattern). Example: `80%`
`Country`	varchar(255) string	%	Country filter (wildcard pattern). Example: `DE`
`ShopID`	varchar(3) string	–	Shop ID. Passed unchanged; the default is an empty string. Example: `ABC`
`OrderNr`	integer int	NULL	Pixi order number. `NULL` or `0` means no filter. Example: `123456`
`OrderNrExternal`	varchar(255) string	%	External (shop) order number filter (wildcard pattern). Example: `SHOP-2024-0815`
`InvoiceNr`	varchar(255) string	%	Invoice number filter (wildcard pattern). Example: `RE2024001234`

Result set 1 · Determined by the internal procedure `Pixi_CustomerSearch` (definition not attached).

Customer search result produced by Pixi_CustomerSearch. Its columns cannot be derived from the available code.

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:pixiCustomerSearch>
      <!-- <RowCount>100</RowCount> -->
      <!-- <CustNrExternal>K10023</CustNrExternal> -->
      <!-- <eMail>%@example.com</eMail> -->
      <!-- <Name>%Müller%</Name> -->
      <!-- <Address>%Hauptstraße%</Address> -->
      <!-- <City>München</City> -->
      <!-- <Zip>80%</Zip> -->
      <!-- <Country>DE</Country> -->
      <!-- <ShopID>ABC</ShopID> -->
      <!-- <OrderNr>123456</OrderNr> -->
      <!-- <OrderNrExternal>SHOP-2024-0815</OrderNrExternal> -->
      <!-- <InvoiceNr>RE2024001234</InvoiceNr> -->
    </ns1:pixiCustomerSearch>
  </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:pixiCustomerSearch>
      <!-- <RowCount>100</RowCount> -->
      <!-- <CustNrExternal>K10023</CustNrExternal> -->
      <!-- <eMail>%@example.com</eMail> -->
      <!-- <Name>%Müller%</Name> -->
      <!-- <Address>%Hauptstraße%</Address> -->
      <!-- <City>München</City> -->
      <!-- <Zip>80%</Zip> -->
      <!-- <Country>DE</Country> -->
      <!-- <ShopID>ABC</ShopID> -->
      <!-- <OrderNr>123456</OrderNr> -->
      <!-- <OrderNrExternal>SHOP-2024-0815</OrderNrExternal> -->
      <!-- <InvoiceNr>RE2024001234</InvoiceNr> -->
    </ns1:pixiCustomerSearch>
  </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 = [
    // 'RowCount' => '100',
    // 'CustNrExternal' => 'K10023',
    // 'eMail' => '%@example.com',
    // 'Name' => '%Müller%',
    // 'Address' => '%Hauptstraße%',
    // 'City' => 'München',
    // 'Zip' => '80%',
    // 'Country' => 'DE',
    // 'ShopID' => 'ABC',
    // 'OrderNr' => '123456',
    // 'OrderNrExternal' => 'SHOP-2024-0815',
    // 'InvoiceNr' => 'RE2024001234',
];

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

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

Notes

Result set 1 · Determined by the internal procedure Pixi_CustomerSearch (definition not attached).

Result set 1 · Determined by the internal procedure `Pixi_CustomerSearch` (definition not attached).