eBay Trading APIVersion 1119

ShipPackageDetailsType

Details pertinent to one or more items for which calculated shipping (or flat rate shipping using shipping rate tables with weight surcharges) has been offered by the seller, such as package dimension and weight and packaging/handling costs.

Also returned with the data for an item's transaction.

Note: The ShippingPackageDetails container should now be used instead of the CalculatedShippingRate container to specify values for the MeasurementUnit, PackageDepth, PackageWidth, PackageLength, ShippingIrregular, ShippingPackage, WeightMajor, and/or WeightMinor fields. The CalculatedShippingRate container should only be used to specify values for the InternationalPackagingHandlingCosts, OriginatingPostalCode, and/or PackagingHandlingCosts fields.

Type that uses ShipPackageDetailsType:

Calls that use ShipPackageDetailsType:

Fields



MeasurementUnit ( MeasurementSystemCodeType ) [0..1]
Specifies the unit type of the weight and dimensions of a shipping package. If MeasurementUnit is used, it overrides the system specified by measurementSystem. If MeasurementUnit and measurementSystem are not specified, the following defaults will be used:

English: US
Metric: CA, CAFR, AU

CA and CAFR supports both English and Metric, while other sites only support the site's default.

Use MeasurementUnit with weight and package dimensions. For example, to represent a 5 lbs 2 oz package:

<MeasurementUnit>English</MeasurementUnit>
<WeightMajor>5</WeightMajor>
<WeightMinor>2</WeightMinor>
See the Field Index to learn which calls use MeasurementUnit.

PackageDepth ( MeasureType (decimal) ) [0..1]
Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)

Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs.
See the Field Index to learn which calls use PackageDepth.

PackageLength ( MeasureType (decimal) ) [0..1]
Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)
See the Field Index to learn which calls use PackageLength.

PackageWidth ( MeasureType (decimal) ) [0..1]
Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.)
See the Field Index to learn which calls use PackageWidth.

ShippingIrregular ( boolean ) [0..1]
Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only.
See the Field Index to learn which calls use ShippingIrregular.

ShippingPackage ( ShippingPackageCodeType ) [0..1]
The nature of the package used to ship the item(s). Required for calculated shipping only.
See the Field Index to learn which calls use ShippingPackage.

WeightMajor ( MeasureType (decimal) ) [0..1]
WeightMajor and WeightMinor are used to specify the weight of a shipping package. WeightMajor is used to specify the weight of the package in pounds (in US) or kilograms (all countries that use metric system). Although MeasureType is of decimal type, decimal values should not be used in WeightMajor and WeightMinor. If a shipping package was weighed at 5 pounds and 1.8 ounces, the 1.8 ounces should just be rounded up to an even 2 ounces. So, below is how you would represent a package weight of 5 lbs 2 oz:

<WeightMajor unit="lbs">5</WeightMajor>
<WeightMinor unit="oz">2</WeightMinor>


If a package weighed 14 ounces, below is how you would represent this weight:

<WeightMajor unit="lbs">0</WeightMajor>
<WeightMinor unit="oz">14</WeightMinor>


If a package weighed exactly two pounds, below is how you would represent this weight:

<WeightMajor unit="lbs">2</WeightMajor>
<WeightMinor unit="oz">0</WeightMinor>


In all cases, both the WeightMajor and WeightMinor should be specified in an Add/Revise/Relist/Verify call, even if either's value is '0'.

The WeightMajor and WeightMinor are applicable for calculated shipping or for flat-rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges.
See the Field Index to learn which calls use WeightMajor.

WeightMinor ( MeasureType (decimal) ) [0..1]
WeightMajor and WeightMinor are used to specify the weight of a shipping package. WeightMinor is used to specify the weight of the package in ounces (in US) or grams (all countries that use metric system). Although MeasureType is of decimal type, decimal values should not be used in WeightMajor and WeightMinor. If a shipping package was weighed at 5 pounds and 1.8 ounces, the 1.8 ounces should just be rounded up to an even 2 ounces. So, below is how you would represent a package weight of 5 lbs 2 oz:

<WeightMajor unit="lbs">5</WeightMajor>
<WeightMinor unit="oz">2</WeightMinor>


If a package weighed 14 ounces, below is how you would represent this weight:

<WeightMajor unit="lbs">0</WeightMajor>
<WeightMinor unit="oz">14</WeightMinor>


If a package weighed exactly two pounds, below is how you would represent this weight:

<WeightMajor unit="lbs">2</WeightMajor>
<WeightMinor unit="oz">0</WeightMinor>


In all cases, both the WeightMajor and WeightMinor should be specified in an Add/Revise/Relist/Verify call, even if either's value is '0'.

The WeightMajor and WeightMinor are applicable for calculated shipping or for flat-rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges.
See the Field Index to learn which calls use WeightMinor.