Trading_ShippingServiceOptionsType Class Reference

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

Overview

Container consisting of shipping costs and other details related to a domestic
shipping service. An exception to the domestic shipping service rule is seen in the
ShippingServiceSelected container returned under the Order and Transaction
containers in order and order line item retrieval calls such as GetOrders or
GetItemTransactions. In this scenario, the SelectedShippingService container
consists of either domestic or international shipping service data, based on the
selected service according to the buyer’s shipping address.

If one or more international shipping services are provided, the
seller must specify at least one domestic shipping service as well.

Note: For GetItemTransactions and GetSellerTransactions, this container does not return accurate shipping service and cost information for multiple line item orders. Use GetOrders instead, and provide the order’s combined OrderID to retrieve this information.

@ingroup EBayAPIInterface

Tasks

shippingInsuranceCost
The insurance cost associated with shipping a single item
with this shipping service. Exception: for GetItemShipping,
this is proportional to QuantitySold. If the item has not yet been
sold, insurance information cannot be calculated and the value is
0.00. For calculated shipping only.
Also applicable to Half.com (for GetOrders).
property
shippingService
A shipping service option being offered by the seller to ship an item to a
buyer. For a list of valid ShippingService values, GeteBayDetails
with DetailName set to ShippingServiceDetails. The
ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise,
that particular shipping service option is no longer valid and cannot be offered
to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the
ShippingServiceDetails.ShippingService fields. Domestic shipping service options will
not have a InternationalService=true field, as this indicates that the ShippingService
value is an International shipping service option.

For flat and calculated shipping.
Also applicable to Half.com (for GetOrders).

If there are two or more services and one is “pickup”, “pickup"
must not be specified as the first service.
property
shippingServiceCost
The meaning of this element depends on the call and on whether flat or
calculated shipping has been selected. (For example, it could be the
cost to ship a single item, the cost to ship all items, or the cost to ship
just the first of many items, with ShippingServiceAdditionalCost accounting
for the rest.) When returned by GetItemShipping, it includes the packaging and
handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns
the shipping service cost, even if the cost is zero. Otherwise, cost is not
returned.

If this is for calculated shipping for a listing that has not
yet ended, note that the cost cannot be determined until the listing
has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if
applicable. 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.)

For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider’s warehouse).

Also applicable to Half.com (for GetOrders).
property
shippingServiceAdditionalCost
The cost of shipping each additional item beyond the first item. For input,
this is required if the listing is for multiple items. For single-item
listings, it should be zero (or is defaulted to zero if not provided).
For flat shipping only.
Not applicable to Half.com.
property
shippingServicePriority
This integer value controls the order (relative to other shipping services) in
which the corresponding ShippingService will appear in the View Item and
Checkout page. Sellers can specify up to four domestic shipping services (with
four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A
shipping service with a ShippingServicePriority value of 1 appears at the top.
Conversely, a shipping service with a ShippingServicePriority value of 4 appears
at the bottom of a list of four shipping service options.

This field is applicable to Flat and Calculated shipping. This field is not
applicable to Half.com listings.
property
expeditedService
Indicates whether the service is an expedited shipping service. See Enabling Get It Fast.
Not applicable to Half.com.
property
shippingTimeMin
The minimum guaranteed number of days in which the shipping carrier
can ship an item (not including the time it takes the seller to
deliver the item to the shipping carrier). See Enabling Get It Fast.
Not applicable to Half.com.
property
shippingTimeMax
The maximum guaranteed number of days the shipping carrier will
take to ship an item (not including the time it takes the seller to
deliver the item to the shipping carrier). See Enabling Get It Fast.
Not applicable to Half.com.
property
shippingSurcharge
An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii
or Puerto Rico. Can only be assigned a value for the eBay US site and for
items in the Parts and Accessories category of the eBay Motors site. Only returned if set.
If some line items in an order have a surcharge, surcharge is added
only for those line items.
Flat rate shipping only.
property
freeShipping
A seller offers free shipping by setting FreeShipping to true. This free
shipping applies only to the first specified domestic shipping service. (It is
ignored if set for any other shipping service.) If the seller has required
shipping insurance as part of shipping (the seller set InsuranceOption to
Required) and then the seller specified FreeShipping, eBay sets the insurance
cost to 0.00. However, if the seller made shipping insurance optional, eBay
preserves the cost of shipping insurance; it is up to the buyer whether to buy
shipping insurance, regardless of whether the seller specified FreeShipping.
property

localPickup

      The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option.  
        The LocalPickup flag can also be used with other fields to indicate if there is  no fee for local pickup.  For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping.

property

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

Trading_ShippingServiceOptionsType.h

expeditedService

Indicates whether the service is an expedited shipping service. See Enabling Get It Fast.
Not applicable to Half.com.

@property (nonatomic, retain) NSNumber *expeditedService

Discussion

Indicates whether the service is an expedited shipping service. See Enabling Get It Fast.
Not applicable to Half.com.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ShippingServiceOptionsType.h

freeShipping

A seller offers free shipping by setting FreeShipping to true. This free
shipping applies only to the first specified domestic shipping service. (It is
ignored if set for any other shipping service.) If the seller has required
shipping insurance as part of shipping (the seller set InsuranceOption to
Required) and then the seller specified FreeShipping, eBay sets the insurance
cost to 0.00. However, if the seller made shipping insurance optional, eBay
preserves the cost of shipping insurance; it is up to the buyer whether to buy
shipping insurance, regardless of whether the seller specified FreeShipping.

@property (nonatomic, retain) NSNumber *freeShipping

Discussion

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ShippingServiceOptionsType.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) Trading_AmountType *importCharge

Discussion

type : class Trading_AmountType

Declared In

Trading_ShippingServiceOptionsType.h

localPickup

      The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option.  
        The LocalPickup flag can also be used with other fields to indicate if there is  no fee for local pickup.  For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping.

@property (nonatomic, retain) NSNumber *localPickup

Discussion

      The LocalPickup flag is used by the GetMyEbayBuying and GetMyEbaySelling calls to indicate whether the buyer has selected local pickup as the shipping option or the seller has specified local pickup as the first shipping option.  
        The LocalPickup flag can also be used with other fields to indicate if there is  no fee for local pickup.  For example, if the LocalPickup flag is used with the ShippingServiceOptions and ShippingServiceCost fields, the seller can indicate that local pickup is an available option and that no is fee charged. This is the equivalent of free shipping.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ShippingServiceOptionsType.h

shippingInsuranceCost

The insurance cost associated with shipping a single item
with this shipping service. Exception: for GetItemShipping,
this is proportional to QuantitySold. If the item has not yet been
sold, insurance information cannot be calculated and the value is
0.00. For calculated shipping only.
Also applicable to Half.com (for GetOrders).

@property (nonatomic, retain) Trading_AmountType *shippingInsuranceCost

Discussion

type : class Trading_AmountType

Declared In

Trading_ShippingServiceOptionsType.h

shippingService

A shipping service option being offered by the seller to ship an item to a
buyer. For a list of valid ShippingService values, GeteBayDetails
with DetailName set to ShippingServiceDetails. The
ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise,
that particular shipping service option is no longer valid and cannot be offered
to buyers through a listing.

To view the full list of domestic shipping service options in the response, look for the
ShippingServiceDetails.ShippingService fields. Domestic shipping service options will
not have a InternationalService=true field, as this indicates that the ShippingService
value is an International shipping service option.

For flat and calculated shipping.
Also applicable to Half.com (for GetOrders).

If there are two or more services and one is “pickup”, “pickup"
must not be specified as the first service.

@property (nonatomic, retain) NSString *shippingService

Discussion

type : NSString, wrapper for primitive string

Declared In

Trading_ShippingServiceOptionsType.h

shippingServiceAdditionalCost

The cost of shipping each additional item beyond the first item. For input,
this is required if the listing is for multiple items. For single-item
listings, it should be zero (or is defaulted to zero if not provided).
For flat shipping only.
Not applicable to Half.com.

@property (nonatomic, retain) Trading_AmountType *shippingServiceAdditionalCost

Discussion

type : class Trading_AmountType

Declared In

Trading_ShippingServiceOptionsType.h

shippingServiceCost

The meaning of this element depends on the call and on whether flat or
calculated shipping has been selected. (For example, it could be the
cost to ship a single item, the cost to ship all items, or the cost to ship
just the first of many items, with ShippingServiceAdditionalCost accounting
for the rest.) When returned by GetItemShipping, it includes the packaging and
handling cost. For flat and calculated shipping.

If a shipping service has been specified (even LocalPickup), GetItem returns
the shipping service cost, even if the cost is zero. Otherwise, cost is not
returned.

If this is for calculated shipping for a listing that has not
yet ended, note that the cost cannot be determined until the listing
has ended and the buyer has specified a postal code.

For GetItemShipping, promotional shipping savings is reflected in the cost, if
applicable. 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.)

For GetMyeBaySelling, ShippingServiceCost under the SoldList and DeletedFromSoldList containers returns the cost of the domestic leg of a Global Shipping Program shipment (to the international shipping provider’s warehouse).

Also applicable to Half.com (for GetOrders).

@property (nonatomic, retain) Trading_AmountType *shippingServiceCost

Discussion

type : class Trading_AmountType

Declared In

Trading_ShippingServiceOptionsType.h

shippingServicePriority

This integer value controls the order (relative to other shipping services) in
which the corresponding ShippingService will appear in the View Item and
Checkout page. Sellers can specify up to four domestic shipping services (with
four ShippingServiceOptions containers), so valid values are 1, 2, 3, and 4. A
shipping service with a ShippingServicePriority value of 1 appears at the top.
Conversely, a shipping service with a ShippingServicePriority value of 4 appears
at the bottom of a list of four shipping service options.

This field is applicable to Flat and Calculated shipping. This field is not
applicable to Half.com listings.

@property (nonatomic, retain) NSNumber *shippingServicePriority

Discussion

type : NSNumber, wrapper for primitive int

Declared In

Trading_ShippingServiceOptionsType.h

shippingSurcharge

An additional fee to charge US buyers who have the item shipped via UPS or FedEx to Alaska, Hawaii
or Puerto Rico. Can only be assigned a value for the eBay US site and for
items in the Parts and Accessories category of the eBay Motors site. Only returned if set.
If some line items in an order have a surcharge, surcharge is added
only for those line items.
Flat rate shipping only.

@property (nonatomic, retain) Trading_AmountType *shippingSurcharge

Discussion

type : class Trading_AmountType

Declared In

Trading_ShippingServiceOptionsType.h

shippingTimeMax

The maximum guaranteed number of days the shipping carrier will
take to ship an item (not including the time it takes the seller to
deliver the item to the shipping carrier). See Enabling Get It Fast.
Not applicable to Half.com.

@property (nonatomic, retain) NSNumber *shippingTimeMax

Discussion

type : NSNumber, wrapper for primitive int

Declared In

Trading_ShippingServiceOptionsType.h

shippingTimeMin

The minimum guaranteed number of days in which the shipping carrier
can ship an item (not including the time it takes the seller to
deliver the item to the shipping carrier). See Enabling Get It Fast.
Not applicable to Half.com.

@property (nonatomic, retain) NSNumber *shippingTimeMin

Discussion

type : NSNumber, wrapper for primitive int

Declared In

Trading_ShippingServiceOptionsType.h