Orderlines Lesen

pixiReadBundleOrderlines

Liefert Bundle-Auftragspositionen aus `BundleOrderlines`, gefiltert nach Anlage- und/oder Änderungsdatum und seitenweise nach Schlüssel.

Liest Bundle-Auftragspositionen (die Kopfzeilen von Bundles in Aufträgen) aus der Tabelle BundleOrderlines mit schlüsselbasiertem Paging.

Auswahl der Kandidaten. Es wird nur die erste zutreffende Filtergruppe angewendet, in dieser Reihenfolge:

CreateAndUpdateDateFrom / CreateAndUpdateDateTo: Positionen, deren CreateDate oder UpdateDate im Zeitraum liegt.
CreateDateFrom / CreateDateTo: Positionen, deren CreateDate im Zeitraum liegt.
UpdateDateFrom / UpdateDateTo: Positionen, deren UpdateDate im Zeitraum liegt.
Kein Datumsfilter: alle Positionen.

Innerhalb einer Datumsgruppe wird ein fehlender From-Wert durch das aktuelle Datum minus zwei Jahre ersetzt, ein fehlender To-Wert durch das aktuelle Datum mit Uhrzeit. Die Zeiträume sind inklusiv (BETWEEN).

Paging. In allen Fällen werden nur Positionen mit BundleOrderlineKey > OrderlineKey geliefert. OrderlineKey ist standardmäßig 0. Es werden höchstens RowCount Positionen geliefert (Standard 1000), aufsteigend sortiert nach BundleOrderlineKey. Für die nächste Seite wird der höchste OrderlineKey der vorherigen Seite übergeben.

Das Ergebnis ist eine Ergebnismenge mit ausgewählten Spalten aus BundleOrderlines, aufsteigend sortiert nach OrderlineKey.

Hinweise

OrderlineKey ist kein Filter auf genau einen Schlüssel. Da ein NULL-Wert zu Beginn durch 0 und RowCount durch 1000 ersetzt wird, wird der Codezweig zum Lesen eines einzelnen Schlüssels nie erreicht. Um genau eine Position mit Schlüssel n zu lesen, OrderlineKey = n-1 und RowCount = 1 übergeben.
Ein NULL-Wert für RowCount wird als 1000 behandelt.
Alle Lesezugriffe verwenden NOLOCK; es können nicht festgeschriebene Daten geliefert sowie bei gleichzeitigen Änderungen Zeilen übersprungen oder doppelt geliefert werden.
Die Datums-Standardwerte beruhen auf der Serverzeit (GETDATE()); ohne From-Wert liefern die Datumsfilter keine Positionen, die älter als zwei Jahre sind.
Die Datentypen der Spalten sind im Code nicht sichtbar; sie stammen aus der Tabelle BundleOrderlines.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`OrderlineKey`	int	NULL	Paging-Cursor: Es werden nur Positionen mit einem Schlüssel größer als dieser Wert geliefert. NULL wird als `0` behandelt. Beispiel: `0`
`CreateDateFrom`	datetime dateTime	NULL	Beginn des Anlagedatum-Zeitraums. Wird nur verwendet, wenn kein kombinierter Zeitraum angegeben ist. Ist nur das Ende gesetzt, gilt das Datum vor zwei Jahren. Beispiel: `2024-01-01T00:00:00`
`CreateDateTo`	datetime dateTime	NULL	Ende des Anlagedatum-Zeitraums (inklusiv). Ist nur der Beginn gesetzt, gilt das aktuelle Datum mit Uhrzeit. Beispiel: `2024-12-31T23:59:59`
`UpdateDateFrom`	datetime dateTime	NULL	Beginn des Änderungsdatum-Zeitraums. Wird nur verwendet, wenn weder ein kombinierter noch ein Anlagedatum-Zeitraum angegeben ist. Ist nur das Ende gesetzt, gilt das Datum vor zwei Jahren. Beispiel: `2024-06-01T00:00:00`
`UpdateDateTo`	datetime dateTime	NULL	Ende des Änderungsdatum-Zeitraums (inklusiv). Ist nur der Beginn gesetzt, gilt das aktuelle Datum mit Uhrzeit. Beispiel: `2024-06-30T23:59:59`
`CreateAndUpdateDateFrom`	datetime dateTime	NULL	Beginn eines Zeitraums, der gegen `CreateDate` oder `UpdateDate` geprüft wird. Hat Vorrang vor allen anderen Datumsfiltern. Ist nur das Ende gesetzt, gilt das Datum vor zwei Jahren. Beispiel: `2024-06-01T00:00:00`
`CreateAndUpdateDateTo`	datetime dateTime	NULL	Ende des kombinierten Anlage-/Änderungszeitraums (inklusiv). Ist nur der Beginn gesetzt, gilt das aktuelle Datum mit Uhrzeit. Beispiel: `2024-06-30T23:59:59`
`RowCount`	int	1000	Maximale Anzahl gelieferter Positionen pro Aufruf. NULL wird als `1000` behandelt. Beispiel: `500`

Antwort

Result-Set 1 · Immer (ggf. leer)

Bundle-Auftragspositionen, die den Filtern entsprechen, aufsteigend sortiert nach OrderlineKey.

Spalte	Typ	Beschreibung
`OrderlineKey`	int	Schlüssel der Bundle-Auftragsposition (`BundleOrderlineKey`); dient als Paging-Cursor.
`OrderNr` Kann leer sein	int	Auftragsnummer.
`CustRef` Kann leer sein	int	Referenz auf den Kunden.
`AddrRef` Kann leer sein	int	Referenz auf die Adresse.
`ShipAdrRef` Kann leer sein	int	Referenz auf die Lieferadresse.
`SupplInfo` Kann leer sein	string	Lieferanteninformation.
`ArtNr` Kann leer sein	string	Artikelnummer.
`ArtName` Kann leer sein	string	Artikelname.
`Qty` Kann leer sein	int	Menge.
`Price` Kann leer sein	decimal	Verkaufspreis.
`SupplPrice` Kann leer sein	decimal	Lieferanten-/Einkaufspreis.
`Status` Kann leer sein	string	Status der Position.
`Note` Kann leer sein	string	Notiz.
`OrderMS` Kann leer sein	string	Wert der Spalte `OrderMS`.
`ConfigType` Kann leer sein	string	Konfigurationstyp.
`Source` Kann leer sein	string	Quelle der Auftragsposition.
`OrderDate` Kann leer sein	dateTime	Auftragsdatum.
`TimeZone` Kann leer sein	string	Zeitzone des Auftragsdatums.
`OrderLineType` Kann leer sein	string	Typ der Auftragsposition.
`CreateDate` Kann leer sein	dateTime	Anlagedatum.
`CreateEmp` Kann leer sein	string	Mitarbeiter, der die Position angelegt hat.
`UpdateDate` Kann leer sein	dateTime	Datum der letzten Änderung.
`UpdateEmp` Kann leer sein	string	Mitarbeiter, der die Position zuletzt geändert hat.
`ItemRef` Kann leer sein	int	Referenz auf den Artikel.
`WaitDays` Kann leer sein	int	Wartetage.
`TaxAmount` Kann leer sein	decimal	Steuerbetrag.
`TaxRate` Kann leer sein	decimal	Steuersatz.
`ShipCostPerItem` Kann leer sein	decimal	Versandkosten pro Stück.
`OrderNrExternal` Kann leer sein	string	Externe Auftragsnummer (z. B. aus dem Shop).
`ItemNrExternal` Kann leer sein	string	Externe Artikelnummer.
`LocationID` Kann leer sein	string	ID des Standorts (Lager).
`LastOrdLocationID` Kann leer sein	string	Standort-ID der letzten Bestellung.
`SupplGroup` Kann leer sein	string	Lieferantengruppe.
`rowguid` Kann leer sein	string	Zeilen-GUID.
`OrdShopID` Kann leer sein	string	Shop-ID des Auftrags.
`VoucherID` Kann leer sein	string	Gutschein-ID.
`oItemSpecialNote` Kann leer sein	string	Besondere Notiz zum Artikel.
`DiscountValue` Kann leer sein	decimal	Rabattbetrag.
`DiscountPerc` Kann leer sein	decimal	Rabatt in Prozent.
`FullPrice` Kann leer sein	decimal	Vollpreis vor Rabatt.
`DF_type` Kann leer sein	string	Direct-Fulfillment-Typ.
`Price_Net` Kann leer sein	decimal	Nettopreis.
`VATPercent` Kann leer sein	decimal	Mehrwertsteuersatz in Prozent.
`VATsRef` Kann leer sein	int	Referenz auf den Mehrwertsteuer-Datensatz.

Beispielantwort

<SqlRowSet1>
  <row>
    <OrderlineKey>10452</OrderlineKey>
    <OrderNr>200315</OrderNr>
    <CustRef>8812</CustRef>
    <AddrRef>9120</AddrRef>
    <ShipAdrRef>9121</ShipAdrRef>
    <ArtNr>BUNDLE-001</ArtNr>
    <ArtName>Starter Set</ArtName>
    <Qty>1</Qty>
    <Price>49.90</Price>
    <Status>AUF</Status>
    <OrderDate>2024-06-12T10:15:00</OrderDate>
    <CreateDate>2024-06-12T10:15:03</CreateDate>
    <CreateEmp>API</CreateEmp>
    <UpdateDate>2024-06-12T11:02:44</UpdateDate>
    <UpdateEmp>API</UpdateEmp>
    <ItemRef>3301</ItemRef>
    <OrderNrExternal>SHOP-100045</OrderNrExternal>
    <LocationID>001</LocationID>
    <OrdShopID>SHOP1</OrdShopID>
    <Price_Net>41.93</Price_Net>
    <VATPercent>19.00</VATPercent>
  </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:pixiReadBundleOrderlines>
      <!-- <OrderlineKey>0</OrderlineKey> -->
      <!-- <CreateDateFrom>2024-01-01T00:00:00</CreateDateFrom> -->
      <!-- <CreateDateTo>2024-12-31T23:59:59</CreateDateTo> -->
      <!-- <UpdateDateFrom>2024-06-01T00:00:00</UpdateDateFrom> -->
      <!-- <UpdateDateTo>2024-06-30T23:59:59</UpdateDateTo> -->
      <!-- <CreateAndUpdateDateFrom>2024-06-01T00:00:00</CreateAndUpdateDateFrom> -->
      <!-- <CreateAndUpdateDateTo>2024-06-30T23:59:59</CreateAndUpdateDateTo> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiReadBundleOrderlines>
  </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:pixiReadBundleOrderlines>
      <!-- <OrderlineKey>0</OrderlineKey> -->
      <!-- <CreateDateFrom>2024-01-01T00:00:00</CreateDateFrom> -->
      <!-- <CreateDateTo>2024-12-31T23:59:59</CreateDateTo> -->
      <!-- <UpdateDateFrom>2024-06-01T00:00:00</UpdateDateFrom> -->
      <!-- <UpdateDateTo>2024-06-30T23:59:59</UpdateDateTo> -->
      <!-- <CreateAndUpdateDateFrom>2024-06-01T00:00:00</CreateAndUpdateDateFrom> -->
      <!-- <CreateAndUpdateDateTo>2024-06-30T23:59:59</CreateAndUpdateDateTo> -->
      <!-- <RowCount>500</RowCount> -->
    </ns1:pixiReadBundleOrderlines>
  </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 = [
    // 'OrderlineKey' => '0',
    // 'CreateDateFrom' => '2024-01-01T00:00:00',
    // 'CreateDateTo' => '2024-12-31T23:59:59',
    // 'UpdateDateFrom' => '2024-06-01T00:00:00',
    // 'UpdateDateTo' => '2024-06-30T23:59:59',
    // 'CreateAndUpdateDateFrom' => '2024-06-01T00:00:00',
    // 'CreateAndUpdateDateTo' => '2024-06-30T23:59:59',
    // 'RowCount' => '500',
];

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

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

Verwendete Tabellen

BundleOrderlines · Lesen

SQL-Objekt:: dbo.pipiReadBundleOrderlines