pixiGetAddressesByEmail
Liefert alle Adressen, deren E-Mail-Adresse dem angegebenen Wert entspricht, optional eingeschränkt auf einen Shop.
Durchsucht die Adresstabelle nach Datensätzen, deren eMail dem Parameter Email entspricht.
- Ist
ShopIdNULLoder leer, werden Adressen aller Shops geliefert. - Andernfalls werden nur Adressen geliefert, deren Shop (
AddrShopID) gleichShopIdist.
Zu jeder Adresse werden die Adressdaten, die externe Kundennummer, der verknüpfte Kundenschlüssel (CustKey) sowie Ländername und ISO-Codes aus der Ländertabelle geliefert. Die Länderdaten werden per Left Outer Join ergänzt, sodass Adressen mit unbekanntem Ländercode trotzdem mit leeren Länderspalten erscheinen.
Eine Sortierreihenfolge ist nicht festgelegt.
Hinweise
- Liest mit
NOLOCK; nicht festgeschriebene Daten können geliefert werden. - Der E-Mail-Vergleich ist ein exakter Gleichheitsvergleich; ob Groß-/Kleinschreibung beachtet wird, hängt von der Collation der Datenbank ab. Platzhalter werden nicht unterstützt.
- Mehrere Zeilen pro E-Mail-Adresse sind üblich, z. B. für verschiedene Kunden oder Adresstypen (Rechnungs- und Lieferadressen).
- Gibt es keinen Treffer, wird eine leere Ergebnismenge geliefert.
Parameter
| Parameter | Typ | Standardwert | Beschreibung |
|---|---|---|---|
Email
Pflicht
|
varchar(60) string |
– |
Zu suchende E-Mail-Adresse (exakter Vergleich mit der E-Mail der Adresse). Beispiel: |
ShopId
|
char(3) string |
NULL |
Optionale Shop-ID. Wenn gesetzt, werden nur Adressen dieses Shops geliefert; Beispiel: |
Antwort
Result-Set 1 · Immer (kann leer sein)
Eine Zeile je passender Adresse.
| Spalte | Typ | Beschreibung |
|---|---|---|
AddrKey
|
int |
Interner Schlüssel der Adresse. |
AddrType
Kann leer sein |
string |
Typ der Adresse (z. B. Rechnungs- oder Lieferadresse). |
CustomerNrExternal
Kann leer sein |
string |
Externe Kundennummer, z. B. aus dem Shop. |
Title
Kann leer sein |
string |
Anrede (Spalte |
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 (Spalte |
Address
Kann leer sein |
string |
Adresszeile (Straße und Hausnummer kombiniert). |
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 dateTime |
Anlagedatum der Adresse. |
Note
Kann leer sein |
string |
Notiz zur Adresse. |
CustKey
Kann leer sein |
int |
Schlüssel des verknüpften Kunden (Spalte |
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. |
Beispielantwort
<SqlRowSet1>
<row>
<AddrKey>48213</AddrKey>
<AddrType>R</AddrType>
<CustomerNrExternal>100245</CustomerNrExternal>
<Title>Herr</Title>
<Name>Max Mustermann</Name>
<FirstName>Max</FirstName>
<LastName>Mustermann</LastName>
<Company/>
<Address>Musterstraße 12</Address>
<Street>Musterstraße</Street>
<HouseNr>12</HouseNr>
<City>München</City>
<ZIP>80331</ZIP>
<Country>D</Country>
<Phone>089 123456</Phone>
<Fax/>
<eMail>max.mustermann@example.com</eMail>
<CreateDate>2023-05-14T10:22:31</CreateDate>
<Note/>
<CustKey>15032</CustKey>
<CountryName>Deutschland</CountryName>
<CountryCodeISO2>DE</CountryCodeISO2>
<CountryCodeISO3>DEU</CountryCodeISO3>
</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:pixiGetAddressesByEmail>
<Email>max.mustermann@example.com</Email>
<!-- <ShopId>SHP</ShopId> -->
</ns1:pixiGetAddressesByEmail>
</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:pixiGetAddressesByEmail>
<Email>max.mustermann@example.com</Email>
<!-- <ShopId>SHP</ShopId> -->
</ns1:pixiGetAddressesByEmail>
</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 = [
'Email' => 'max.mustermann@example.com',
// 'ShopId' => 'SHP',
];
$soapArguments = [];
foreach ($arguments as $name => $value) {
$soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}
$response = $soapClient->__soapCall('pixiGetAddressesByEmail', $soapArguments);
Verwendete Tabellen
- SQL-Objekt:
- dbo.pipiGetAddressesByEmail