Shopping_ShippingCostSummaryType Class Reference
Inherits from | NSObject |
Conforms to | PicoBindable |
Declared in | Shopping_ShippingCostSummaryType.h Shopping_ShippingCostSummaryType.m |
Overview
Type for the shipping-related details for an item or transaction.
@ingroup ShoppingInterface
Tasks
-
shippingServiceName
The name of a shipping service.
property -
shippingServiceCost
The basic shipping cost of the item.
property
This reflects the domestic shipping cost or the international shipping costs,
depending on which applies (that is, whether the bidder/buyer is in the same
country as the listing site of the item).
In GetSingleItem, this is always returned when ShippingCostSummary is
returned, except for when the ShippingType is Freight.
GetShippingCosts:
Flat shipping: single-item listing: this matches (in)ShippingServiceCost;
multi-quantity listing: with a request version of 665 or greater,
this is the total of (in)ShippingServiceCost plus
((in)ShippingServiceAdditionalCost times the number of items beyond the first
item), and with a request version lower than 665, this is (in)ShippingServiceCost.
Promotional shipping: For a request version lower than 665, promotional
shipping has no effect on shipping costs. Otherwise: if the promotional
shipping option is lower than other shipping services being offered, the
savings is reflected in the returned shipping cost;
the shipping service named Promotional Shipping Service (or whatever is
the localized name for it) is included among the shipping services;
if the promotional shipping cost is lower than the cost of other shipping
services being offered, it is presented first in the list (the lowest shipping
service cost is always presented first, regardless of whether there is
promotional shipping).
Shipping surcharge: With a request version of
665 or greater, shipping cost includes any surcharge, and surcharge is not
returned as an individual tag. With a request version lower than 665,
surcharge is not part of the total cost and is returned as its own tag. -
insuranceCost
The cost of insurance. For flat rate shipping, this is the value set by the
property
seller, if any. For calculated shipping, this is the value calculated by eBay
with the shipping carrier for the particular item and can only be determined
once the final item price is known when the listing ends. To determine whether
a listing has ended, see EndTime or ListingStatus in GetSingleItem. -
shippingType
How the seller stated that cost of shipping is to be determined, such as flat rate or
property
calculated. -
localPickup
If ShippingCosts is specified for the IncludeSelector, and if the seller has specified local
property
pickup for this item; the LocalPickup boolean is returned as true. This indicates that the
seller does not ship this item. If local pickup
was not specified for this item by the seller, the LocalPickup boolean is not returned. -
insuranceOption
Whether the seller offers shipping insurance and, if
property
so, whether the insurance is optional or required. Flat and
calculated shipping. -
listedShippingServiceCost
The listed shipping cost of the item. If multiple items were purchased, this
property
includes the listed ShippingServiceAdditionalCost.
In GetSingleItem, this is always returned when ShippingCostSummary is
returned, except when the ShippingType is Freight. -
importCharge
The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
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
Shopping_ShippingCostSummaryType.h
importCharge
The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
@property (nonatomic, retain) Shopping_AmountType *importCharge
Discussion
The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties.
type : class Shopping_AmountType
Declared In
Shopping_ShippingCostSummaryType.h
insuranceCost
The cost of insurance. For flat rate shipping, this is the value set by the
seller, if any. For calculated shipping, this is the value calculated by eBay
with the shipping carrier for the particular item and can only be determined
once the final item price is known when the listing ends. To determine whether
a listing has ended, see EndTime or ListingStatus in GetSingleItem.
@property (nonatomic, retain) Shopping_AmountType *insuranceCost
Discussion
The cost of insurance. For flat rate shipping, this is the value set by the
seller, if any. For calculated shipping, this is the value calculated by eBay
with the shipping carrier for the particular item and can only be determined
once the final item price is known when the listing ends. To determine whether
a listing has ended, see EndTime or ListingStatus in GetSingleItem.
type : class Shopping_AmountType
Declared In
Shopping_ShippingCostSummaryType.h
insuranceOption
Whether the seller offers shipping insurance and, if
so, whether the insurance is optional or required. Flat and
calculated shipping.
@property (nonatomic, retain) NSString *insuranceOption
Discussion
Whether the seller offers shipping insurance and, if
so, whether the insurance is optional or required. Flat and
calculated shipping.
type: string constant in Shopping_InsuranceOptionCodeType.h
Declared In
Shopping_ShippingCostSummaryType.h
listedShippingServiceCost
The listed shipping cost of the item. If multiple items were purchased, this
includes the listed ShippingServiceAdditionalCost.
In GetSingleItem, this is always returned when ShippingCostSummary is
returned, except when the ShippingType is Freight.
@property (nonatomic, retain) Shopping_AmountType *listedShippingServiceCost
Discussion
The listed shipping cost of the item. If multiple items were purchased, this
includes the listed ShippingServiceAdditionalCost.
In GetSingleItem, this is always returned when ShippingCostSummary is
returned, except when the ShippingType is Freight.
type : class Shopping_AmountType
Declared In
Shopping_ShippingCostSummaryType.h
localPickup
If ShippingCosts is specified for the IncludeSelector, and if the seller has specified local
pickup for this item; the LocalPickup boolean is returned as true. This indicates that the
seller does not ship this item. If local pickup
was not specified for this item by the seller, the LocalPickup boolean is not returned.
@property (nonatomic, retain) NSNumber *localPickup
Discussion
If ShippingCosts is specified for the IncludeSelector, and if the seller has specified local
pickup for this item; the LocalPickup boolean is returned as true. This indicates that the
seller does not ship this item. If local pickup
was not specified for this item by the seller, the LocalPickup boolean is not returned.
type : NSNumber, wrapper for primitive bool
Declared In
Shopping_ShippingCostSummaryType.h
shippingServiceCost
The basic shipping cost of the item.
This reflects the domestic shipping cost or the international shipping costs,
depending on which applies (that is, whether the bidder/buyer is in the same
country as the listing site of the item).
In GetSingleItem, this is always returned when ShippingCostSummary is
returned, except for when the ShippingType is Freight.
GetShippingCosts:
Flat shipping: single-item listing: this matches (in)ShippingServiceCost;
multi-quantity listing: with a request version of 665 or greater,
this is the total of (in)ShippingServiceCost plus
((in)ShippingServiceAdditionalCost times the number of items beyond the first
item), and with a request version lower than 665, this is (in)ShippingServiceCost.
Promotional shipping: For a request version lower than 665, promotional
shipping has no effect on shipping costs. Otherwise: if the promotional
shipping option is lower than other shipping services being offered, the
savings is reflected in the returned shipping cost;
the shipping service named Promotional Shipping Service (or whatever is
the localized name for it) is included among the shipping services;
if the promotional shipping cost is lower than the cost of other shipping
services being offered, it is presented first in the list (the lowest shipping
service cost is always presented first, regardless of whether there is
promotional shipping).
Shipping surcharge: With a request version of
665 or greater, shipping cost includes any surcharge, and surcharge is not
returned as an individual tag. With a request version lower than 665,
surcharge is not part of the total cost and is returned as its own tag.
@property (nonatomic, retain) Shopping_AmountType *shippingServiceCost
Discussion
The basic shipping cost of the item.
This reflects the domestic shipping cost or the international shipping costs,
depending on which applies (that is, whether the bidder/buyer is in the same
country as the listing site of the item).
In GetSingleItem, this is always returned when ShippingCostSummary is
returned, except for when the ShippingType is Freight.
GetShippingCosts:
Flat shipping: single-item listing: this matches (in)ShippingServiceCost;
multi-quantity listing: with a request version of 665 or greater,
this is the total of (in)ShippingServiceCost plus
((in)ShippingServiceAdditionalCost times the number of items beyond the first
item), and with a request version lower than 665, this is (in)ShippingServiceCost.
Promotional shipping: For a request version lower than 665, promotional
shipping has no effect on shipping costs. Otherwise: if the promotional
shipping option is lower than other shipping services being offered, the
savings is reflected in the returned shipping cost;
the shipping service named Promotional Shipping Service (or whatever is
the localized name for it) is included among the shipping services;
if the promotional shipping cost is lower than the cost of other shipping
services being offered, it is presented first in the list (the lowest shipping
service cost is always presented first, regardless of whether there is
promotional shipping).
Shipping surcharge: With a request version of
665 or greater, shipping cost includes any surcharge, and surcharge is not
returned as an individual tag. With a request version lower than 665,
surcharge is not part of the total cost and is returned as its own tag.
type : class Shopping_AmountType
Declared In
Shopping_ShippingCostSummaryType.h
shippingServiceName
The name of a shipping service.
@property (nonatomic, retain) NSString *shippingServiceName
Discussion
The name of a shipping service.
type : NSString, wrapper for primitive string
Declared In
Shopping_ShippingCostSummaryType.h
shippingType
How the seller stated that cost of shipping is to be determined, such as flat rate or
calculated.
@property (nonatomic, retain) NSString *shippingType
Discussion
How the seller stated that cost of shipping is to be determined, such as flat rate or
calculated.
type: string constant in Shopping_ShippingTypeCodeType.h
Declared In
Shopping_ShippingCostSummaryType.h