pixiGetOrderHeadersByOrderDate
Liefert Auftragsköpfe mit Zahlungs-, Versand-, Gutschein- und Tracking-Daten für alle Aufträge mit Auftragspositionen, deren Bestelldatum im angegebenen Zeitraum liegt.
Liefert eine Zeile je Auftragskopf für alle Aufträge mit mindestens einer Auftragsposition, deren Orderdate zwischen FromDate und ToDate liegt (inklusive, BETWEEN).
Filter
ShopIDschränkt die Auftragspositionen auf diejenigen ein, derenCustomerOFdem angegebenen Shop entspricht. Ein Leerstring wird wieNULLbehandelt, d. h. alle Shops.- Es werden nur Aufträge geliefert, zu denen ein Kunde, eine Rechnungsadresse (
AddrRef) und eine Währung existieren (Inner Joins aufCustomers,Addressesundpixi.Currency).
Aufbau des Ergebnisses
- Die Basisdaten stammen aus dem Auftragskopf, dem Kunden, der Rechnungsadresse (Bank- und Kreditkartendaten, PLZ) und der Währung (
CurrencyCode).OrderLockedist das Sperrkennzeichen der Lieferadresse,N, falls keine gefunden wird. PaymentTypewird aus der Zahlungsart der Rechnungsadresse gefüllt.OrderNrExternal,OrderDate,VoucherIDundVoucherAmountstammen aus den Auftragspositionen (bzw. dem Gutschein),ShipCostaus dem Auftragskopf.TrackingID(Sendungs-Tracking-ID, sonst die Direct-Fulfillment-Tracking-ID) undShipVendorstammen aus den Rechnungen zu den Positionen des Auftrags.Shipdateist das früheste undLastShipdatedas späteste Scan-Out-Datum aller Rechnungen zu den Positionen des Auftrags.
Das Ergebnis ist nach OrderDate aufsteigend sortiert. Es gibt kein Paging.
Hinweise
- Alle Lesezugriffe verwenden
NOLOCK, daher können nicht festgeschriebene Daten geliefert werden. BETWEENist inklusiv: IstToDateein Datum ohne Uhrzeit (Mitternacht), werden spätere Auftragspositionen dieses Tages nicht erfasst. Für den ganzen Tag z. B.2024-01-31T23:59:59übergeben.- Der Shop-Filter wirkt auf
CustomerOFder Auftragspositionen, das gelieferteShopIDist dagegenCustomerOfdes Kunden. - Bei Aufträgen mit mehreren Positionen oder Rechnungen werden
OrderNrExternal,OrderDate,VoucherID,VoucherAmount,TrackingIDundShipVendoraus einer beliebigen passenden Zeile übernommen.OrderDatekann daher von einer Position außerhalb des angefragten Zeitraums stammen. Shipdate,LastShipdate,TrackingIDundShipVendorsindNULL, solange keine Rechnung existiert.- Das Ergebnis enthält sensible Zahlungsdaten (Kreditkartennummer, Bankverbindung) der Rechnungsadresse.
- Kein Paging: Große Zeiträume können große Ergebnisse und lange Laufzeiten verursachen.
Parameter
| Parameter | Typ | Standardwert | Beschreibung |
|---|---|---|---|
FromDate
Pflicht
|
datetime dateTime |
– |
Beginn des Zeitraums für das Bestelldatum der Auftragspositionen (inklusive). Beispiel: |
ToDate
Pflicht
|
datetime dateTime |
– |
Ende des Zeitraums für das Bestelldatum der Auftragspositionen (inklusive). Beispiel: |
ShopID
|
varchar(3) string |
NULL |
Shop-ID zur Filterung der Auftragspositionen ( Beispiel: |
Antwort
Result-Set 1 · Immer (kann leer sein).
Eine Zeile je passendem Auftragskopf, sortiert nach OrderDate aufsteigend.
| Spalte | Typ | Beschreibung |
|---|---|---|
OrderHeaderKey
|
int |
Interner Schlüssel des Auftragskopfs. |
OrderNr
|
int |
Pixi-Auftragsnummer. |
CreateDate
Kann leer sein |
dateTime |
Anlagedatum des Auftragskopfs. |
OrderNrExternal
Kann leer sein |
varchar(50) string |
Externe (Shop-)Auftragsnummer aus einer Auftragsposition. |
OrderTotal
Kann leer sein |
money decimal |
Auftragssumme aus dem Auftragskopf. |
OrderlinesTotal
Kann leer sein |
money decimal |
Summe der Auftragspositionen aus dem Auftragskopf. |
WholeOrderState
Kann leer sein |
varchar(6) string |
Status des gesamten Auftrags ( |
Shipdate
Kann leer sein |
datetime dateTime |
Frühestes Scan-Out-Datum der Rechnungen des Auftrags. |
LastShipdate
Kann leer sein |
datetime dateTime |
Spätestes Scan-Out-Datum der Rechnungen des Auftrags. |
TrackingID
Kann leer sein |
varchar(512) string |
Sendungs-Tracking-ID einer Rechnung, sonst deren Direct-Fulfillment-Tracking-ID. |
ShipVendor
Kann leer sein |
varchar(3) string |
Versanddienstleister einer Rechnung des Auftrags. |
ShopID
Kann leer sein |
string |
Shop des Kunden ( |
OrderDate
Kann leer sein |
datetime dateTime |
Bestelldatum aus einer Auftragsposition des Auftrags. |
ShipCost
Kann leer sein |
money decimal |
Versandkosten aus dem Auftragskopf. |
PaymentAddressId
Kann leer sein |
int |
Schlüssel der Rechnungsadresse ( |
ShipmentAddressId
Kann leer sein |
int |
Schlüssel der Lieferadresse ( |
ShopNote
Kann leer sein |
string |
Shop-Notiz des Auftrags. |
PaymentType
Kann leer sein |
char(1) string |
Zahlungsart der Rechnungsadresse ( |
VoucherID
Kann leer sein |
varchar(50) string |
Gutschein-ID aus einer Auftragsposition. |
VoucherAmount
Kann leer sein |
money decimal |
Betrag des Gutscheins. |
CcCardType
Kann leer sein |
string |
Kreditkartentyp der Rechnungsadresse. |
CcCardNr
Kann leer sein |
string |
Kreditkartennummer der Rechnungsadresse. |
CcCardName
Kann leer sein |
string |
Name des Kreditkarteninhabers. |
CcCardExp
Kann leer sein |
string |
Ablaufdatum der Kreditkarte. |
Account
Kann leer sein |
string |
Kontonummer der Rechnungsadresse. |
Blz
Kann leer sein |
string |
Bankleitzahl. |
BankName
Kann leer sein |
string |
Name der Bank. |
AccountName
Kann leer sein |
string |
Name des Kontoinhabers. |
AddressRemarks
Kann leer sein |
string |
Adressbemerkungen des Auftrags. |
AddrRef
Kann leer sein |
int |
Schlüssel der Rechnungsadresse (wie |
ZIP
Kann leer sein |
string |
PLZ der Rechnungsadresse. |
CustKey
|
int |
Schlüssel des Kunden. |
OrderLocked
|
string |
Sperrkennzeichen ( |
CurrencyCode
Kann leer sein |
string |
Alphabetischer Währungscode des Auftrags. |
Beispielantwort
<SqlRowSet1>
<row>
<OrderHeaderKey>48211</OrderHeaderKey>
<OrderNr>100532</OrderNr>
<CreateDate>2024-01-15T10:22:31</CreateDate>
<OrderNrExternal>WEB-778812</OrderNrExternal>
<OrderTotal>129.9000</OrderTotal>
<OrderlinesTotal>124.9000</OrderlinesTotal>
<WholeOrderState>AUS</WholeOrderState>
<Shipdate>2024-01-16T14:05:00</Shipdate>
<LastShipdate>2024-01-16T14:05:00</LastShipdate>
<TrackingID>00340434161094042557</TrackingID>
<ShipVendor>DHL</ShipVendor>
<ShopID>SHP</ShopID>
<OrderDate>2024-01-15T10:20:00</OrderDate>
<ShipCost>4.9900</ShipCost>
<PaymentAddressId>77120</PaymentAddressId>
<ShipmentAddressId>77121</ShipmentAddressId>
<ShopNote>Bitte klingeln</ShopNote>
<PaymentType>R</PaymentType>
<AddressRemarks/>
<AddrRef>77120</AddrRef>
<ZIP>10115</ZIP>
<CustKey>30455</CustKey>
<OrderLocked>N</OrderLocked>
<CurrencyCode>EUR</CurrencyCode>
</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:pixiGetOrderHeadersByOrderDate>
<FromDate>2024-01-01T00:00:00</FromDate>
<ToDate>2024-01-31T23:59:59</ToDate>
<!-- <ShopID>SHP</ShopID> -->
</ns1:pixiGetOrderHeadersByOrderDate>
</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:pixiGetOrderHeadersByOrderDate>
<FromDate>2024-01-01T00:00:00</FromDate>
<ToDate>2024-01-31T23:59:59</ToDate>
<!-- <ShopID>SHP</ShopID> -->
</ns1:pixiGetOrderHeadersByOrderDate>
</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 = [
'FromDate' => '2024-01-01T00:00:00',
'ToDate' => '2024-01-31T23:59:59',
// 'ShopID' => 'SHP',
];
$soapArguments = [];
foreach ($arguments as $name => $value) {
$soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}
$response = $soapClient->__soapCall('pixiGetOrderHeadersByOrderDate', $soapArguments);
Verwendete Tabellen
- SQL-Objekt:
- dbo.pipiGetOrderHeadersByOrderDate