Inherits from NSObject
Conforms to PicoBindable
Declared in Trading_ShipPackageDetailsType.h
Trading_ShipPackageDetailsType.m

Overview

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.

@ingroup EBayAPIInterface

Tasks

  •   measurementUnit

    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>

    property
  •   packageDepth

    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.

    property
  •   packageLength

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

    property
  •   packageWidth

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

    property
  •   shippingIrregular

    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.

    property
  •   shippingPackage

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

    property
  •   weightMajor

    WeightMajor and WeightMinor are used to specify the weight of a
    shipping package. Here is how you would represent a package
    weight of 5 lbs 2 oz: <WeightMajor unit=“lbs”>5</WeightMajor>
    <WeightMinor unit=“oz”>2</WeightMinor>
    See http://www.ups.com for the maximum weight allowed by UPS.
    Above this maximum, the shipping type becomes Freight, an option
    that can only be selected via the eBay Web site and not via API.
    The weight details are validated against the selected shipping service.



    For calculated shipping or for flat rate shipping if shipping rate tables are
    specified and the shipping rate table uses weight surcharges.
    Required on input when calculated shipping is used.

    property
  •   weightMinor

    See the definition of WeightMajor. For calculated shipping or for flat rate shipping
    if shipping rate tables are specified and the shipping rate table uses weight surcharges.
    (When used with the shipping rate tables with weight surcharge, any WeightMinor value greater
    than zero results in WeightMajor getting rounded up in the shipping cost calculation
    for example, 1 lb, 2 oz is rounded up to 2 lbs.)



    Required on input when calculated shipping is used.

    property
  •   any

    (public property)

    property

Properties

any

(public property)

@property (nonatomic, retain) NSMutableArray *any

Discussion

(public property)

entry type : PicoAnyElement, wrapper for primitive anyelement

Declared In

Trading_ShipPackageDetailsType.h

measurementUnit

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>

@property (nonatomic, retain) NSString *measurementUnit

Discussion

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>

type: string constant in Trading_MeasurementSystemCodeType.h

Declared In

Trading_ShipPackageDetailsType.h

packageDepth

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.

@property (nonatomic, retain) Trading_MeasureType *packageDepth

Discussion

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.

type : class Trading_MeasureType

Declared In

Trading_ShipPackageDetailsType.h

packageLength

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

@property (nonatomic, retain) Trading_MeasureType *packageLength

Discussion

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

type : class Trading_MeasureType

Declared In

Trading_ShipPackageDetailsType.h

packageWidth

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

@property (nonatomic, retain) Trading_MeasureType *packageWidth

Discussion

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

type : class Trading_MeasureType

Declared In

Trading_ShipPackageDetailsType.h

shippingIrregular

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.

@property (nonatomic, retain) NSNumber *shippingIrregular

Discussion

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.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ShipPackageDetailsType.h

shippingPackage

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

@property (nonatomic, retain) NSString *shippingPackage

Discussion

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

type: string constant in Trading_ShippingPackageCodeType.h

Declared In

Trading_ShipPackageDetailsType.h

weightMajor

WeightMajor and WeightMinor are used to specify the weight of a
shipping package. Here is how you would represent a package
weight of 5 lbs 2 oz: <WeightMajor unit=“lbs”>5</WeightMajor>
<WeightMinor unit=“oz”>2</WeightMinor>
See http://www.ups.com for the maximum weight allowed by UPS.
Above this maximum, the shipping type becomes Freight, an option
that can only be selected via the eBay Web site and not via API.
The weight details are validated against the selected shipping service.



For calculated shipping or for flat rate shipping if shipping rate tables are
specified and the shipping rate table uses weight surcharges.
Required on input when calculated shipping is used.

@property (nonatomic, retain) Trading_MeasureType *weightMajor

Discussion

WeightMajor and WeightMinor are used to specify the weight of a
shipping package. Here is how you would represent a package
weight of 5 lbs 2 oz: <WeightMajor unit=“lbs”>5</WeightMajor>
<WeightMinor unit=“oz”>2</WeightMinor>
See http://www.ups.com for the maximum weight allowed by UPS.
Above this maximum, the shipping type becomes Freight, an option
that can only be selected via the eBay Web site and not via API.
The weight details are validated against the selected shipping service.



For calculated shipping or for flat rate shipping if shipping rate tables are
specified and the shipping rate table uses weight surcharges.
Required on input when calculated shipping is used.

type : class Trading_MeasureType

Declared In

Trading_ShipPackageDetailsType.h

weightMinor

See the definition of WeightMajor. For calculated shipping or for flat rate shipping
if shipping rate tables are specified and the shipping rate table uses weight surcharges.
(When used with the shipping rate tables with weight surcharge, any WeightMinor value greater
than zero results in WeightMajor getting rounded up in the shipping cost calculation
for example, 1 lb, 2 oz is rounded up to 2 lbs.)



Required on input when calculated shipping is used.

@property (nonatomic, retain) Trading_MeasureType *weightMinor

Discussion

See the definition of WeightMajor. For calculated shipping or for flat rate shipping
if shipping rate tables are specified and the shipping rate table uses weight surcharges.
(When used with the shipping rate tables with weight surcharge, any WeightMinor value greater
than zero results in WeightMajor getting rounded up in the shipping cost calculation
for example, 1 lb, 2 oz is rounded up to 2 lbs.)



Required on input when calculated shipping is used.

type : class Trading_MeasureType

Declared In

Trading_ShipPackageDetailsType.h