NAME
eBay::API::XML::DataType::CalculatedShippingRateType
DESCRIPTION
Details pertinent to one or more items for which calculated shipping 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.
SYNOPSIS
INHERITANCE
eBay::API::XML::DataType::CalculatedShippingRateType inherits from the eBay::API::XML::BaseDataType class
Subroutines:
setInternationalPackagingHandlingCosts()
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.
Calls: AddItem
RelistItem
ReviseItem
VerifyAddItem
RequiredInput: No# Argument: 'ns:AmountType'
getInternationalPackagingHandlingCosts()
Calls: GetBidderList
GetItemShipping
GetSellerList
Returned: Conditionally
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll# Returns: 'ns:AmountType'
setMeasurementUnit()
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: <br><br> English: Ubr Metric: CA, CAFR, AU <br><br> CA and CAFR supports both English and Metric, while other sites only support the site's default. <br><br> Use MeasurementUnit with weight and package dimensions. For example, to represent a 5 lbs 2 oz package: <br> <MeasurementUnit>English</MeasurementUnit> <br> <WeightMajor>5</WeightMajor> <br> <WeightMinor>2</WeightMinor>
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PackageDetails Title: Package Dimensions and Weight
Calls: AddItem
RelistItem
ReviseItem
VerifyAddItem
RequiredInput: Conditionally# Argument: 'ns:MeasurementSystemCodeType'
getMeasurementUnit()
# Returns: 'ns:MeasurementSystemCodeType'
setOriginatingPostalCode()
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.
Calls: AddItem
GetItemRecommendations
RelistItem
ReviseItem
VerifyAddItem
RequiredInput: Conditionally# Argument: 'xs:string'
getOriginatingPostalCode()
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetBidderList
GetItemShipping
Returned: Conditionally
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll# Returns: 'xs:string'
setPackageDepth()
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.) <br><br> 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.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PackageDetails Title: Package Dimensions and Weight
Calls: AddItem
GetItemRecommendations
RelistItem
ReviseItem
VerifyAddItem
RequiredInput: Conditionally# Argument: 'ns:MeasureType'
getPackageDepth()
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetBidderList
GetItemShipping
Returned: Conditionally
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll# Returns: 'ns:MeasureType'
setPackageLength()
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.)
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PackageDetails Title: Package Dimensions and Weight
Calls: AddItem
GetItemRecommendations
RelistItem
ReviseItem
VerifyAddItem
RequiredInput: Conditionally# Argument: 'ns:MeasureType'
getPackageLength()
Calls: GetBidderList
GetItemShipping
Returned: Conditionally
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll# Returns: 'ns:MeasureType'
setPackageWidth()
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.)
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PackageDetails Title: Package Dimensions and Weight
Calls: AddItem
GetItemRecommendations
RelistItem
ReviseItem
VerifyAddItem
RequiredInput: Conditionally# Argument: 'ns:MeasureType'
getPackageWidth()
Calls: GetBidderList
GetItemShipping
Returned: Conditionally
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription,
ItemReturnAttributes, ReturnAll
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll# Returns: 'ns:MeasureType'
setPackagingHandlingCosts()
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.
Calls: AddItem
GetItemRecommendations
RelistItem
ReviseItem
VerifyAddItem
RequiredInput: No# Argument: 'ns:AmountType'
getPackagingHandlingCosts()
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetBidderList
GetItemShipping
Returned: Conditionally
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll# Returns: 'ns:AmountType'
setShippingIrregular()
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.
Calls: AddItem
GetItemRecommendations
RelistItem
ReviseItem
VerifyAddItem
RequiredInput: No# Argument: 'xs:boolean'
isShippingIrregular()
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
Calls: GetBidderList
GetItemShipping
Returned: Conditionally
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll# Returns: 'xs:boolean'
setShippingPackage()
The nature of the package used to ship the item(s). Required for calculated shipping only.
Calls: AddItem
GetItemRecommendations
RelistItem
ReviseItem
VerifyAddItem
RequiredInput: Conditionally# Argument: 'ns:ShippingPackageCodeType'
getShippingPackage()
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
Calls: GetBidderList
GetItemShipping
Returned: Conditionally
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll# Returns: 'ns:ShippingPackageCodeType'
setWeightMajor()
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 only. Required on input when calculated shipping is used.
Calls: AddItem
GetItemRecommendations
RelistItem
ReviseItem
VerifyAddItem
RequiredInput: Conditionally# Argument: 'ns:MeasureType'
getWeightMajor()
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetBidderList
GetItemShipping
Returned: Conditionally
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll# Returns: 'ns:MeasureType'
setWeightMinor()
See the definition of WeightMajor. For calculated shipping only. Required on input when calculated shipping is used.
Calls: AddItem
GetItemRecommendations
RelistItem
ReviseItem
VerifyAddItem
RequiredInput: Conditionally# Argument: 'ns:MeasureType'
getWeightMinor()
Calls: GetBidderList
GetItemShipping
Returned: Conditionally
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll# Returns: 'ns:MeasureType'