Trading_CalculatedShippingRateType Class Reference
Inherits from | NSObject |
Conforms to | PicoBindable |
Declared in | Trading_CalculatedShippingRateType.h Trading_CalculatedShippingRateType.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
-
originatingPostalCode
Postal code for the location from which the package will be shipped.
property
Required for calculated shipping. Use Item.PostalCode to specify the
location of the item used for searches by location. -
measurementUnit
Specifies the unit type of the weight and dimensions of a
property
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> -
packageDepth
Depth of the package, in whole number of inches, needed to ship the item.
property
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. -
packageLength
Length of the package, in whole number of inches, needed to ship the item.
property
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.) -
packageWidth
Width of the package, in whole number of inches, needed to ship the item.
property
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.) -
packagingHandlingCosts
Fees a seller might assess for the shipping of the item (in addition to
property
whatever the shipping service might charge).
Any packaging/handling cost specified on input is added to each shipping
service on output.
If domestic and international calculated shipping is offered for an item and
if packaging/handling cost is specified only for domestic shipping, that cost
will be applied by eBay as the international packaging/handling cost. (To
specify a international packaging/handling cost, you must always specify a
domestic packaging/handling cost, even if it is 0.) When UPS is one of the
shipping services offered by the seller, package dimensions are required on
list/relist/revise.
For calculated shipping only. -
shippingIrregular
Whether a package is irregular and therefore cannot go
property
through the stamping machine at the shipping service office and
thus requires special or fragile handling. For calculated
shipping only. -
shippingPackage
The nature of the package used to ship the item(s).
property
This is required for calculated shipping only.
To get the applicable ShippingPackage values for your site, call
GeteBayDetails with DetailName set to ShippingPackageDetails,
and then look for the ShippingPackageDetails.ShippingPackage fields in the response. -
weightMajor
WeightMajor and WeightMinor are used to specify the weight of a
property
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. -
weightMinor
See the definition of WeightMajor. For calculated shipping or for flat rate shipping
property
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. -
internationalPackagingHandlingCosts
Fees a seller might assess for the shipping of the item (in addition to
property
whatever the shipping service might charge).
Any packaging/handling cost specified on input is added to each shipping
service on output.
If domestic and international calculated shipping is offered for an item and
if packaging/handling cost is specified only for domestic shipping, that cost
will be applied by eBay as the international packaging/handling cost. (To
specify a international packaging/handling cost, you must always specify a
domestic packaging/handling cost, even if it is 0.)
For international calculated shipping only. -
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_CalculatedShippingRateType.h
internationalPackagingHandlingCosts
Fees a seller might assess for the shipping of the item (in addition to
whatever the shipping service might charge).
Any packaging/handling cost specified on input is added to each shipping
service on output.
If domestic and international calculated shipping is offered for an item and
if packaging/handling cost is specified only for domestic shipping, that cost
will be applied by eBay as the international packaging/handling cost. (To
specify a international packaging/handling cost, you must always specify a
domestic packaging/handling cost, even if it is 0.)
For international calculated shipping only.
@property (nonatomic, retain) Trading_AmountType *internationalPackagingHandlingCosts
Discussion
Fees a seller might assess for the shipping of the item (in addition to
whatever the shipping service might charge).
Any packaging/handling cost specified on input is added to each shipping
service on output.
If domestic and international calculated shipping is offered for an item and
if packaging/handling cost is specified only for domestic shipping, that cost
will be applied by eBay as the international packaging/handling cost. (To
specify a international packaging/handling cost, you must always specify a
domestic packaging/handling cost, even if it is 0.)
For international calculated shipping only.
type : class Trading_AmountType
Declared In
Trading_CalculatedShippingRateType.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_CalculatedShippingRateType.h
originatingPostalCode
Postal code for the location from which the package will be shipped.
Required for calculated shipping. Use Item.PostalCode to specify the
location of the item used for searches by location.
@property (nonatomic, retain) NSString *originatingPostalCode
Discussion
Postal code for the location from which the package will be shipped.
Required for calculated shipping. Use Item.PostalCode to specify the
location of the item used for searches by location.
type : NSString, wrapper for primitive string
Declared In
Trading_CalculatedShippingRateType.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_CalculatedShippingRateType.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_CalculatedShippingRateType.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_CalculatedShippingRateType.h
packagingHandlingCosts
Fees a seller might assess for the shipping of the item (in addition to
whatever the shipping service might charge).
Any packaging/handling cost specified on input is added to each shipping
service on output.
If domestic and international calculated shipping is offered for an item and
if packaging/handling cost is specified only for domestic shipping, that cost
will be applied by eBay as the international packaging/handling cost. (To
specify a international packaging/handling cost, you must always specify a
domestic packaging/handling cost, even if it is 0.) When UPS is one of the
shipping services offered by the seller, package dimensions are required on
list/relist/revise.
For calculated shipping only.
@property (nonatomic, retain) Trading_AmountType *packagingHandlingCosts
Discussion
Fees a seller might assess for the shipping of the item (in addition to
whatever the shipping service might charge).
Any packaging/handling cost specified on input is added to each shipping
service on output.
If domestic and international calculated shipping is offered for an item and
if packaging/handling cost is specified only for domestic shipping, that cost
will be applied by eBay as the international packaging/handling cost. (To
specify a international packaging/handling cost, you must always specify a
domestic packaging/handling cost, even if it is 0.) When UPS is one of the
shipping services offered by the seller, package dimensions are required on
list/relist/revise.
For calculated shipping only.
type : class Trading_AmountType
Declared In
Trading_CalculatedShippingRateType.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_CalculatedShippingRateType.h
shippingPackage
The nature of the package used to ship the item(s).
This is required for calculated shipping only.
To get the applicable ShippingPackage values for your site, call
GeteBayDetails with DetailName set to ShippingPackageDetails,
and then look for the ShippingPackageDetails.ShippingPackage fields in the response.
@property (nonatomic, retain) NSString *shippingPackage
Discussion
The nature of the package used to ship the item(s).
This is required for calculated shipping only.
To get the applicable ShippingPackage values for your site, call
GeteBayDetails with DetailName set to ShippingPackageDetails,
and then look for the ShippingPackageDetails.ShippingPackage fields in the response.
type: string constant in Trading_ShippingPackageCodeType.h
Declared In
Trading_CalculatedShippingRateType.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_CalculatedShippingRateType.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_CalculatedShippingRateType.h