Customers Lesen

pixiGetChangedCustomers

Liefert Kunden, die seit einem Zeitpunkt angelegt oder geändert wurden, optional bis zu einem Enddatum, sortiert nach Änderungsdatum und begrenzt auf eine maximale Zeilenzahl.

Liest die Kundentabelle und liefert alle Kunden, deren Änderungsdatum im angefragten Zeitraum liegt. Der Aufruf dient typischerweise der inkrementellen (Delta-)Synchronisation von Kunden in ein externes System.

Das Änderungsdatum eines Kunden ist sein UpdateDate bzw. sein CreateDate, falls der Kunde nie geändert wurde. Dieser Wert wird auch in der Spalte UpdateDate zurückgegeben.
Ist To nicht angegeben oder leer, werden alle Kunden mit Änderungsdatum >= Since geliefert.
Ist To gesetzt, werden Kunden mit Änderungsdatum zwischen Since und To (jeweils inklusive) geliefert.
Das Ergebnis ist aufsteigend nach Änderungsdatum sortiert (älteste Änderung zuerst).
Es werden höchstens Rowcount Zeilen geliefert (Standard 1000).

Je Kunde werden Kundenschlüssel, die Schlüssel der Rechnungs- und Lieferadresse, ein Liefersperre-Kennzeichen, der Wert CustomerOf, E-Mail-Adresse und Name geliefert.

Hinweise

Die Tabelle wird WITH (NOLOCK) gelesen; nicht festgeschriebene Änderungen können daher geliefert werden.
Die Begrenzung erfolgt über SET ROWCOUNT. Mit Rowcount = 0 entfällt die Begrenzung, und alle passenden Zeilen werden geliefert.
Die Prüfung auf ein leeres To vergleicht mit '', was SQL Server in 1900-01-01 00:00:00 umwandelt. Genau dieses Datum als To wird daher wie ein fehlendes Enddatum behandelt.
Vorgehen beim Blättern: das höchste gelieferte UpdateDate als nächstes Since verwenden. Da der Filter >= lautet, werden die letzten Datensätze erneut geliefert; nach CustKey deduplizieren. Es gibt kein zweites Sortierkriterium – haben mehr als Rowcount Kunden dasselbe Änderungsdatum, kommt die Schleife nicht weiter; in diesem Fall Rowcount erhöhen.
ShipLock ist 1, wenn das Kundenfeld SLocked den Wert Y hat, sonst 0.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`Since` Pflicht	datetime dateTime	–	Beginn des Zeitraums (inklusive). Geliefert werden Kunden, deren Änderungsdatum (`UpdateDate`, sonst `CreateDate`) gleich oder später ist. Beispiel: `2024-05-01T00:00:00`
`To`	datetime dateTime	NULL	Optionales Ende des Zeitraums (inklusive). Fehlt der Wert oder ist er leer, gibt es keine Obergrenze. Beispiel: `2024-05-31T23:59:59`
`Rowcount`	int	1000	Maximale Anzahl gelieferter Zeilen. `0` bedeutet keine Begrenzung. Beispiel: `500`

Antwort

Result-Set 1 · Immer (ggf. leer)

Im angefragten Zeitraum geänderte Kunden, aufsteigend nach Änderungsdatum sortiert.

Spalte	Typ	Beschreibung
`CustKey`	int	Schlüssel des Kunden.
`AddrKey` Kann leer sein	int	Schlüssel der Haupt- bzw. Rechnungsadresse des Kunden (`Customers.AddrRef`).
`ShipAddrKey` Kann leer sein	int	Schlüssel der Lieferadresse des Kunden (`Customers.ShipRef`).
`ShipLock`	bit boolean	`1`, wenn für den Kunden eine Liefersperre besteht (`SLocked` = `Y`), sonst `0`.
`CustomerOf` Kann leer sein	string	Wert des Kundenfelds `CustomerOf` (Zuordnung des Kunden, z. B. zu einem Shop oder Mandanten).
`eMail` Kann leer sein	string	E-Mail-Adresse des Kunden (`CeMail`).
`Name` Kann leer sein	string	Name des Kunden (`SName`).
`UpdateDate`	datetime dateTime	Änderungsdatum: `UpdateDate` des Kunden bzw. `CreateDate`, falls nie geändert.

Beispielantwort

<SqlRowSet1>
  <row>
    <CustKey>10452</CustKey>
    <AddrKey>23011</AddrKey>
    <ShipAddrKey>23012</ShipAddrKey>
    <ShipLock>false</ShipLock>
    <CustomerOf>SHOP1</CustomerOf>
    <eMail>anna.mueller@example.de</eMail>
    <Name>Anna Müller</Name>
    <UpdateDate>2024-05-02T09:14:33.217</UpdateDate>
  </row>
  <row>
    <CustKey>10988</CustKey>
    <AddrKey>24170</AddrKey>
    <ShipAddrKey>24170</ShipAddrKey>
    <ShipLock>true</ShipLock>
    <CustomerOf>SHOP1</CustomerOf>
    <eMail>info@beispiel-gmbh.de</eMail>
    <Name>Beispiel GmbH</Name>
    <UpdateDate>2024-05-02T11:40:05.003</UpdateDate>
  </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:pixiGetChangedCustomers>
      <Since>2024-05-01T00:00:00</Since>
      <!-- <To>2024-05-31T23:59:59</To> -->
      <!-- <Rowcount>500</Rowcount> -->
    </ns1:pixiGetChangedCustomers>
  </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:pixiGetChangedCustomers>
      <Since>2024-05-01T00:00:00</Since>
      <!-- <To>2024-05-31T23:59:59</To> -->
      <!-- <Rowcount>500</Rowcount> -->
    </ns1:pixiGetChangedCustomers>
  </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 = [
    'Since' => '2024-05-01T00:00:00',
    // 'To' => '2024-05-31T23:59:59',
    // 'Rowcount' => '500',
];

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

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

Verwendete Tabellen

Customers · Lesen

SQL-Objekt:: dbo.pipiGetChangedCustomers