Orders Lesen

pixiGetOrderComments

Liefert die Kommentare zu Aufträgen, die nach einem bestimmten Zeitpunkt angelegt wurden, optional gefiltert nach Pixi-Auftragsnummer oder Shop-Auftragsnummer.

Liefert die zu Aufträgen gespeicherten Kommentare zusammen mit den zugehörigen Auftragsnummern.

Behandlung der Parameter

OrderNr = 0 wird wie nicht gesetzt (NULL) behandelt.
Ein leerer Wert für OrderNrShop wird wie nicht gesetzt (NULL) behandelt.
RowCount ist auf den Bereich 1 bis 1000 begrenzt. Ein Wert, der NULL, kleiner als 1 oder größer als 1000 ist, wird durch 1000 ersetzt.
Since wird bei NULL auf 2000-01-01 gesetzt.

Filter

Es werden nur Kommentare geliefert, deren CreateDate echt später als Since ist.
Ist weder OrderNr noch OrderNrShop gesetzt, werden die Kommentare aller Aufträge geliefert.
Ist OrderNr gesetzt, werden die Kommentare des Auftrags mit dieser Pixi-Auftragsnummer geliefert.
Ist OrderNrShop gesetzt, werden die Kommentare der Aufträge geliefert, deren externe (Shop-)Auftragsnummer OrderNrExternal übereinstimmt.
Sind beide gesetzt, werden sie mit ODER verknüpft: Kommentare beider Aufträge werden geliefert.

Sortierung und Begrenzung

Die Zeilen werden aufsteigend nach CreateDate sortiert, es werden höchstens RowCount Zeilen geliefert. Damit ist ein inkrementeller Abruf möglich: Das CreateDate der zuletzt erhaltenen Zeile wird beim nächsten Aufruf als Since übergeben.

Hinweise

Beide Tabellen werden mit NOLOCK gelesen; bei parallelen Änderungen können nicht festgeschriebene Daten geliefert oder Zeilen übersehen werden.
Die Sortierung hat außer CreateDate kein weiteres Kriterium. Beim seitenweisen Abruf mit Since = letztes CreateDate werden Kommentare mit exakt demselben CreateDate wie die zuletzt gelieferte Zeile übersprungen, da der Filter echt größer (>) prüft. Endet eine Seite mitten in Zeilen mit gleichem Zeitstempel, gehen die restlichen Zeilen verloren.
Die maximale Seitengröße beträgt 1000 Zeilen; größere Werte für RowCount führen nicht zu einem Fehler, sondern werden stillschweigend auf 1000 gesetzt.
Es werden nur Kommentare geliefert, deren Auftrag in OrderHeader existiert (Inner Join).
Ein Since-Wert von 1900-01-01 (Wert eines leeren Datums) wird ebenfalls durch 2000-01-01 ersetzt.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`OrderNr`	int	NULL	Pixi-Auftragsnummer. `0` oder `NULL` bedeutet keinen Filter auf diese Nummer. Beispiel: `123456`
`OrderNrShop`	varchar(50) string	NULL	Externe (Shop-)Auftragsnummer, verglichen mit `OrderNrExternal`. Leer oder `NULL` bedeutet keinen Filter auf diese Nummer. Beispiel: `SHOP-100023`
`Since`	datetime dateTime	2000-01-01	Es werden nur Kommentare geliefert, die echt nach diesem Zeitpunkt angelegt wurden. `NULL` wird durch `2000-01-01` ersetzt. Beispiel: `2024-05-01T00:00:00`
`RowCount`	int	1000	Maximale Anzahl zurückgegebener Zeilen (1 bis 1000). Werte außerhalb dieses Bereichs oder `NULL` werden durch 1000 ersetzt. Beispiel: `500`

Antwort

Result-Set 1 · Immer (kann leer sein).

Auftragskommentare, die den Filtern entsprechen, aufsteigend nach CreateDate sortiert, höchstens RowCount Zeilen.

Spalte	Typ	Beschreibung
`Comment` Kann leer sein	string	Text des Kommentars.
`CreateEmp` Kann leer sein	string	Mitarbeiter, der den Kommentar angelegt hat.
`CreateDate`	datetime dateTime	Datum und Uhrzeit der Anlage des Kommentars; der Wert der letzten Zeile kann als `Since` für den nächsten Aufruf verwendet werden.
`OrderNrExternal` Kann leer sein	string	Externe (Shop-)Auftragsnummer des Auftrags.
`OrderNr`	int	Pixi-Auftragsnummer, zu der der Kommentar gehört.

Beispielantwort

<SqlRowSet1>
  <row>
    <Comment>Customer asked for delivery after 2 pm.</Comment>
    <CreateEmp>MK</CreateEmp>
    <CreateDate>2024-05-02T09:15:32.000</CreateDate>
    <OrderNrExternal>SHOP-100023</OrderNrExternal>
    <OrderNr>123456</OrderNr>
  </row>
  <row>
    <Comment>Address corrected by phone.</Comment>
    <CreateEmp>AS</CreateEmp>
    <CreateDate>2024-05-02T11:48:07.000</CreateDate>
    <OrderNrExternal>SHOP-100031</OrderNrExternal>
    <OrderNr>123470</OrderNr>
  </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:pixiGetOrderComments>
      <!-- <OrderNr>123456</OrderNr> -->
      <!-- <OrderNrShop>SHOP-100023</OrderNrShop> -->
      <!-- <Since>2024-05-01T00:00:00</Since> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiGetOrderComments>
  </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:pixiGetOrderComments>
      <!-- <OrderNr>123456</OrderNr> -->
      <!-- <OrderNrShop>SHOP-100023</OrderNrShop> -->
      <!-- <Since>2024-05-01T00:00:00</Since> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiGetOrderComments>
  </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 = [
    // 'OrderNr' => '123456',
    // 'OrderNrShop' => 'SHOP-100023',
    // 'Since' => '2024-05-01T00:00:00',
    // 'RowCount' => '500',
];

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

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

Verwendete Tabellen

OrderHeader · Lesen OrderComments · Lesen

SQL-Objekt:: dbo.pipiGetOrderComments