complexType "ns:ShipPackageDetailsType"

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

complexType "ns:ShipPackageDetailsType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 8 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 8 elements, elem. wildcard
Used:	at 1 location

Component Diagram

XML Representation Summary

<...>

Content:

ns:MeasurementUnit?, ns:PackageDepth?, ns:PackageLength?, ns:PackageWidth?, ns:ShippingIrregular?, ns:ShippingPackage?, ns:WeightMajor?, ns:WeightMinor?, {any}*

</...>

All Direct / Indirect Based Elements (1):

ns:ShippingPackageDetails (defined in ns:ItemType complexType)

Known Usage Locations

As direct type of elements (1):

ns:ShippingPackageDetails (defined in ns:ItemType complexType)

Annotation

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.

XML Source (w/o annotations (9); see within schema source)

<xs:complexType name="ShipPackageDetailsType">

<xs:sequence>

<xs:element minOccurs="0" name="MeasurementUnit" type="ns:MeasurementSystemCodeType"/>

<xs:element minOccurs="0" name="PackageDepth" type="ns:MeasureType"/>

<xs:element minOccurs="0" name="PackageLength" type="ns:MeasureType"/>

<xs:element minOccurs="0" name="PackageWidth" type="ns:MeasureType"/>

<xs:element minOccurs="0" name="ShippingIrregular" type="xs:boolean"/>

<xs:element minOccurs="0" name="ShippingPackage" type="ns:ShippingPackageCodeType"/>

<xs:element minOccurs="0" name="WeightMajor" type="ns:MeasureType"/>

<xs:element minOccurs="0" name="WeightMinor" type="ns:MeasureType"/>

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

</xs:sequence>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 9/9)

ns:MeasurementUnit

Type:

ns:MeasurementSystemCodeType, simple content

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>

XML Representation Summary

<ns:MeasurementUnit>

Content:

{ enumeration of xs:token }

</ns:MeasurementUnit>

Simple Content

Enumeration:

"English"	-	This enumeration value indicates that the English system of measurement is being used. Also known as the Imperial System of Measurement. Weights in this system are expressed as pounds and ounces, and package dimensions are expressed as feet or inches.
"Metric"	-	This enumeration value indicates that the English system of measurement is being used. Weights in this system are expressed as kilograms and grams, and package dimensions are expressed as meters or centimeters.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="MeasurementUnit" type="ns:MeasurementSystemCodeType"/>

ns:PackageDepth

Type:

ns:MeasureType, simple content

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.

Component Diagram

XML Representation Summary

<ns:PackageDepth

measurementSystem	=	("English" \| "Metric")
unit	=	xs:token

Content:

{ xs:decimal }

</ns:PackageDepth>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PackageDepth" type="ns:MeasureType"/>

ns:PackageLength

Type:

ns:MeasureType, simple content

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

Component Diagram

XML Representation Summary

<ns:PackageLength

measurementSystem	=	("English" \| "Metric")
unit	=	xs:token

Content:

{ xs:decimal }

</ns:PackageLength>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PackageLength" type="ns:MeasureType"/>

ns:PackageWidth

Type:

ns:MeasureType, simple content

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

Component Diagram

XML Representation Summary

<ns:PackageWidth

measurementSystem	=	("English" \| "Metric")
unit	=	xs:token

Content:

{ xs:decimal }

</ns:PackageWidth>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PackageWidth" type="ns:MeasureType"/>

ns:ShippingIrregular

Type:

xs:boolean, predefined, simple content

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.

XML Representation Summary

<ns:ShippingIrregular>

Content:

{ xs:boolean }

</ns:ShippingIrregular>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ShippingIrregular" type="xs:boolean"/>

ns:ShippingPackage

Type:

ns:ShippingPackageCodeType, simple content

The nature of the package used to ship the item(s). Required for calculated shipping only.

XML Representation Summary

<ns:ShippingPackage>

Content:

{ enumeration of xs:token }

</ns:ShippingPackage>

Simple Content

Enumeration:

see details at ns:ShippingPackageCodeType

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ShippingPackage" type="ns:ShippingPackageCodeType"/>

ns:WeightMajor

Type:

ns:MeasureType, simple content

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 5 pounds and 1.8 ounces, the 1.8 ounces should be rounded up to an even 2 ounces. The same is for kilograms. If the package is 2.267 kilgram, you would round up the grams. Below shows you how to represent a package weight of 5 lbs 2 oz and and 2 kg 3 gr:


<WeightMajor unit="lbs">5</WeightMajor>

<WeightMinor unit="oz">2</WeightMinor>

<WeightMajor unit="kg">2</WeightMajor>

<WeightMinor unit="gr">3</WeightMinor>

If a package weighed 14 oz or 324 gr, below is how you would represent this weight:


<WeightMajor unit="lbs">0</WeightMajor>

<WeightMinor unit="oz">14</WeightMinor>

<WeightMajor unit="kg">0</WeightMajor>

<WeightMinor unit="gr">324</WeightMinor>

If a package weighed exactly 2 lbs or 105 kg, below is how you would represent this weight:


<WeightMajor unit="lbs">2</WeightMajor>

<WeightMinor unit="oz">0</WeightMinor>

<WeightMajor unit="kg">105</WeightMajor>

<WeightMinor unit="gr">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.

Component Diagram

XML Representation Summary

<ns:WeightMajor

measurementSystem	=	("English" \| "Metric")
unit	=	xs:token

Content:

{ xs:decimal }

</ns:WeightMajor>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="WeightMajor" type="ns:MeasureType"/>

ns:WeightMinor

Type:

ns:MeasureType, simple content

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 5 pounds and 1.8 ounces, the 1.8 ounces should be rounded up to an even 2 ounces. The same is for kilograms. If the package is 2.267 kilgram, you would round up the grams. Below shows you how to represent a package weight of 5 lbs 2 oz and and 2 kg 3 gr:


<WeightMajor unit="lbs">5</WeightMajor>

<WeightMinor unit="oz">2</WeightMinor>

<WeightMajor unit="kg">2</WeightMajor>

<WeightMinor unit="gr">3</WeightMinor>

If a package weighed 14 oz or 324 gr, below is how you would represent this weight:


<WeightMajor unit="lbs">0</WeightMajor>

<WeightMinor unit="oz">14</WeightMinor>

<WeightMajor unit="kg">0</WeightMajor>

<WeightMinor unit="gr">324</WeightMinor>

If a package weighed exactly 2 lbs or 105 kg, below is how you would represent this weight:


<WeightMajor unit="lbs">2</WeightMajor>

<WeightMinor unit="oz">0</WeightMinor>

<WeightMajor unit="kg">105</WeightMajor>

<WeightMinor unit="gr">0</WeightMinor>

Component Diagram

XML Representation Summary

<ns:WeightMinor

measurementSystem	=	("English" \| "Metric")
unit	=	xs:token

Content:

{ xs:decimal }

</ns:WeightMinor>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="WeightMinor" type="ns:MeasureType"/>

{any element from any namespace}

XML Source (see within schema source)

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.