Customers Lesen

pixiGetCRMCustomerData

Liefert Kunden mit ihren Hauptadressdaten seitenweise nach CustKey sortiert, gedacht für den Abgleich mit CRM-Systemen.

Liefert Kundendatensätze zusammen mit der beim Kunden hinterlegten Adresse (AddrRef).

Es werden nur Kunden mit CustKey größer als CustKeyStart geliefert.
Ist CustomerOf leer oder NULL, werden Kunden aller Shops geliefert, andernfalls nur Kunden mit passendem CustomerOf.
Es werden höchstens Rows Zeilen geliefert, aufsteigend nach CustKey sortiert.

Paging: Mit CustKeyStart = 0 beginnen und beim nächsten Aufruf den höchsten CustKey der vorherigen Seite als CustKeyStart übergeben. Werden weniger als Rows Zeilen geliefert, ist das Ende erreicht.

Eine leere VATID wird als NULL geliefert. Locked ist Y, wenn der Kunde für den Verkauf (SLocked) oder die Lieferung (DLocked) gesperrt ist, sonst N.

Hinweise

Die Tabellen werden mit NOLOCK gelesen; nicht festgeschriebene Änderungen können sichtbar sein, und bei gleichzeitigen Schreibvorgängen können Zeilen fehlen oder doppelt erscheinen.
Die Adresse wird per LEFT JOIN angebunden; Kunden ohne passende Adresse werden mit NULL in den Adressspalten geliefert.
Trotz des Kopfkommentars zu "sicheren XML-Werten" werden die Werte außer VATID und Locked nicht umgewandelt.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`CustKeyStart`	int	0	Es werden nur Kunden mit einem `CustKey` größer als dieser Wert geliefert. Für Paging den letzten `CustKey` der vorherigen Seite übergeben. Beispiel: `0`
`Rows`	int	1000	Maximale Anzahl gelieferter Zeilen (Seitengröße). Beispiel: `500`
`CustomerOf`	varchar(3) string	–	Shop-Kürzel, dem der Kunde zugeordnet ist. Leer oder NULL liefert Kunden aller Shops. Beispiel: `SHP`

Antwort

Result-Set 1 · Immer (kann leer sein)

Kunden mit Adressdaten, aufsteigend nach CustKey sortiert, höchstens Rows Zeilen.

Spalte	Typ	Beschreibung
`CustKey`	int	Interner Kundenschlüssel.
`CustomerNrExternal` Kann leer sein	string	Externe Kundennummer (z. B. aus dem Shop).
`CustomerOf` Kann leer sein	string	Shop-Kürzel, dem der Kunde zugeordnet ist.
`Anrede` Kann leer sein	string	Anrede.
`Name` Kann leer sein	string	Name (erste Adresszeile).
`Name2` Kann leer sein	string	Zusätzliche Namenszeile.
`FirstName` Kann leer sein	string	Vorname.
`LastName` Kann leer sein	string	Nachname.
`Street` Kann leer sein	string	Straße.
`HouseNr` Kann leer sein	string	Hausnummer.
`Address` Kann leer sein	string	Adresszeile.
`ZIP` Kann leer sein	string	Postleitzahl.
`City` Kann leer sein	string	Ort.
`State` Kann leer sein	string	Bundesland bzw. Region.
`Country` Kann leer sein	string	Land.
`eMail` Kann leer sein	string	E-Mail-Adresse.
`Phone` Kann leer sein	string	Telefonnummer.
`Fax` Kann leer sein	string	Faxnummer.
`VATID` Kann leer sein	string	USt-IdNr. des Kunden; NULL, wenn leer.
`Locked`	varchar(1) string	`Y`, wenn der Kunde für Verkauf oder Lieferung gesperrt ist, sonst `N`.
`BirthDate` Kann leer sein	dateTime	Geburtsdatum.
`CareOf` Kann leer sein	string	c/o-Zusatz.

Beispielantwort

<SqlRowSet1>
  <row>
    <CustKey>1001</CustKey>
    <CustomerNrExternal>K-50231</CustomerNrExternal>
    <CustomerOf>SHP</CustomerOf>
    <Anrede>Herr</Anrede>
    <Name>Max Mustermann</Name>
    <Name2/>
    <FirstName>Max</FirstName>
    <LastName>Mustermann</LastName>
    <Street>Hauptstraße</Street>
    <HouseNr>12</HouseNr>
    <Address>Hauptstraße 12</Address>
    <ZIP>80331</ZIP>
    <City>München</City>
    <State>BY</State>
    <Country>DE</Country>
    <eMail>max@example.com</eMail>
    <Phone>+49 89 123456</Phone>
    <Fax/>
    <Locked>N</Locked>
    <BirthDate>1980-05-17T00:00:00</BirthDate>
    <CareOf/>
  </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:pixiGetCRMCustomerData>
      <!-- <CustKeyStart>0</CustKeyStart> -->
      <!-- <Rows>500</Rows> -->
      <!-- <CustomerOf>SHP</CustomerOf> -->
    </ns1:pixiGetCRMCustomerData>
  </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:pixiGetCRMCustomerData>
      <!-- <CustKeyStart>0</CustKeyStart> -->
      <!-- <Rows>500</Rows> -->
      <!-- <CustomerOf>SHP</CustomerOf> -->
    </ns1:pixiGetCRMCustomerData>
  </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 = [
    // 'CustKeyStart' => '0',
    // 'Rows' => '500',
    // 'CustomerOf' => 'SHP',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetCRMCustomerData', $soapArguments);

Verwendete Tabellen

customers · Lesen Addresses · Lesen

SQL-Objekt:: dbo.pipiGetCRMCustomerData