Shipping Lesen

pixiGetShippingVendors

Liefert die in Pixi angelegten Versanddienstleister, optional gefiltert nach Schlüssel, Name, Code oder Tracking-Kennzeichen, samt Typ des verbundenen Kanals.

Liest die Versanddienstleister aus der Tabelle ShipVendor. Zu jedem Versanddienstleister wird zusätzlich der Name des Kanaltyps des verbundenen Kanals geliefert, sofern vorhanden.

Filterung

Leere Werte gelten als „nicht gesetzt“. Das ist 0 bei ShipVendorKey und ein Leerstring bei den Textparametern.
Ist kein Parameter gesetzt, werden alle Versanddienstleister geliefert.
Sind ein oder mehrere Parameter gesetzt, wird ein Versanddienstleister geliefert, wenn mindestens einer der gesetzten Filter exakt passt. Die Filter sind mit ODER verknüpft, nicht mit UND.
- ShipVendorKey muss dem angegebenen Schlüssel entsprechen.
- ShipVendorName muss dem angegebenen Namen entsprechen.
- ShipVendorCode muss dem angegebenen Code entsprechen.
- Tracking muss dem angegebenen Kennzeichen entsprechen.

Kanaltyp

Die Prozedur verknüpft ConnectedChannelId des Versanddienstleisters mit der Kanaltabelle und anschließend mit der Kanaltyptabelle. ChannelType ist leer (NULL) bei Versanddienstleistern ohne verbundenen Kanal.

Eine Sortierung ist nicht festgelegt.

Hinweise

Da die Filter mit ODER verknüpft sind, kann das Ergebnis größer werden, wenn mehrere Filter gesetzt sind. Beispiel: ShipVendorCode = UPS und Tracking = Y liefert jeden UPS-Versanddienstleister sowie jeden Versanddienstleister mit aktiviertem Tracking. Zum Eingrenzen nur einen Filter setzen und clientseitig weiter filtern.
Die Vergleiche sind exakt. Platzhalter werden nicht unterstützt. Die Groß-/Kleinschreibung hängt von der Datenbank-Collation ab.
Der Code schränkt die Werte von Tracking nicht ein. Üblich ist ein einstelliges Kennzeichen wie Y/N, die Prozedur erzwingt das jedoch nicht.
Alle Tabellen werden mit NOLOCK gelesen, daher können nicht festgeschriebene Daten geliefert werden.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`ShipVendorKey`	int	0	Schlüssel des Versanddienstleisters. `0` bedeutet nicht gesetzt. Beispiel: `3`
`ShipVendorName`	varchar(50) string	–	Exakter Name des Versanddienstleisters. Leerstring bedeutet nicht gesetzt. Beispiel: `UPS Standard`
`ShipVendorCode`	varchar(3) string	–	Exakter Code des Versanddienstleisters. Leerstring bedeutet nicht gesetzt. Beispiel: `UPS`
`Tracking`	varchar(1) string	–	Exakter Wert des Tracking-Kennzeichens des Versanddienstleisters. Leerstring bedeutet nicht gesetzt. Beispiel: `Y`

Antwort

Result-Set 1 · Immer

Eine Zeile je passendem Versanddienstleister.

Spalte	Typ	Beschreibung
`ShipVendorKey`	int	Schlüssel des Versanddienstleisters.
`ShipVendorName` Kann leer sein	varchar(50) string	Name des Versanddienstleisters.
`ShipVendorCode` Kann leer sein	varchar(3) string	Code des Versanddienstleisters.
`Tracking` Kann leer sein	varchar(1) string	Tracking-Kennzeichen des Versanddienstleisters.
`ChannelType` Kann leer sein	string	Name des Kanaltyps des verbundenen Kanals. NULL, wenn kein Kanal verbunden ist.

Beispielantwort

<SqlRowSet1>
  <row>
    <ShipVendorKey>3</ShipVendorKey>
    <ShipVendorName>UPS Standard</ShipVendorName>
    <ShipVendorCode>UPS</ShipVendorCode>
    <Tracking>Y</Tracking>
  </row>
  <row>
    <ShipVendorKey>5</ShipVendorKey>
    <ShipVendorName>DHL Paket</ShipVendorName>
    <ShipVendorCode>DHL</ShipVendorCode>
    <Tracking>Y</Tracking>
    <ChannelType>Shopware</ChannelType>
  </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:pixiGetShippingVendors>
      <!-- <ShipVendorKey>3</ShipVendorKey> -->
      <!-- <ShipVendorName>UPS Standard</ShipVendorName> -->
      <!-- <ShipVendorCode>UPS</ShipVendorCode> -->
      <!-- <Tracking>Y</Tracking> -->
    </ns1:pixiGetShippingVendors>
  </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:pixiGetShippingVendors>
      <!-- <ShipVendorKey>3</ShipVendorKey> -->
      <!-- <ShipVendorName>UPS Standard</ShipVendorName> -->
      <!-- <ShipVendorCode>UPS</ShipVendorCode> -->
      <!-- <Tracking>Y</Tracking> -->
    </ns1:pixiGetShippingVendors>
  </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 = [
    // 'ShipVendorKey' => '3',
    // 'ShipVendorName' => 'UPS Standard',
    // 'ShipVendorCode' => 'UPS',
    // 'Tracking' => 'Y',
];

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

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

Verwendete Tabellen

ShipVendor · Lesen C_Channels · Lesen C_ChannelTypes · Lesen

SQL-Objekt:: dbo.pipiGetShippingVendors