pixiGetPackageDimensions · Pixi-API-Dokumentation

Liefert die in Pixi hinterlegten Stammdaten der Paketmaße.

Jede Zeile enthält Code, Name, Länge, Höhe und Breite eines Pakettyps sowie den Namen der Größeneinheit.
Außerdem werden das Maximalgewicht mit dem Namen der Gewichtseinheit und die Kennzeichen IsPredefined und IsDisabled geliefert.
Standardmäßig (ReturnAll = 0) werden nur Paketmaße mit IsDisabled = 0 geliefert.
Mit ReturnAll = 1 werden auch deaktivierte Paketmaße geliefert.
Die Sortierung erfolgt aufsteigend nach der hinterlegten Position (Position), danach aufsteigend nach Name.

Die Namen der Einheiten werden über Inner Joins auf die Tabelle der Maßeinheiten ermittelt. Paketmaße, deren Größen- oder Gewichtseinheit nicht aufgelöst werden kann, werden nicht geliefert.

Hinweise

Alle Tabellen werden mit NOLOCK gelesen, daher können nicht festgeschriebene Änderungen sichtbar sein. Die zur Sortierung verwendete Spalte Position ist nicht Teil des Ergebnisses.

Verwendete Tabellen

PackageDimension · Lesen BaseUnitMeasurementType · Lesen

Parameter Typ Standardwert Beschreibung

Parameter	Typ	Standardwert	Beschreibung
`ReturnAll`	bit boolean	0	Steuert, ob deaktivierte Paketmaße mitgeliefert werden. Erlaubte Werte `0` – Nur aktive Paketmaße (`IsDisabled` = 0). `1` – Alle Paketmaße einschließlich der deaktivierten. Beispiel: `0`

ReturnAll

bit
boolean

0

Steuert, ob deaktivierte Paketmaße mitgeliefert werden.

Erlaubte Werte

0 – Nur aktive Paketmaße (`IsDisabled` = 0).
1 – Alle Paketmaße einschließlich der deaktivierten.

Beispiel: 0

Result-Set 1 · Immer

Eine Zeile pro Paketmaß, sortiert nach Position und Name.

Spalte	Typ	Beschreibung
`Id`	int	Interne ID des Paketmaßes.
`Code` Kann leer sein	string	Code des Paketmaßes.
`Name` Kann leer sein	string	Name des Paketmaßes.
`Length` Kann leer sein	decimal	Länge des Pakets in der Größeneinheit.
`Height` Kann leer sein	decimal	Höhe des Pakets in der Größeneinheit.
`Width` Kann leer sein	decimal	Breite des Pakets in der Größeneinheit.
`SizeBaseUnitMeasurementType` Kann leer sein	string	Name der Einheit für Länge, Höhe und Breite.
`MaxWeight` Kann leer sein	decimal	Maximalgewicht des Pakets in der Gewichtseinheit.
`WeightBaseUnitMeasurementType` Kann leer sein	string	Name der Einheit für das Maximalgewicht.
`IsPredefined` Kann leer sein	boolean	Kennzeichen, ob das Paketmaß vordefiniert ist.
`IsDisabled` Kann leer sein	boolean	Kennzeichen, ob das Paketmaß deaktiviert ist.

Beispielantwort

<SqlRowSet1>
  <row>
    <Id>1</Id>
    <Code>S</Code>
    <Name>Small parcel</Name>
    <Length>30.00</Length>
    <Height>10.00</Height>
    <Width>20.00</Width>
    <SizeBaseUnitMeasurementType>cm</SizeBaseUnitMeasurementType>
    <MaxWeight>2.00</MaxWeight>
    <WeightBaseUnitMeasurementType>kg</WeightBaseUnitMeasurementType>
    <IsPredefined>true</IsPredefined>
    <IsDisabled>false</IsDisabled>
  </row>
  <row>
    <Id>2</Id>
    <Code>M</Code>
    <Name>Medium parcel</Name>
    <Length>60.00</Length>
    <Height>30.00</Height>
    <Width>40.00</Width>
    <SizeBaseUnitMeasurementType>cm</SizeBaseUnitMeasurementType>
    <MaxWeight>10.00</MaxWeight>
    <WeightBaseUnitMeasurementType>kg</WeightBaseUnitMeasurementType>
    <IsPredefined>false</IsPredefined>
    <IsDisabled>false</IsDisabled>
  </row>
</SqlRowSet1>

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:pixiGetPackageDimensions>
      <!-- <ReturnAll>0</ReturnAll> -->
    </ns1:pixiGetPackageDimensions>
  </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:pixiGetPackageDimensions>
      <!-- <ReturnAll>0</ReturnAll> -->
    </ns1:pixiGetPackageDimensions>
  </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 = [
    // 'ReturnAll' => '0',
];

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

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