Package dimensions and weight are required when using:
- Calculated shipping
- Shipping options based on a rate table specifying weight-based surcharges
Note: When updating an item that has a flat-rate shipping type specified, you must include all ShippingPackageDetails fields from the current listing in the revise call, even if their values are not changing. If you do not do this, some/all of the fields under the ShippingPackageDetails container may be removed from the listing. To find out the values included in the current listing, call GetItem and look through the ShippingPackageDetails container in the response.
Note: Package weight and dimensions are only supported for the following marketplaces: AU, CA, DE, IT, UK, US, and Motors. If this information is provided on other marketplaces, it will be ignored.
Measurement system and units
Although their use is optional, when providing package dimensions and weight, it is strongly recommended that both the measurement system and measurement units be included with each value.
-
Measurement system is typically dependent upon the marketplace and is specified using the MeasurementSystemCodeType enumeration value.
Supported values are:
English
for the US marketplace.Metric
for all other marketplaces.
-
Measurement unit is defined using the Item.ShippingPackageDetails.MeasurementUnit field and must agree with the measurement system enum value specified.
Note: Currently, the only supported values for length-based measurements are whole inches [English] and whole centimeters [Metric].
Important! If no MeasurementSystemCodeType enumeration value or Item.ShippingDetails.CalculatedShippingRate.MeasurementUnit is specified for a listing, the default values for the marketplace will be used.
Calculated shipping
When using calculated shipping, the associated cost is typically based on both:
-
Package dimensions
The dimensions of a package are specified using the following fields:
-
Item.ShippingPackageDetails.PackageDepth
This value should be specified as a whole number (i.e., no decimal places.) If necessary, round up to the nearest whole number.
-
Item.ShippingPackageDetails.PackageLength
This value should be specified as a whole number (i.e., no decimal places.) If necessary, round up to the nearest whole number.
-
Item.ShippingPackageDetails.PackageWidth
This value should be specified as a whole number (i.e., no decimal places.) If necessary, round up to the nearest whole number.
For example:
<PackageDepth unit="in" measurementSystem="English">3</PackageDepth> <PackageLength unit="in" measurementSystem="English">8</PackageLength> <PackageWidth unit="in" measurementSystem="English">8</PackageWidth>
-
-
Package weight
The shipping weight of a package is specified using the following fields:
-
Item.ShippingPackageDetails.WeightMajor
This value should be specified as a whole number (i.e., no decimal places.) If necessary, round up to the nearest whole number.
-
Item.ShippingPackageDetails.WeightMinor
This value should be specified as a whole number (i.e., no decimal places.) If necessary, round up to the nearest whole number.
For example:
<WeightMajor unit="lbs" measurementSystem="English">5</WeightMajor> <WeightMinor unit="oz" measurementSystem="English">2</WeightMinor>
-
Flat rate shipping
If a shipping service requires package dimensions in order to use flat rate shipping, ShippingServiceDetails.DimensionsRequired = true
will be returned, and selecting that service for a listing requires that the following information be included when creating the listing:
-
Item.ShippingPackageDetails.PackageDepth
This value should be specified as a whole number (i.e., no decimal places.) If necessary, round up to the nearest whole number.
-
Item.ShippingPackageDetails.PackageLength
This value should be specified as a whole number (i.e., no decimal places.) If necessary, round up to the nearest whole number.
-
Item.ShippingPackageDetails.PackageWidth
This value should be specified as a whole number (i.e., no decimal places.) If necessary, round up to the nearest whole number.
Similarly, if a shipping service requires the weight of a package in order to use flat rate shipping, ShippingServiceDetails.WeightRequired = true
will be returned, and selecting that service for a listing requires that the following information be included when creating the listing:
-
Item.ShippingPackageDetails.WeightMajor
This value should be specified as a whole number (i.e., no decimal places.) If necessary, round up to the nearest whole number.
-
Item.ShippingPackageDetails.WeightMinor
This value should be specified as a whole number (i.e., no decimal places.) If necessary, round up to the nearest whole number.
Note: It is a best practice to always provide dimensions for a package, even if a particular combination of package type and selected shipping service does not require dimensions. This enables eBay and its shipping affiliates to be most accurate in its shipping cost calculations.
Examples
Listed below are some typical examples of how and when package dimensions/weight may be required.
Example 1
Consider the following:
- DimensionsSupported is
true
for theLargePackage
package type for a particular marketplace. - For shipping services named S1 and S2, ShippingServicePackageDetails.DimensionsRequired is
true
forLargePackage
.
In this situation the seller must provide dimensions.
Example 2
Consider the following:
- DimensionsSupported is
true
for thePackage
package type for a particular marketplace. - For shipping service S1, ShippingServicePackageDetails.DimensionsRequired is
false
forPackage
. - For shipping service S2, ShippingServicePackageDetails.DimensionsRequired is
true
forPackage
.
In this situation, if the seller only offers shipping service S1, the seller can offer the Package
option for service S1 and is not required to provide dimensions. If the seller chooses to provide dimensions, eBay will store the dimensions and use them for shipping cost calculations if the buyer selects service S1.
In order for the seller to offer shipping service S2 for the Package
package type, the seller must provide package dimensions.
Therefore, if the seller offers both services S1 and S2 and selects the Package
option, the seller must provide package dimensions to satisfy the requirements for service S2.
Example 3
Consider the following:
- DimensionsSupported is
false
for the package typeLetter
. - ShippingServicePackageDetails.DimensionsRequired is
false
for theLetter
package type for all shipping services that the seller offers.
In this situation, dimensions are not required and it would be best for the seller not to provide dimensions.
Example 4
Consider the following:
- ShippingServicePackageDetails.WeightRequired is
true
for one of the shipping services offered by the seller - ShippingServicePackageDetails.WeightRequired is
false
for all other shipping services offered by the seller.
In this situation the seller must provide weight details for the item to satisfy the single service's requirement for weight details.