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

Overview

Type for the shipping-related details for an item or transaction.

@ingroup ShoppingInterface

Tasks

  •   getItFast

    Indicates whether the seller has opted the listing into the Get
    It Fast feature. If GetItFast is true, and if at least one of
    the domestic shipping services offered by the seller is an
    expedited shipping service, every shipping service offered by
    the seller is considered a Get It Fast service, and the seller
    commits to delivering the item to the buyer-selected shipping
    service within one day.

         property
  •   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, use GetSingleItem.



    Not applicable to eBay Motors vehicle listings.

         property
  •   insuranceOption

    Whether the seller offers shipping insurance and, if so, whether the insurance
    is optional or required. Flat and calculated shipping.

         property
  •   internationalShippingServiceOption

    Shipping costs and options related to an international shipping service. For
    calculated shipping, postal code must be known to determine final shipping
    cost (and this can only be known if a transaction has been created). For
    GetShippingCosts, if the postal code or bidder is in the same country as the
    listing site for the item, it is “domestic shipping” and this container is not
    returned (and ShippingServiceOption is returned instead). Otherwise, it is
    “international shipping” and this container is returned.



    For GetShippingCosts, results are filtered: if any service is not available
    in the buyer’s region, it is removed. If no services remain after this
    filtering, a warning is returned.



    Not applicable to Half.com or eBay Motors vehicle listings.

         property
  •   salesTax

    Sales tax details. US site only. Flat and calculated shipping.



    Not applicable to eBay Motors vehicle listings.

         property
  •   shippingRateErrorMessage

    For most applicable calls, returns the words No Error or returns an error
    message related to an attempt to calculate shipping rates. For calculated
    shipping only.



    Not applicable to Half.com or eBay Motors vehicle listings.

         property
  •   shippingServiceOption

    Shipping costs and options related to a domestic shipping service.
    For GetShippingCosts, if the postal code or bidder is
    in the same country as the listing site for the item, it is “domestic
    shipping” and this container is returned. Otherwise, it is “international
    shipping” and this container is not returned (and InternationalShippingServiceOption
    is returned instead, if it exists).
    For calculated shipping, postal code must be known to determine final shipping
    cost (and this can only be known if a transaction has been created).
    For flat shipping: if the listing has not yet ended, any domestic
    shipping details are returned; if the listing has ended, domestic
    shipping details are only returned if the buyer’s location is
    “domestic” (that is, it is the same country as the listing site).


    Not applicable to Half.com or eBay Motors vehicle listings.

         property
  •   taxTable

    Tax details for a jurisdiction such as a state or province.
    Returned empty in if no tax table was used.



    Not applicable to Half.com.

         property
  •   internationalInsuranceCost

    The cost of insurance for items shipped internationally. 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, use
    GetSingleItem.



    Not applicable to eBay Motors vehicle listings.

         property
  •   internationalInsuranceOption

    Whether the seller offers shipping insurance for items shipped internationally
    and, if so, whether the insurance is optional or required. Flat and calculated
    shipping.

         property
  •   codCost

    Italy site (site ID 101) only. Contains the cost of cash-on-delivery shipping.

         property
  •   excludeShipToLocation

    A location to which the seller will not ship.
    Returned only if set via Trading API.
    Returned only with a request version of 665 or greater.

         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_ShippingDetailsType.h

codCost

Italy site (site ID 101) only. Contains the cost of cash-on-delivery shipping.

@property (nonatomic, retain) Shopping_AmountType *codCost

Discussion

Italy site (site ID 101) only. Contains the cost of cash-on-delivery shipping.

type : class Shopping_AmountType

Declared In

Shopping_ShippingDetailsType.h

excludeShipToLocation

A location to which the seller will not ship.
Returned only if set via Trading API.
Returned only with a request version of 665 or greater.

@property (nonatomic, retain) NSMutableArray *excludeShipToLocation

Discussion

A location to which the seller will not ship.
Returned only if set via Trading API.
Returned only with a request version of 665 or greater.

entry type : NSString, wrapper for primitive string

Declared In

Shopping_ShippingDetailsType.h

getItFast

Indicates whether the seller has opted the listing into the Get
It Fast feature. If GetItFast is true, and if at least one of
the domestic shipping services offered by the seller is an
expedited shipping service, every shipping service offered by
the seller is considered a Get It Fast service, and the seller
commits to delivering the item to the buyer-selected shipping
service within one day.

@property (nonatomic, retain) NSNumber *getItFast

Discussion

Indicates whether the seller has opted the listing into the Get
It Fast feature. If GetItFast is true, and if at least one of
the domestic shipping services offered by the seller is an
expedited shipping service, every shipping service offered by
the seller is considered a Get It Fast service, and the seller
commits to delivering the item to the buyer-selected shipping
service within one day.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_ShippingDetailsType.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, use GetSingleItem.



Not applicable to eBay Motors vehicle listings.

@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, use GetSingleItem.



Not applicable to eBay Motors vehicle listings.

type : class Shopping_AmountType

Declared In

Shopping_ShippingDetailsType.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_ShippingDetailsType.h

internationalInsuranceCost

The cost of insurance for items shipped internationally. 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, use
GetSingleItem.



Not applicable to eBay Motors vehicle listings.

@property (nonatomic, retain) Shopping_AmountType *internationalInsuranceCost

Discussion

The cost of insurance for items shipped internationally. 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, use
GetSingleItem.



Not applicable to eBay Motors vehicle listings.

type : class Shopping_AmountType

Declared In

Shopping_ShippingDetailsType.h

internationalInsuranceOption

Whether the seller offers shipping insurance for items shipped internationally
and, if so, whether the insurance is optional or required. Flat and calculated
shipping.

@property (nonatomic, retain) NSString *internationalInsuranceOption

Discussion

Whether the seller offers shipping insurance for items shipped internationally
and, if so, whether the insurance is optional or required. Flat and calculated
shipping.

type: string constant in Shopping_InsuranceOptionCodeType.h

Declared In

Shopping_ShippingDetailsType.h

internationalShippingServiceOption

Shipping costs and options related to an international shipping service. For
calculated shipping, postal code must be known to determine final shipping
cost (and this can only be known if a transaction has been created). For
GetShippingCosts, if the postal code or bidder is in the same country as the
listing site for the item, it is “domestic shipping” and this container is not
returned (and ShippingServiceOption is returned instead). Otherwise, it is
“international shipping” and this container is returned.



For GetShippingCosts, results are filtered: if any service is not available
in the buyer’s region, it is removed. If no services remain after this
filtering, a warning is returned.



Not applicable to Half.com or eBay Motors vehicle listings.

@property (nonatomic, retain) NSMutableArray *internationalShippingServiceOption

Discussion

Shipping costs and options related to an international shipping service. For
calculated shipping, postal code must be known to determine final shipping
cost (and this can only be known if a transaction has been created). For
GetShippingCosts, if the postal code or bidder is in the same country as the
listing site for the item, it is “domestic shipping” and this container is not
returned (and ShippingServiceOption is returned instead). Otherwise, it is
“international shipping” and this container is returned.



For GetShippingCosts, results are filtered: if any service is not available
in the buyer’s region, it is removed. If no services remain after this
filtering, a warning is returned.



Not applicable to Half.com or eBay Motors vehicle listings.

entry type : class Shopping_InternationalShippingServiceOptionType

Declared In

Shopping_ShippingDetailsType.h

salesTax

Sales tax details. US site only. Flat and calculated shipping.



Not applicable to eBay Motors vehicle listings.

@property (nonatomic, retain) Shopping_SalesTaxType *salesTax

Discussion

Sales tax details. US site only. Flat and calculated shipping.



Not applicable to eBay Motors vehicle listings.

type : class Shopping_SalesTaxType

Declared In

Shopping_ShippingDetailsType.h

shippingRateErrorMessage

For most applicable calls, returns the words No Error or returns an error
message related to an attempt to calculate shipping rates. For calculated
shipping only.



Not applicable to Half.com or eBay Motors vehicle listings.

@property (nonatomic, retain) NSString *shippingRateErrorMessage

Discussion

For most applicable calls, returns the words No Error or returns an error
message related to an attempt to calculate shipping rates. For calculated
shipping only.



Not applicable to Half.com or eBay Motors vehicle listings.

type : NSString, wrapper for primitive string

Declared In

Shopping_ShippingDetailsType.h

shippingServiceOption

Shipping costs and options related to a domestic shipping service.
For GetShippingCosts, if the postal code or bidder is
in the same country as the listing site for the item, it is “domestic
shipping” and this container is returned. Otherwise, it is “international
shipping” and this container is not returned (and InternationalShippingServiceOption
is returned instead, if it exists).
For calculated shipping, postal code must be known to determine final shipping
cost (and this can only be known if a transaction has been created).
For flat shipping: if the listing has not yet ended, any domestic
shipping details are returned; if the listing has ended, domestic
shipping details are only returned if the buyer’s location is
“domestic” (that is, it is the same country as the listing site).


Not applicable to Half.com or eBay Motors vehicle listings.

@property (nonatomic, retain) NSMutableArray *shippingServiceOption

Discussion

Shipping costs and options related to a domestic shipping service.
For GetShippingCosts, if the postal code or bidder is
in the same country as the listing site for the item, it is “domestic
shipping” and this container is returned. Otherwise, it is “international
shipping” and this container is not returned (and InternationalShippingServiceOption
is returned instead, if it exists).
For calculated shipping, postal code must be known to determine final shipping
cost (and this can only be known if a transaction has been created).
For flat shipping: if the listing has not yet ended, any domestic
shipping details are returned; if the listing has ended, domestic
shipping details are only returned if the buyer’s location is
“domestic” (that is, it is the same country as the listing site).


Not applicable to Half.com or eBay Motors vehicle listings.

entry type : class Shopping_ShippingServiceOptionType

Declared In

Shopping_ShippingDetailsType.h

taxTable

Tax details for a jurisdiction such as a state or province.
Returned empty in if no tax table was used.



Not applicable to Half.com.

@property (nonatomic, retain) Shopping_TaxTableType *taxTable

Discussion

Tax details for a jurisdiction such as a state or province.
Returned empty in if no tax table was used.



Not applicable to Half.com.

type : class Shopping_TaxTableType

Declared In

Shopping_ShippingDetailsType.h