pixiGetPackageDimensions · Pixi API documentation

Returns the package dimension master data stored in Pixi.

Each row contains the code, name, length, height and width of a package type, plus the name of the size unit.
It also returns the maximum weight with the name of the weight unit and the flags IsPredefined and IsDisabled.
By default (ReturnAll = 0) only package dimensions with IsDisabled = 0 are returned.
With ReturnAll = 1, disabled package dimensions are included as well.
Rows are sorted by the configured position (Position) ascending, then by Name ascending.

The unit names are resolved through inner joins on the unit-of-measurement table. A package dimension whose size unit or weight unit cannot be resolved is not returned.

Notes

All tables are read with NOLOCK, so uncommitted changes may be visible. The Position column used for sorting is not part of the result.

Tables used

PackageDimension · Read BaseUnitMeasurementType · Read

Parameter Type Default Description

Parameter	Type	Default	Description
`ReturnAll`	bit boolean	0	Controls whether disabled package dimensions are included. Allowed values `0` – Only enabled package dimensions (`IsDisabled` = 0). `1` – All package dimensions, including disabled ones. Example: `0`

ReturnAll

bit
boolean

0

Controls whether disabled package dimensions are included.

Allowed values

0 – Only enabled package dimensions (`IsDisabled` = 0).
1 – All package dimensions, including disabled ones.

Example: 0

Result set 1 · Always

One row per package dimension, ordered by position and name.

Column	Type	Description
`Id`	int	Internal ID of the package dimension.
`Code` Nullable	string	Code of the package dimension.
`Name` Nullable	string	Name of the package dimension.
`Length` Nullable	decimal	Length of the package in the size unit.
`Height` Nullable	decimal	Height of the package in the size unit.
`Width` Nullable	decimal	Width of the package in the size unit.
`SizeBaseUnitMeasurementType` Nullable	string	Name of the unit used for length, height and width.
`MaxWeight` Nullable	decimal	Maximum weight of the package in the weight unit.
`WeightBaseUnitMeasurementType` Nullable	string	Name of the unit used for the maximum weight.
`IsPredefined` Nullable	boolean	Indicates whether the package dimension is predefined.
`IsDisabled` Nullable	boolean	Indicates whether the package dimension is disabled.

Response example

<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);