Description

Returns the package dimensions configured in pixi, including their IDs, codes, names, sizes, maximum weights, and units of measurement. Use this call to find a valid PackageDimensionId before calling pixiCreateInvoicePackage.

By default only active package dimensions are returned. Set ReturnAll to 1 to include disabled ones as well; the IsDisabled field then tells them apart. The call is read-only and does not change any data. If no package dimensions match, an empty result set is returned instead of an error.

Request Parameters

#	Name	Type	Required	Example	Description
1	ReturnAll	integer	0	1	Set to 1 to return disabled package dimensions as well. Set to 0 to return only active package dimensions. Default: 0.

Request body

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
   <soapenv:Header/>
   <soapenv:Body>
      <dem:pixiGetPackageDimensions>
         <dem:ReturnAll>1</dem:ReturnAll>
      </dem:pixiGetPackageDimensions>
   </soapenv:Body>
</soapenv:Envelope>

Response

Body 1: Package dimensions

#	Name	Type	Description
1	Id	integer	Package dimension ID. Use this value as PackageDimensionId in pixiCreateInvoicePackage.
2	Code	string	Package dimension code.
3	Name	string	Package dimension name.
4	Length	decimal	Package length, in the unit given in SizeBaseUnitMeasurementType.
5	Height	decimal	Package height, in the unit given in SizeBaseUnitMeasurementType.
6	Width	decimal	Package width, in the unit given in SizeBaseUnitMeasurementType.
7	SizeBaseUnitMeasurementType	string	Name of the unit of measurement for Length, Height, and Width.
8	MaxWeight	decimal	Maximum allowed package weight, in the unit given in WeightBaseUnitMeasurementType.
9	WeightBaseUnitMeasurementType	string	Name of the unit of measurement for MaxWeight.
10	IsPredefined	integer	1 = Amazon-predefined package dimension. 0 = user-defined package dimension.
11	IsDisabled	integer	1 = the package dimension is disabled and hidden from the ship-out drop-down in pixi. Can only be 1 when ReturnAll = 1.

Additional Notes

Sorting:
- Results are sorted by the position configured in pixi, then by Name.

Disabled package dimensions:
- Disabled package dimensions are excluded unless ReturnAll is set to 1.
- pixiCreateInvoicePackage does not reject a disabled PackageDimensionId. To stay consistent with pixi, use only package dimensions where IsDisabled = 0.

Units of measurement:
- Length, Height, and Width share one unit (SizeBaseUnitMeasurementType).
- MaxWeight has its own unit (WeightBaseUnitMeasurementType).
- Units are returned as names, not IDs.