Customs Lesen

pixiGetItemCustomsInfo

Liefert die Zolldaten (Zolltarifnummer, Ursprungsland, Gewicht, Maße) eines Artikels, ermittelt über ItemKey, interne Artikelnummer oder EAN/UPC.

Liefert die zollrelevanten Stammdaten eines einzelnen Artikels aus den Artikelstammdaten.

Wird keiner der Parameter ItemKey, ItemNrInt und EanUpc übergeben, wird eine Statuszeile zurückgegeben. Alle Datenspalten sind NULL, ResultCode ist 501, und der Aufruf endet.
Ist ItemKey NULL oder 0, wird der Artikelschlüssel über ItemNrInt (interne Artikelnummer) ermittelt.
Wurde danach noch kein Artikelschlüssel gefunden, erfolgt die Suche über EanUpc.
Der Artikel mit dem ermittelten Schlüssel wird zurückgegeben. Das Ursprungsland CustomsCountryOfOrigin wird mit der Ländertabelle verknüpft, um zusätzlich den ISO2-Code zu liefern. Bei Erfolg ist ResultCode 200 und ResultMessage OK.

Vorrang der Kennungen: zuerst ItemKey, dann ItemNrInt, dann EanUpc. Existiert kein passender Artikel, ist die Ergebnismenge leer; eine Fehlerzeile wird nicht geliefert.

Hinweise

Alle Lesezugriffe verwenden NOLOCK; es können daher nicht festgeschriebene Daten geliefert werden.
Wird ein von 0 verschiedener, aber nicht existierender ItemKey übergeben, werden ItemNrInt und EanUpc nicht ersatzweise verwendet. Das Ergebnis ist dann einfach leer.
Die Suche über ItemNrInt bzw. EanUpc verwendet TOP 1 ohne ORDER BY. Teilen sich mehrere Artikel dieselbe EAN, ist nicht festgelegt, welcher Artikel geliefert wird.
Wird nur ItemKey = 0 übergeben, ist die Parameterprüfung bestanden, die Ergebnismenge bleibt aber leer.
Der Spaltenname Heigth ist im Quellcode falsch geschrieben und muss genau so ausgelesen werden.
CustomsCountryOfOriginISO2 ist NULL, wenn der Ländercode nicht in der Ländertabelle gefunden wird.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`ItemKey`	int	NULL	Interner Schlüssel des Artikels. Hat Vorrang vor den anderen Kennungen. `NULL` oder `0` bedeutet, dass der Artikel über `ItemNrInt` bzw. `EanUpc` gesucht wird. Beispiel: `4711`
`ItemNrInt`	varchar(50) string	NULL	Interne Artikelnummer. Wird nur verwendet, wenn `ItemKey` nicht übergeben wird. Beispiel: `ART-10023`
`EanUpc`	varchar(50) string	NULL	EAN/UPC des Artikels. Wird nur verwendet, wenn über `ItemKey` bzw. `ItemNrInt` kein Artikel gefunden wurde. Beispiel: `4006381333931`

Antwort

Result-Set 1 · Wenn `ItemKey`, `ItemNrInt` und `EanUpc` alle NULL sind

Statuszeile mit dem Fehlercode 501. Alle Datenspalten sind NULL.

Spalte	Typ	Beschreibung
`ItemKey` Kann leer sein	int	Immer NULL.
`CustomsTariffNumber` Kann leer sein	int string	Immer NULL.
`CustomsCountryOfOrigin` Kann leer sein	int string	Immer NULL.
`CustomsCountryOfOriginISO2` Kann leer sein	int string	Immer NULL.
`Weight` Kann leer sein	int decimal	Immer NULL.
`Heigth` Kann leer sein	int decimal	Immer NULL.
`Width` Kann leer sein	int decimal	Immer NULL.
`Length` Kann leer sein	int decimal	Immer NULL.
`CustomsTariffText` Kann leer sein	int string	Immer NULL.
`CustomsPreviousProcess` Kann leer sein	int string	Immer NULL.
`ResultCode`	varchar(3) string	Immer `501`.
`ResultMessage`	varchar(34) string	Immer `One of parameters must be supplied`.

Result-Set 2 · Wenn mindestens eine Kennung übergeben wird; leer, wenn kein passender Artikel existiert

Zolldaten des ermittelten Artikels.

Spalte	Typ	Beschreibung
`ItemKey`	int	Interner Schlüssel des Artikels.
`CustomsTariffNumber` Kann leer sein	string	Zolltarifnummer (HS-Code) des Artikels.
`CustomsCountryOfOrigin` Kann leer sein	string	Pixi-Ländercode des Ursprungslands.
`CustomsCountryOfOriginISO2` Kann leer sein	string	ISO2-Code des Ursprungslands aus der Ländertabelle. NULL, wenn der Ländercode nicht gefunden wird.
`Weight` Kann leer sein	decimal	Gewicht des Artikels.
`Heigth` Kann leer sein	decimal	Höhe des Artikels. Der Spaltenname ist im Quellcode falsch geschrieben.
`Width` Kann leer sein	decimal	Breite des Artikels.
`Length` Kann leer sein	decimal	Länge des Artikels.
`CustomsTariffText` Kann leer sein	string	Warenbeschreibung für Zollzwecke.
`CustomsPreviousProcess` Kann leer sein	string	Vorangegangenes Zollverfahren des Artikels.
`ResultCode`	varchar(3) string	Immer `200`.
`ResultMessage`	varchar(2) string	Immer `OK`.

Beispielantwort

<SqlRowSet1>
  <row>
    <ItemKey>4711</ItemKey>
    <CustomsTariffNumber>85176200</CustomsTariffNumber>
    <CustomsCountryOfOrigin>CN</CustomsCountryOfOrigin>
    <CustomsCountryOfOriginISO2>CN</CustomsCountryOfOriginISO2>
    <Weight>0.350</Weight>
    <Heigth>5.00</Heigth>
    <Width>15.00</Width>
    <Length>20.00</Length>
    <CustomsTariffText>Network router</CustomsTariffText>
    <CustomsPreviousProcess>00</CustomsPreviousProcess>
    <ResultCode>200</ResultCode>
    <ResultMessage>OK</ResultMessage>
  </row>
</SqlRowSet1>

Fehlermeldungen

Status	Meldung	Ursache
501	One of parameters must be supplied	Keiner der Parameter `ItemKey`, `ItemNrInt` und `EanUpc` wurde übergeben. Mindestens eine Artikelkennung übergeben.

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:pixiGetItemCustomsInfo>
      <!-- <ItemKey>4711</ItemKey> -->
      <!-- <ItemNrInt>ART-10023</ItemNrInt> -->
      <!-- <EanUpc>4006381333931</EanUpc> -->
    </ns1:pixiGetItemCustomsInfo>
  </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:pixiGetItemCustomsInfo>
      <!-- <ItemKey>4711</ItemKey> -->
      <!-- <ItemNrInt>ART-10023</ItemNrInt> -->
      <!-- <EanUpc>4006381333931</EanUpc> -->
    </ns1:pixiGetItemCustomsInfo>
  </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 = [
    // 'ItemKey' => '4711',
    // 'ItemNrInt' => 'ART-10023',
    // 'EanUpc' => '4006381333931',
];

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

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

Verwendete Tabellen

items · Lesen Countries · Lesen

SQL-Objekt:: dbo.pipiGetItemCustomsInfo