pixiGetInvoiceShippingInformation
Liefert versandrelevante Informationen zu einer Rechnung: Zahlungsart, Versender, Beträge, Lieferadresse mit Länderdaten, Auftragsdaten und Paketgewichte.
Sucht die Rechnung mit der übergebenen InvoiceNr und liefert eine Zeile mit den Daten, die ein Versand- oder Etikettentool typischerweise benötigt.
Die Zeile setzt sich wie folgt zusammen:
- Rechnung: Nummer, Datum, Shop, Zahlungsartcode, Versendercode, Gesamtbetrag und Versandkosten aus
Invoices. - Währung: Währungscode (
CodeA) der Rechnungswährung. Die Verknüpfung ist ein Inner Join; eine Rechnung ohne passenden Währungsdatensatz liefert keine Zeile. - Zahlungsart und Versender: Text der Zahlungsart und Name des Versenders (optional, ggf. leer).
- Lieferadresse: die Adresse aus der Lieferadressreferenz der Rechnung (
ShipAdrRef) mit Namensbestandteilen, Straße, Hausnummer, Ort, PLZ, Postfach, Telefon, E-Mail und USt-IdNr. - Land: Ländername, EasyLog-Ländername sowie ISO2-/ISO3-Code des Adresslandes.
- Auftrag: Der zugehörige Auftrag wird über die Rechnungspositionen ermittelt: Die erste gefundene Rechnungsposition verweist auf eine Auftragsposition, deren Auftrag verwendet wird. Daraus werden Adressbemerkungen, DHL-Verfahren/-Produkt/-Extras, Geschenknachricht, Versanddatum, Shop-Notiz, Auftragsnummer und externe Auftragsnummer geliefert.
- Gewichte: Netto- und Bruttopaketgewicht, auf 3 Nachkommastellen gerundet.
Existiert keine Rechnung mit dieser Nummer, ist die Ergebnismenge leer.
Hinweise
- Alle Tabellen werden mit
NOLOCKgelesen; es können nicht festgeschriebene Daten geliefert werden. - Der Auftrag wird über
TOP 1-Unterabfragen ohneORDER BYermittelt. Enthält eine Rechnung Positionen aus mehreren Aufträgen, wird nur einer davon verwendet, und welcher, ist nicht deterministisch. Total_OrderCurrentspricht immerTotalundShipCost_OrderCurrimmerShipCost; Kommentare im Code markieren diese Spalten zur Entfernung, daher sollte man sich nicht auf sie verlassen.PackageNetWeightundPackageGrossWeightwerden ohne Tabellenalias referenziert; aus dem Code ist nicht ersichtlich, ob sie ausInvoicesoderOrderHeaderstammen.- Es werden keine Fehlerzeilen geliefert; eine unbekannte Rechnungsnummer ergibt einfach keine Zeilen.
Parameter
| Parameter | Typ | Standardwert | Beschreibung |
|---|---|---|---|
InvoiceNr
Pflicht
|
varchar(50) string |
– |
Nummer der Rechnung ( Beispiel: |
Antwort
Result-Set 1 · Immer; enthält eine Zeile, wenn die Rechnung existiert und eine gültige Währung hat, sonst keine Zeilen.
Versandinformationen der Rechnung.
| Spalte | Typ | Beschreibung |
|---|---|---|
InvoiceNr
|
string |
Rechnungsnummer. |
InvDate
Kann leer sein |
dateTime |
Rechnungsdatum. |
Shop
Kann leer sein |
string |
Shop-ID der Rechnung ( |
PaymentCode
Kann leer sein |
string |
Code der Zahlungsart der Rechnung. |
PaymentText
Kann leer sein |
string |
Bezeichnung der Zahlungsart. |
ShipVendorCode
Kann leer sein |
string |
Versendercode der Rechnung. |
ShipVendorName
Kann leer sein |
string |
Name des Versenders. |
Total
Kann leer sein |
decimal |
Gesamtbetrag der Rechnung. |
Currency
Kann leer sein |
string |
Währungscode ( |
Total_OrderCurr
Kann leer sein |
decimal |
Gleicher Wert wie |
ShipCost
Kann leer sein |
decimal |
Versandkosten der Rechnung ( |
ShipCost_OrderCurr
Kann leer sein |
decimal |
Gleicher Wert wie |
Anrede
Kann leer sein |
string |
Anrede der Lieferadresse. |
Name
Kann leer sein |
string |
Name der Lieferadresse. |
Name2
Kann leer sein |
string |
Zweite Namenszeile der Lieferadresse. |
FirstName
Kann leer sein |
string |
Vorname. |
LastName
Kann leer sein |
string |
Nachname. |
CareOf
Kann leer sein |
string |
c/o-Zeile. |
Address
Kann leer sein |
string |
Adresszeile der Lieferadresse. |
Street
Kann leer sein |
string |
Straße. |
HouseNr
Kann leer sein |
string |
Hausnummer. |
City
Kann leer sein |
string |
Ort. |
State
Kann leer sein |
string |
Bundesland bzw. Region. |
ZIP
Kann leer sein |
string |
Postleitzahl. |
Country
Kann leer sein |
string |
Pixi-Ländercode der Lieferadresse. |
CountryName
Kann leer sein |
string |
Ländername. |
EasylogCountryName
Kann leer sein |
string |
Ländername für EasyLog. |
CountryISO2
Kann leer sein |
string |
ISO-3166-Alpha-2-Ländercode. |
CountryISO3
Kann leer sein |
string |
ISO-3166-Alpha-3-Ländercode. |
ZIPMailbox
Kann leer sein |
string |
Postleitzahl des Postfachs ( |
Mailbox
Kann leer sein |
string |
Postfach. |
Phone
Kann leer sein |
string |
Telefonnummer. |
Fax
Kann leer sein |
string |
Faxnummer. |
eMail
Kann leer sein |
string |
E-Mail-Adresse. |
UsStId
Kann leer sein |
string |
USt-IdNr. der Adresse. |
Note
Kann leer sein |
string |
Notiz zur Adresse. |
Address_Remarks
Kann leer sein |
string |
Adressbemerkungen des Auftrags. |
DHLVerfahren
Kann leer sein |
string |
DHL-Verfahren des Auftrags ( |
DHLProdukt
Kann leer sein |
string |
DHL-Produkt des Auftrags. |
DHLExtras
Kann leer sein |
string |
DHL-Extras des Auftrags. |
GiftMessage
Kann leer sein |
string |
Geschenknachricht des Auftrags. |
OrderShipDate
Kann leer sein |
dateTime |
Versanddatum des Auftrags. |
ShopNote
Kann leer sein |
string |
Shop-Notiz des Auftrags. |
OrderNr
Kann leer sein |
string |
Pixi-Auftragsnummer des zugehörigen Auftrags. |
OrderNrExternal
Kann leer sein |
string |
Externe Auftragsnummer (Shop). |
PackageNetWeight
Kann leer sein |
numeric(8,3) decimal |
Netto-Paketgewicht, auf 3 Nachkommastellen gerundet. |
PackageGrossWeight
Kann leer sein |
numeric(8,3) decimal |
Brutto-Paketgewicht, auf 3 Nachkommastellen gerundet. |
Beispielantwort
<SqlRowSet1>
<row>
<InvoiceNr>RE2024001234</InvoiceNr>
<InvDate>2024-03-15T10:22:00</InvDate>
<Shop>SHOP1</Shop>
<PaymentCode>VK</PaymentCode>
<PaymentText>Vorkasse</PaymentText>
<ShipVendorCode>DHL</ShipVendorCode>
<ShipVendorName>DHL Paket</ShipVendorName>
<Total>59.90</Total>
<Currency>EUR</Currency>
<Total_OrderCurr>59.90</Total_OrderCurr>
<ShipCost>4.90</ShipCost>
<ShipCost_OrderCurr>4.90</ShipCost_OrderCurr>
<Anrede>Frau</Anrede>
<Name>Anna Schmidt</Name>
<FirstName>Anna</FirstName>
<LastName>Schmidt</LastName>
<Street>Hauptstraße</Street>
<HouseNr>12</HouseNr>
<City>München</City>
<ZIP>80331</ZIP>
<Country>D</Country>
<CountryName>Deutschland</CountryName>
<EasylogCountryName>DEUTSCHLAND</EasylogCountryName>
<CountryISO2>DE</CountryISO2>
<CountryISO3>DEU</CountryISO3>
<eMail>anna.schmidt@example.com</eMail>
<OrderNr>456789</OrderNr>
<OrderNrExternal>100012345</OrderNrExternal>
<PackageNetWeight>1.250</PackageNetWeight>
<PackageGrossWeight>1.480</PackageGrossWeight>
</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:pixiGetInvoiceShippingInformation>
<InvoiceNr>RE2024001234</InvoiceNr>
</ns1:pixiGetInvoiceShippingInformation>
</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:pixiGetInvoiceShippingInformation>
<InvoiceNr>RE2024001234</InvoiceNr>
</ns1:pixiGetInvoiceShippingInformation>
</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 = [
'InvoiceNr' => 'RE2024001234',
];
$soapArguments = [];
foreach ($arguments as $name => $value) {
$soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}
$response = $soapClient->__soapCall('pixiGetInvoiceShippingInformation', $soapArguments);
Verwendete Tabellen
- SQL-Objekt:
- dbo.pipiGetInvoiceShippingInformation