pixiGetAddress
Liefert einen einzelnen Adressdatensatz anhand des Adressschlüssels inklusive Länderangaben, Bankdaten und Zahlungsart.
Liest eine Adresse anhand ihres Primärschlüssels AddrKey aus der Adresstabelle von Pixi.
- Gefiltert wird über
AddrKey = @AddrKey. Es wird höchstens eine Zeile geliefert. - Das Land der Adresse (
Country) wird über den Ländercode mit der Ländertabelle verknüpft. Ländername sowie ISO-2- und ISO-3-Code werden ergänzt. Existiert kein passendes Land, bleiben diese Spalten leer. - Neben den Kontaktdaten (Name, Firma, Straße, PLZ, Ort, Telefon, Fax, E-Mail) enthält das Ergebnis die externe Kundennummer, den verknüpften Kundenschlüssel (
CustKey), die USt-IdNr., das Geburtsdatum, eine Notiz, Bankdaten (Kontonummer, Kontoinhaber, BLZ, Bankname, BIC, IBAN) und die an der Adresse hinterlegte Zahlungsart. - Mehrere Spalten werden in der Ausgabe umbenannt, z. B.
AnredezuTitle,CareOfzuCompany,AdrCustRefzuCustKeyundUsStIdzuVatID.
Hinweise
- Beide Tabellen werden
WITH (NOLOCK)gelesen, daher können nicht festgeschriebene Änderungen sichtbar sein. - Existiert keine Adresse mit dem angegebenen Schlüssel, ist die Ergebnismenge leer; eine Fehlermeldung wird nicht geliefert.
- Das Ergebnis enthält Bankdaten (IBAN, BIC, Kontonummer). Diese sind gemäß Datenschutzanforderungen zu behandeln.
- Die Datentypen der Spalten sind in der Prozedur nicht ersichtlich; die hier angegebenen Typen sind durch den Code nicht belegt.
Parameter
| Parameter | Typ | Standardwert | Beschreibung |
|---|---|---|---|
AddrKey
Pflicht
|
int | – |
Primärschlüssel der zu liefernden Adresse. Beispiel: |
Antwort
Result-Set 1 · Immer; enthält eine Zeile, wenn die Adresse existiert, sonst keine Zeilen.
Die Adresse mit Länderangaben, Bankdaten und Zahlungsart.
| Spalte | Typ | Beschreibung |
|---|---|---|
AddrKey
|
int |
Primärschlüssel der Adresse. |
AddrType
Kann leer sein |
string |
Typ der Adresse. |
CustomerNrExternal
Kann leer sein |
string |
Externe Kundennummer (z. B. aus dem Shop). |
Title
Kann leer sein |
string |
Anrede (Quellspalte |
Name
Kann leer sein |
string |
Vollständiger Name. |
FirstName
Kann leer sein |
string |
Vorname. |
LastName
Kann leer sein |
string |
Nachname. |
Company
Kann leer sein |
string |
Firma / c/o-Zeile (Quellspalte |
Address
Kann leer sein |
string |
Adresszeile (Straße und Hausnummer als ein Feld). |
Street
Kann leer sein |
string |
Straße. |
HouseNr
Kann leer sein |
string |
Hausnummer. |
City
Kann leer sein |
string |
Ort. |
ZIP
Kann leer sein |
string |
Postleitzahl. |
Country
Kann leer sein |
string |
Pixi-Ländercode der Adresse. |
Phone
Kann leer sein |
string |
Telefonnummer. |
Fax
Kann leer sein |
string |
Faxnummer. |
eMail
Kann leer sein |
string |
E-Mail-Adresse. |
CreateDate
Kann leer sein |
dateTime |
Anlagedatum der Adresse. |
Note
Kann leer sein |
string |
Notiz zur Adresse. |
CustKey
Kann leer sein |
int |
Schlüssel des verknüpften Kunden (Quellspalte |
VatID
Kann leer sein |
string |
USt-IdNr. (Quellspalte |
CountryName
Kann leer sein |
string |
Ländername aus der Ländertabelle; leer, wenn der Ländercode unbekannt ist. |
CountryCodeISO2
Kann leer sein |
string |
ISO-3166-1-Alpha-2-Ländercode. |
CountryCodeISO3
Kann leer sein |
string |
ISO-3166-1-Alpha-3-Ländercode. |
AccountNr
Kann leer sein |
string |
Kontonummer (Quellspalte |
AccountOwner
Kann leer sein |
string |
Kontoinhaber (Quellspalte |
BLZ
Kann leer sein |
string |
Bankleitzahl (Quellspalte |
BankName
Kann leer sein |
string |
Name der Bank (Quellspalte |
BIC
Kann leer sein |
string |
BIC der Bank. |
IBAN
Kann leer sein |
string |
IBAN des Kontos. |
PaymentType
Kann leer sein |
string |
An der Adresse hinterlegte Zahlungsart (Quellspalte |
BirthDate
Kann leer sein |
dateTime |
Geburtsdatum. |
Beispielantwort
<SqlRowSet1>
<row>
<AddrKey>104527</AddrKey>
<AddrType>1</AddrType>
<CustomerNrExternal>K-20931</CustomerNrExternal>
<Title>Frau</Title>
<Name>Anna Müller</Name>
<FirstName>Anna</FirstName>
<LastName>Müller</LastName>
<Company>Müller GmbH</Company>
<Address>Hauptstraße 12</Address>
<Street>Hauptstraße</Street>
<HouseNr>12</HouseNr>
<City>München</City>
<ZIP>80331</ZIP>
<Country>D</Country>
<Phone>+49 89 123456</Phone>
<Fax/>
<eMail>anna.mueller@example.de</eMail>
<CreateDate>2023-05-14T10:22:31</CreateDate>
<Note/>
<CustKey>55210</CustKey>
<VatID>DE123456789</VatID>
<CountryName>Deutschland</CountryName>
<CountryCodeISO2>DE</CountryCodeISO2>
<CountryCodeISO3>DEU</CountryCodeISO3>
<AccountNr/>
<AccountOwner>Anna Müller</AccountOwner>
<BLZ/>
<BankName>Musterbank</BankName>
<BIC>MUSTDEMMXXX</BIC>
<IBAN>DE89370400440532013000</IBAN>
<PaymentType>RECHNUNG</PaymentType>
<BirthDate>1985-03-02T00:00:00</BirthDate>
</row>
</SqlRowSet1>
Beispiele
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:pixiGetAddress>
<AddrKey>104527</AddrKey>
</ns1:pixiGetAddress>
</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:pixiGetAddress>
<AddrKey>104527</AddrKey>
</ns1:pixiGetAddress>
</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 = [
'AddrKey' => '104527',
];
$soapArguments = [];
foreach ($arguments as $name => $value) {
$soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}
$response = $soapClient->__soapCall('pixiGetAddress', $soapArguments);
Verwendete Tabellen
- SQL-Objekt:
- dbo.pipiGetAddress