pixiGetCustomerList
Get customers invoice and billing data.
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Return currency code in field BaseCurrency depend on if Multi Currency is Enabled then we:
- calculate and return data in base currency per customer
else
- calculate and return data in order / original currency (with value NULL for currency code)
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
StartCustKey | integer | false | Start Customer Id Type: int Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetCustomerList>
<StartCustKey>0</StartCustKey>
</pixiGetCustomerList>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
ZIP | string | ZIP Type: varchar Available from: 25.06 (25.6.0.58802) |
Name | string | Name Type: varchar Available from: 25.06 (25.6.0.58802) |
string | Type: varchar Available from: 25.06 (25.6.0.58802) |
|
CareOf | string | CareOf Type: varchar Available from: 25.06 (25.6.0.58802) |
ShopID | string | ShopID Type: varchar Available from: 25.06 (25.6.0.58802) |
Address | string | Address Type: varchar Available from: 25.06 (25.6.0.58802) |
Country | string | Country Type: varchar Available from: 25.06 (25.6.0.58802) |
CustKey | integer | Reference to the customer to use in other API Calls Type: int Available from: 25.06 (25.6.0.58802) |
Lastname | string | Lastname Type: varchar Available from: 25.06 (25.6.0.58802) |
ShipLock | string | Is the customer locked? Type: varchar Available from: 25.06 (25.6.0.58802) |
Firstname | string | Firstname Type: varchar Available from: 25.06 (25.6.0.58802) |
OrderCount | integer | Number of orders. Note: not invoices! An order can be canceled, but will still count at an order. Type: int Available from: 25.06 (25.6.0.58802) |
Salutation | string | Salutation Type: varchar Available from: 25.06 (25.6.0.58802) |
ReturnCount | integer | Number of returns Type: int Available from: 25.06 (25.6.0.58802) |
ReturnValue | integer | complete value of all returns. Type: int Available from: 25.06 (25.6.0.58802) |
BaseCurrency | string | BaseCurrency Type: varchar Available from: 25.06 (25.6.0.58802) |
Turnover_all | integer | All positive turnover, that is, all items shipped to the customer. Type: int Available from: 25.06 (25.6.0.58802) |
ItemCount_all | integer | Number of all items shipped to the customer. Type: int Available from: 25.06 (25.6.0.58802) |
ReminderLevel | integer | Highest reminderlevel of an invoice of the customer Type: int Available from: 25.06 (25.6.0.58802) |
CustomerNrExternal | string | External CustomerNR, Linking the customer to the shop Type: varchar Available from: 25.06 (25.6.0.58802) |
DaysSinceLastOrder | integer | Days since the customer place last time an order. Type: int Available from: 25.06 (25.6.0.58802) |
DaysSinceFirstOrder | integer | Days since the first order of the customer. Type: int Available from: 25.06 (25.6.0.58802) |
Turnover_avgPerOrder | integer | Average turnover per shipment to the customer. Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetCustomerListPost200TextXmlResponse>
<CustKey>0</CustKey>
<CustomerNrExternal>string</CustomerNrExternal>
<OrderCount>0</OrderCount>
<Turnover_all>0</Turnover_all>
<ItemCount_all>0</ItemCount_all>
<Turnover_avgPerOrder>0</Turnover_avgPerOrder>
<ReturnCount>0</ReturnCount>
<ReturnValue>0</ReturnValue>
<ReminderLevel>0</ReminderLevel>
<DaysSinceLastOrder>0</DaysSinceLastOrder>
<DaysSinceFirstOrder>0</DaysSinceFirstOrder>
<ShopID>string</ShopID>
<EMail>string</EMail>
<Salutation>string</Salutation>
<Firstname>string</Firstname>
<Lastname>string</Lastname>
<Name>string</Name>
<CareOf>string</CareOf>
<Address>string</Address>
<ZIP>string</ZIP>
<Country>string</Country>
<ShipLock>string</ShipLock>
<BaseCurrency>string</BaseCurrency>
</PixiGetCustomerListPost200TextXmlResponse>
HTTP Example
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}
<?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/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:pixiGetCustomerList>
<StartCustKey xsi:type="xsd:integer"></StartCustKey>
</ns1:pixiGetCustomerList>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetCustomerList', [
'StartCustKey' => '', // integer
]);
function getPixiSoapClientResponse(string $method, array $arguments = [])
{
$soapArguments = [];
foreach ($arguments as $key => $value) {
$soapArguments[] = new SoapVar($value, null, '', '', $key);
}
$soapClient = new SoapClient(null, [
'login' => '...',
'password' => '...',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
]);
return $soapClient->__call($method, $soapArguments);
}