pixiReadAddresses
API Call to retrieve all relevant addresses
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
AddrKey | integer | false | pixi* Address 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="">
<pixiReadAddresses>
<AddrKey>0</AddrKey>
<CreateDateFrom>string</CreateDateFrom>
<CreateDateTo>string</CreateDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
<CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
<CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
<RowCount>0</RowCount>
</pixiReadAddresses>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
BIC | string | BIC Type: varchar Available from: 25.06 (25.6.0.58802) |
Fax | string | Fax Type: varchar Available from: 25.06 (25.6.0.58802) |
ZIP | string | ZIP Type: varchar Available from: 25.06 (25.6.0.58802) |
ABLZ | string | ABLZ Type: varchar Available from: 25.06 (25.6.0.58802) |
City | string | City Type: varchar Available from: 25.06 (25.6.0.58802) |
Fax2 | string | Fax2 Type: varchar Available from: 25.06 (25.6.0.58802) |
IBAN | string | IBAN Type: varchar Available from: 25.06 (25.6.0.58802) |
Name | string | Name Type: varchar Available from: 25.06 (25.6.0.58802) |
Note | string | Note Type: datetime Available from: 25.06 (25.6.0.58802) |
CCCVC | string | CCCVC Type: varchar Available from: 25.06 (25.6.0.58802) |
Name2 | string | Name2 Type: varchar Available from: 25.06 (25.6.0.58802) |
Phone | string | Phone Type: varchar Available from: 25.06 (25.6.0.58802) |
State | string | State Type: varchar Available from: 25.06 (25.6.0.58802) |
ZIPMB | string | ZIPMB Type: varchar Available from: 25.06 (25.6.0.58802) |
string | Type: varchar Available from: 25.06 (25.6.0.58802) |
|
AGosF1 | string | AGosF1 Type: varchar Available from: 25.06 (25.6.0.58802) |
AGosF2 | string | AGosF2 Type: varchar Available from: 25.06 (25.6.0.58802) |
AddrNr | string | AddrNr Type: varchar Available from: 25.06 (25.6.0.58802) |
Anrede | string | Anrede Type: varchar Available from: 25.06 (25.6.0.58802) |
CareOf | string | CareOf Type: varchar Available from: 25.06 (25.6.0.58802) |
Phone2 | string | Phone2 Type: varchar Available from: 25.06 (25.6.0.58802) |
Street | string | Street Type: varchar Available from: 25.06 (25.6.0.58802) |
UsStId | string | UsStId Type: varchar Available from: 25.06 (25.6.0.58802) |
active | string | active Type: varchar Available from: 25.06 (25.6.0.58802) |
eMail2 | string | eMail2 Type: varchar Available from: 25.06 (25.6.0.58802) |
ACardNr | string | ACardNr Type: varchar Available from: 25.06 (25.6.0.58802) |
AddrKey | integer | AddrKey Type: int Available from: 25.06 (25.6.0.58802) |
Address | string | Address Type: varchar Available from: 25.06 (25.6.0.58802) |
CAnrede | string | CAnrede Type: varchar Available from: 25.06 (25.6.0.58802) |
Contact | string | Contact Type: varchar Available from: 25.06 (25.6.0.58802) |
Country | string | Country Type: varchar Available from: 25.06 (25.6.0.58802) |
HouseNr | string | HouseNr Type: varchar Available from: 25.06 (25.6.0.58802) |
Mailbox | string | Mailbox Type: varchar Available from: 25.06 (25.6.0.58802) |
rowguid | integer | rowguid Type: int Available from: 25.06 (25.6.0.58802) |
AAccName | string | AAccName Type: varchar Available from: 25.06 (25.6.0.58802) |
AAccount | string | AAccount Type: varchar Available from: 25.06 (25.6.0.58802) |
ACardExp | string | ACardExp Type: varchar Available from: 25.06 (25.6.0.58802) |
AHisNote | string | AHisNote Type: varchar Available from: 25.06 (25.6.0.58802) |
AIssueNr | string | AIssueNr Type: varchar Available from: 25.06 (25.6.0.58802) |
APayment | string | APayment Type: varchar Available from: 25.06 (25.6.0.58802) |
ASlocked | string | ASlocked Type: varchar Available from: 25.06 (25.6.0.58802) |
AddrType | string | AddrType Type: varchar Available from: 25.06 (25.6.0.58802) |
LastName | string | LastName Type: varchar Available from: 25.06 (25.6.0.58802) |
ABankName | string | ABankName Type: varchar Available from: 25.06 (25.6.0.58802) |
ACardName | string | ACardName Type: varchar Available from: 25.06 (25.6.0.58802) |
ACardType | string | ACardType Type: varchar Available from: 25.06 (25.6.0.58802) |
AReplFlag | string | AReplFlag Type: varchar Available from: 25.06 (25.6.0.58802) |
AWaitDays | integer | AWaitDays Type: int Available from: 25.06 (25.6.0.58802) |
Ansprache | string | Ansprache Type: varchar Available from: 25.06 (25.6.0.58802) |
BirthDate | string | BirthDate Type: datetime Available from: 25.06 (25.6.0.58802) |
CreateEmp | string | CreateEmp Type: varchar Available from: 25.06 (25.6.0.58802) |
FirstName | string | FirstName Type: varchar Available from: 25.06 (25.6.0.58802) |
SearchKey | string | SearchKey Type: varchar Available from: 25.06 (25.6.0.58802) |
UpdateEmp | string | UpdateEmp Type: varchar Available from: 25.06 (25.6.0.58802) |
AShipImmed | string | AShipImmed Type: varchar Available from: 25.06 (25.6.0.58802) |
AddrShopID | string | AddrShopID Type: varchar Available from: 25.06 (25.6.0.58802) |
AdrCustRef | integer | AdrCustRef Type: int Available from: 25.06 (25.6.0.58802) |
Billing_Id | integer | Billing_Id Type: int Available from: 25.06 (25.6.0.58802) |
CreateDate | string | CreateDate Type: datetime Available from: 25.06 (25.6.0.58802) |
UpdateDate | string | UpdateDate Type: datetime Available from: 25.06 (25.6.0.58802) |
CompanyType | integer | CompanyType Type: int Available from: 25.06 (25.6.0.58802) |
CompanySince | string | CompanySince Type: datetime Available from: 25.06 (25.6.0.58802) |
AddrNoChargeVAT | boolean | AddrNoChargeVAT Type: bit Available from: 25.06 (25.6.0.58802) |
PersonContact_Id | integer | PersonContact_Id Type: int Available from: 25.06 (25.6.0.58802) |
CustomerNrExternal | string | CustomerNrExternal Type: varchar Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReadAddressesPost200TextXmlResponse>
<AddrKey>0</AddrKey>
<AddrNr>string</AddrNr>
<AddrType>string</AddrType>
<CustomerNrExternal>string</CustomerNrExternal>
<AddrShopID>string</AddrShopID>
<SearchKey>string</SearchKey>
<Anrede>string</Anrede>
<Name>string</Name>
<Name2>string</Name2>
<FirstName>string</FirstName>
<LastName>string</LastName>
<CareOf>string</CareOf>
<Address>string</Address>
<Street>string</Street>
<HouseNr>string</HouseNr>
<City>string</City>
<State>string</State>
<ZIP>string</ZIP>
<Country>string</Country>
<ZIPMB>string</ZIPMB>
<Mailbox>string</Mailbox>
<Contact>string</Contact>
<CAnrede>string</CAnrede>
<Ansprache>string</Ansprache>
<Phone>string</Phone>
<Phone2>string</Phone2>
<Fax>string</Fax>
<Fax2>string</Fax2>
<eMail>string</eMail>
<eMail2>string</eMail2>
<UsStId>string</UsStId>
<CompanyType>0</CompanyType>
<CompanySince>string</CompanySince>
<BirthDate>string</BirthDate>
<Note>string</Note>
<CreateDate>string</CreateDate>
<CreateEmp>string</CreateEmp>
<UpdateDate>string</UpdateDate>
<UpdateEmp>string</UpdateEmp>
<active>string</active>
<ACardType>string</ACardType>
<ACardName>string</ACardName>
<ACardNr>string</ACardNr>
<ACardExp>string</ACardExp>
<AAccount>string</AAccount>
<ABLZ>string</ABLZ>
<ABankName>string</ABankName>
<AAccName>string</AAccName>
<APayment>string</APayment>
<AIssueNr>string</AIssueNr>
<AdrCustRef>0</AdrCustRef>
<rowguid>0</rowguid>
<ASlocked>string</ASlocked>
<AWaitDays>0</AWaitDays>
<AShipImmed>string</AShipImmed>
<AGosF1>string</AGosF1>
<AGosF2>string</AGosF2>
<AHisNote>string</AHisNote>
<AReplFlag>string</AReplFlag>
<CCCVC>string</CCCVC>
<AddrNoChargeVAT>true</AddrNoChargeVAT>
<BIC>string</BIC>
<IBAN>string</IBAN>
<PersonContact_Id>0</PersonContact_Id>
<Billing_Id>0</Billing_Id>
</PixiReadAddressesPost200TextXmlResponse>
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:pixiReadAddresses>
<AddrKey xsi:type="xsd:integer"></AddrKey>
<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:pixiReadAddresses>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReadAddresses', [
'AddrKey' => '', // 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);
}