General Lesen

pixiGetCountries

Liefert ein Land oder alle Länder aus den Länderstammdaten von Pixi, optional nur Länder, die in Adressen verwendet werden.

Liest die Länderstammdaten aus der Tabelle Countries.

Ist CntCode gesetzt, wird nur das Land mit diesem Code geliefert.
Ist CntCode leer oder NULL, werden alle Länder geliefert. Ein Leerstring wird wie NULL behandelt.
Ist OnlyActive = 1 und kein CntCode angegeben, beschränkt sich die Liste auf Länder, deren Code in der Spalte Country mindestens eines Datensatzes in Addresses vorkommt.
Ist OnlyActive = 1 und ein CntCode angegeben, wird das Land geliefert, unabhängig davon, ob es in einer Adresse verwendet wird.

Die Sortierung erfolgt nach CntName. Jede Zeile enthält den internen Ländercode, den Namen, die Standard-Versandkosten, das Datumsformat, den Sprachcode, die ISO-2- und ISO-3-Codes, MwSt.-Einstellungen und das EU-Kennzeichen.

Hinweise

„Aktiv“ bei OnlyActive bezieht sich nicht auf ein Aktiv-Kennzeichen der Länderdaten. Gemeint ist nur, dass das Land in mindestens einer Adresse in Addresses verwendet wird.
Die ISO-3-Spalte wird mit dem Alias CntCodeIsO3 (kleines s) geliefert. XML-Elementnamen unterscheiden Groß- und Kleinschreibung, daher muss der Client genau diesen Namen lesen.
Beide Tabellen werden mit NOLOCK gelesen. Das Ergebnis kann nicht festgeschriebene Daten enthalten.
Die Spaltentypen sind im Code nicht ersichtlich. Die SQL-Typen sind daher als unknown angegeben.

Parameter

Parameter Typ Standardwert Beschreibung

Parameter	Typ	Standardwert	Beschreibung
`CntCode`	varchar(3) string	NULL	Interner Pixi-Ländercode des gewünschten Landes. Bei Leerstring oder `NULL` werden alle Länder geliefert. Beispiel: `D`
`OnlyActive`	bit boolean	0	Bei `1` und ohne `CntCode` werden nur Länder geliefert, die in mindestens einer Adresse verwendet werden. Erlaubte Werte `0` – Alle Länder (bzw. das angefragte Land) `1` – Nur Länder, die in `Addresses` verwendet werden, sofern kein `CntCode` angegeben ist Beispiel: `1`

CntCode

varchar(3)
string

NULL

Interner Pixi-Ländercode des gewünschten Landes. Bei Leerstring oder NULL werden alle Länder geliefert.

Beispiel: D

OnlyActive

bit
boolean

Bei 1 und ohne CntCode werden nur Länder geliefert, die in mindestens einer Adresse verwendet werden.

Erlaubte Werte

0 – Alle Länder (bzw. das angefragte Land)
1 – Nur Länder, die in `Addresses` verwendet werden, sofern kein `CntCode` angegeben ist

Beispiel: 1

Antwort

Result-Set 1 · Immer

Länderstammdaten, eine Zeile je Land, sortiert nach CntName.

Spalte	Typ	Beschreibung
`CntCode`	string	Interner Pixi-Ländercode
`CntName` Kann leer sein	string	Name des Landes
`DefShipCost` Kann leer sein	decimal	Standard-Versandkosten für das Land
`DateFormat` Kann leer sein	string	Für das Land verwendetes Datumsformat
`LangCode` Kann leer sein	string	Sprachcode des Landes
`LocationID` Kann leer sein	int	Dem Land zugeordnete Location-ID
`CntCodeISO2` Kann leer sein	string	ISO-3166-1-Alpha-2-Ländercode
`CntCodeIsO3` Kann leer sein	string	ISO-3166-1-Alpha-3-Ländercode (Quellspalte `CntCodeISO3`)
`ChargeVAT` Kann leer sein	boolean	Gibt an, ob für dieses Land MwSt. berechnet wird
`CntNames` Kann leer sein	string	Alternative bzw. lokalisierte Ländernamen
`VATLimit` Kann leer sein	decimal	MwSt.-Schwellenwert (Lieferschwelle) für das Land
`IsEU` Kann leer sein	boolean	Gibt an, ob das Land EU-Mitglied ist

Beispielantwort

<SqlRowSet1>
  <row>
    <CntCode>A</CntCode>
    <CntName>Österreich</CntName>
    <DefShipCost>9.90</DefShipCost>
    <DateFormat>dd.mm.yyyy</DateFormat>
    <LangCode>DE</LangCode>
    <LocationID>1</LocationID>
    <CntCodeISO2>AT</CntCodeISO2>
    <CntCodeIsO3>AUT</CntCodeIsO3>
    <ChargeVAT>1</ChargeVAT>
    <CntNames>Austria</CntNames>
    <VATLimit>35000.00</VATLimit>
    <IsEU>1</IsEU>
  </row>
  <row>
    <CntCode>D</CntCode>
    <CntName>Deutschland</CntName>
    <DefShipCost>4.90</DefShipCost>
    <DateFormat>dd.mm.yyyy</DateFormat>
    <LangCode>DE</LangCode>
    <LocationID>1</LocationID>
    <CntCodeISO2>DE</CntCodeISO2>
    <CntCodeIsO3>DEU</CntCodeIsO3>
    <ChargeVAT>1</ChargeVAT>
    <CntNames>Germany</CntNames>
    <VATLimit>0.00</VATLimit>
    <IsEU>1</IsEU>
  </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:pixiGetCountries>
      <!-- <CntCode>D</CntCode> -->
      <!-- <OnlyActive>1</OnlyActive> -->
    </ns1:pixiGetCountries>
  </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:pixiGetCountries>
      <!-- <CntCode>D</CntCode> -->
      <!-- <OnlyActive>1</OnlyActive> -->
    </ns1:pixiGetCountries>
  </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 = [
    // 'CntCode' => 'D',
    // 'OnlyActive' => '1',
];

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

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

Verwendete Tabellen

Countries · Lesen Addresses · Lesen

SQL-Objekt:: dbo.pipiGetCountries