pixiReadCustomers
API Call to retrieve all relevant customers
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| CustKey | integer | false | pixi* Customer Key Type: int Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| RowCount | integer | false | Number of rows returned maximum Type: int Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| CreateDateTo | string | false | Create Date to (excluding) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| UpdateDateTo | string | false | Update Date To (excluding) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| CreateDateFrom | string | false | Create Date from (including) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| UpdateDateFrom | string | false | Update Date from (including) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| CreateAndUpdateDateTo | string | false | Create or Update Date to (excluding) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
| CreateAndUpdateDateFrom | string | false | Create or Update Date from (including) Type: datetime 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="">
<pixiReadCustomers>
<CustKey>0</CustKey>
<CreateDateFrom>string</CreateDateFrom>
<CreateDateTo>string</CreateDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
<CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
<CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
<RowCount>0</RowCount>
</pixiReadCustomers>
</Body>
</Envelope>
Response
1. Result set
| Name | Type | Description |
|---|---|---|
| BLZ | string | BLZ Type: varchar Available from: / (25.11.0.62283) |
| CFax | string | CFax Type: varchar Available from: / (25.11.0.62283) |
| SZIP | string | SZIP Type: varchar Available from: / (25.11.0.62283) |
| BtxNr | string | BtxNr Type: varchar Available from: / (25.11.0.62283) |
| CNote | string | CNote Type: varchar Available from: / (25.11.0.62283) |
| Rabat | string | Rabat Type: varchar Available from: / (25.11.0.62283) |
| SCity | string | SCity Type: varchar Available from: / (25.11.0.62283) |
| SName | string | SName Type: varchar Available from: / (25.11.0.62283) |
| VATID | string | VATID Type: varchar Available from: / (25.11.0.62283) |
| CPhone | string | CPhone Type: varchar Available from: / (25.11.0.62283) |
| CardNr | string | CardNr Type: varchar Available from: / (25.11.0.62283) |
| CeMail | string | CeMail Type: varchar Available from: / (25.11.0.62283) |
| LSType | string | LSType Type: varchar Available from: / (25.11.0.62283) |
| SName2 | string | SName2 Type: varchar Available from: / (25.11.0.62283) |
| SState | string | SState Type: varchar Available from: / (25.11.0.62283) |
| SZIPMB | string | SZIPMB Type: varchar Available from: / (25.11.0.62283) |
| AccName | string | AccName Type: varchar Available from: / (25.11.0.62283) |
| Account | string | Account Type: varchar Available from: / (25.11.0.62283) |
| AddrRef | integer | AddrRef Type: int Available from: / (25.11.0.62283) |
| CAddrNr | string | CAddrNr Type: varchar Available from: / (25.11.0.62283) |
| CardExp | string | CardExp Type: varchar Available from: / (25.11.0.62283) |
| CustKey | integer | CustKey Type: int Available from: / (25.11.0.62283) |
| DLocked | string | DLocked Type: varchar Available from: / (25.11.0.62283) |
| IssueNr | string | IssueNr Type: varchar Available from: / (25.11.0.62283) |
| Payment | string | Payment Type: varchar Available from: / (25.11.0.62283) |
| SAnrede | string | SAnrede Type: varchar Available from: / (25.11.0.62283) |
| SCareOf | string | SCareOf Type: varchar Available from: / (25.11.0.62283) |
| SLocked | string | SLocked Type: varchar Available from: / (25.11.0.62283) |
| SStreet | string | SStreet Type: varchar Available from: / (25.11.0.62283) |
| ShipRef | integer | ShipRef Type: int Available from: / (25.11.0.62283) |
| ZZNetto | integer | ZZNetto Type: int Available from: / (25.11.0.62283) |
| BankName | string | BankName Type: varchar Available from: / (25.11.0.62283) |
| BulkShip | string | BulkShip Type: varchar Available from: / (25.11.0.62283) |
| CHisNote | string | CHisNote Type: varchar Available from: / (25.11.0.62283) |
| CardName | string | CardName Type: varchar Available from: / (25.11.0.62283) |
| CardType | string | CardType Type: varchar Available from: / (25.11.0.62283) |
| Discount | string | Discount Type: varchar Available from: / (25.11.0.62283) |
| Password | string | Password Type: varchar Available from: / (25.11.0.62283) |
| SAddress | string | SAddress Type: varchar Available from: / (25.11.0.62283) |
| SCountry | string | SCountry Type: varchar Available from: / (25.11.0.62283) |
| SHouseNr | string | SHouseNr Type: varchar Available from: / (25.11.0.62283) |
| SMailbox | string | SMailbox Type: varchar Available from: / (25.11.0.62283) |
| UserName | string | UserName Type: varchar Available from: / (25.11.0.62283) |
| WaitDays | integer | WaitDays Type: int Available from: / (25.11.0.62283) |
| WaitHour | integer | WaitHour Type: int Available from: / (25.11.0.62283) |
| ZZSkonto | integer | ZZSkonto Type: int Available from: / (25.11.0.62283) |
| CLangCode | string | CLangCode Type: varchar Available from: / (25.11.0.62283) |
| CreateEmp | string | CreateEmp Type: varchar Available from: / (25.11.0.62283) |
| NoInvoice | string | NoInvoice Type: varchar Available from: / (25.11.0.62283) |
| Person_Id | integer | Person_Id Type: int Available from: / (25.11.0.62283) |
| SLastName | string | SLastName Type: varchar Available from: / (25.11.0.62283) |
| UpdateEmp | string | UpdateEmp Type: varchar Available from: / (25.11.0.62283) |
| eMailInfo | string | eMailInfo Type: varchar Available from: / (25.11.0.62283) |
| CreateDate | string | CreateDate Type: datetime Available from: / (25.11.0.62283) |
| CustomerOf | string | CustomerOf Type: varchar Available from: / (25.11.0.62283) |
| SFirstName | string | SFirstName Type: varchar Available from: / (25.11.0.62283) |
| UpdateDate | string | UpdateDate Type: datetime Available from: / (25.11.0.62283) |
| WaitMinute | integer | WaitMinute Type: int Available from: / (25.11.0.62283) |
| MinOrderQty | integer | MinOrderQty Type: int Available from: / (25.11.0.62283) |
| NoShipCosts | string | NoShipCosts Type: varchar Available from: / (25.11.0.62283) |
| POSCustomer | string | POSCustomer Type: varchar Available from: / (25.11.0.62283) |
| UseShipAddr | string | UseShipAddr Type: varchar Available from: / (25.11.0.62283) |
| Discountable | string | Discountable Type: varchar Available from: / (25.11.0.62283) |
| ReminderCost | integer | ReminderCost Type: int Available from: / (25.11.0.62283) |
| TaxOnInvoice | string | TaxOnInvoice Type: varchar Available from: / (25.11.0.62283) |
| NextShipImmed | string | NextShipImmed Type: varchar Available from: / (25.11.0.62283) |
| InvoiceDueDays | integer | InvoiceDueDays Type: int Available from: / (25.11.0.62283) |
| ReminderAction | string | ReminderAction Type: varchar Available from: / (25.11.0.62283) |
| ReminderDueDays | integer | ReminderDueDays Type: int Available from: / (25.11.0.62283) |
| ZZSkontoProzent | integer | ZZSkontoProzent Type: int Available from: / (25.11.0.62283) |
| CustomerNrExternal | string | CustomerNrExternal Type: varchar Available from: / (25.11.0.62283) |
| DaysForNextReminder | integer | DaysForNextReminder Type: int Available from: / (25.11.0.62283) |
| DaysForFirstReminder | integer | DaysForFirstReminder Type: int Available from: / (25.11.0.62283) |
Response Example
<PixiReadCustomersPost200TextXmlResponse>
<CustKey>0</CustKey>
<AddrRef>0</AddrRef>
<UserName>string</UserName>
<Password>string</Password>
<BtxNr>string</BtxNr>
<DLocked>string</DLocked>
<ShipRef>0</ShipRef>
<CardType>string</CardType>
<CardName>string</CardName>
<CardNr>string</CardNr>
<CardExp>string</CardExp>
<Account>string</Account>
<BLZ>string</BLZ>
<BankName>string</BankName>
<AccName>string</AccName>
<WaitDays>0</WaitDays>
<MinOrderQty>0</MinOrderQty>
<LSType>string</LSType>
<Discountable>string</Discountable>
<NoInvoice>string</NoInvoice>
<NextShipImmed>string</NextShipImmed>
<SLocked>string</SLocked>
<eMailInfo>string</eMailInfo>
<Payment>string</Payment>
<UseShipAddr>string</UseShipAddr>
<SAnrede>string</SAnrede>
<SName>string</SName>
<SName2>string</SName2>
<SCareOf>string</SCareOf>
<SAddress>string</SAddress>
<SCity>string</SCity>
<SState>string</SState>
<SZIP>string</SZIP>
<SCountry>string</SCountry>
<SZIPMB>string</SZIPMB>
<SMailbox>string</SMailbox>
<WaitHour>0</WaitHour>
<WaitMinute>0</WaitMinute>
<CustomerOf>string</CustomerOf>
<CreateDate>string</CreateDate>
<CreateEmp>string</CreateEmp>
<UpdateDate>string</UpdateDate>
<UpdateEmp>string</UpdateEmp>
<Discount>string</Discount>
<CustomerNrExternal>string</CustomerNrExternal>
<BulkShip>string</BulkShip>
<IssueNr>string</IssueNr>
<CeMail>string</CeMail>
<CAddrNr>string</CAddrNr>
<CLangCode>string</CLangCode>
<CNote>string</CNote>
<CHisNote>string</CHisNote>
<SFirstName>string</SFirstName>
<SLastName>string</SLastName>
<SStreet>string</SStreet>
<SHouseNr>string</SHouseNr>
<TaxOnInvoice>string</TaxOnInvoice>
<NoShipCosts>string</NoShipCosts>
<ZZSkontoProzent>0</ZZSkontoProzent>
<ZZSkonto>0</ZZSkonto>
<ZZNetto>0</ZZNetto>
<CFax>string</CFax>
<CPhone>string</CPhone>
<VATID>string</VATID>
<Rabat>string</Rabat>
<POSCustomer>string</POSCustomer>
<ReminderAction>string</ReminderAction>
<DaysForFirstReminder>0</DaysForFirstReminder>
<DaysForNextReminder>0</DaysForNextReminder>
<ReminderCost>0</ReminderCost>
<ReminderDueDays>0</ReminderDueDays>
<InvoiceDueDays>0</InvoiceDueDays>
<Person_Id>0</Person_Id>
</PixiReadCustomersPost200TextXmlResponse>
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:pixiReadCustomers>
<CustKey xsi:type="xsd:integer"></CustKey>
<RowCount xsi:type="xsd:integer"></RowCount>
<CreateDateTo xsi:type="xsd:string"></CreateDateTo>
<UpdateDateTo xsi:type="xsd:string"></UpdateDateTo>
<CreateDateFrom xsi:type="xsd:string"></CreateDateFrom>
<UpdateDateFrom xsi:type="xsd:string"></UpdateDateFrom>
<CreateAndUpdateDateTo xsi:type="xsd:string"></CreateAndUpdateDateTo>
<CreateAndUpdateDateFrom xsi:type="xsd:string"></CreateAndUpdateDateFrom>
</ns1:pixiReadCustomers>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReadCustomers', [
'CustKey' => '', // integer
'RowCount' => '', // integer
'CreateDateTo' => '', // string
'UpdateDateTo' => '', // string
'CreateDateFrom' => '', // string
'UpdateDateFrom' => '', // string
'CreateAndUpdateDateTo' => '', // string
'CreateAndUpdateDateFrom' => '', // string
]);
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);
}