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

Overview

Details about a specific shipping service.

@ingroup EBayAPIInterface

Tasks

  •   description

    Display string that applications can use to present a list of shipping service
    options in a more user-friendly format (such as in a drop-down list).

    property
  •   expeditedService

    Indicates whether the shipping service is an expedited shipping service.
    See Enabling Get It Fast. Only returned for sites for which the Get It
    Fast feature is enabled and only if true.

    property
  •   internationalService

    Indicates whether the shipping service is an international shipping service.
    An international shipping service option is required if an item is being
    shipped from one country (origin) to another (destination).

    property
  •   shippingService

    The name of shipping service option. 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.

    property
  •   shippingServiceID

    Numeric identifier. A value greater than 50000 represents an
    international shipping service (confirmed by
    InternationalShippingService being true). Some applications use this ID
    to look up shipping services more efficiently.
    Also useful for applications that have migrated from the legacy XML API.

    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). Always
    returned when ExpeditedService is true or if defined for a particular service.
    See Enabling Get It Fast feature.

    property
  •   shippingTimeMin

    The minimum 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). Always
    returned when ExpeditedService is true or if defined for a
    particular service.
    See Enabling Get It Fast feature.

    property
  •   shippingServiceCode

    For future use.

    property
  •   serviceType

    The types of shipping that this shipping service supports.

    property
  •   shippingPackage

    The kinds of packages supported by this shipping service.

    property
  •   dimensionsRequired

    This field is only returned if the shipping service option requires that package
    dimensions are provided by the seller. If it is returned, it is always returned
    as ‘true’.

    property
  •   validForSellingFlow

    If this field is returned as ‘true’, the shipping service option can be used in a
    Add/Revise/Relist API call. If this field is returned as ‘false’, the shipping
    service option is not currently supported and cannot be used in a
    Add/Revise/Relist API call.

    property
  •   surchargeApplicable

    True if a surcharge applies for any region that this service ships to.

    property
  •   shippingCarrier

    The kinds of carrier supported by this shipping service.

    property
  •   codService

    Applies to the Italy site (site ID 101) only. Indicates whether the shipping service
    is a Cash On Delivery shipping service.
    Returned only if true.

    property
  •   deprecationDetails

    A mechanism by which details about deprecation of a shipping service is
    announced. See also MappedToShippingServiceID.
    If this container is empty, it means that there is no mapping for this
    shipping service and that the shipping service will be dropped from the
    listing without an accompanying warning message from the eBay API.

    property
  •   mappedToShippingServiceID

    The ID of another shipping service that will be used when a
    shipping service is deprecated. See also DeprecationDetails.

    property
  •   costGroupFlat

    If returned, this is the shipping service group to which the shipping service belongs.
    Valid values are found in CostGroupFlatCodeType.

    property
  •   shippingServicePackageDetails

    Shipping Package level details for the enclosing shipping service, this
    complex type replaces the existing ShippingPackage type.

    property
  •   weightRequired

    If true, a seller who selects this package type for the listing and then offers
    this shipping service must specify WeightMajor and WeightMinor in the item definition.
    If not returned, WeightRequired is false.

    property
  •   detailVersion

    Returns the latest version number for this field. The version can be
    used to determine if and when to refresh cached client data.

    property
  •   updateTime

    Gives the time in GMT that the feature flags for the details were last
    updated. This timestamp can be used to determine if and when to refresh
    cached client data.

    property
  •   shippingCategory

    Indicates the shipping category. Shipping categories include the following:
    ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER, and NONE. International
    shipping services are generally grouped into the NONE category. For more
    information on these shipping categories, see the
    Shipping Basics page on the eBay Shipping Center site.

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

codService

Applies to the Italy site (site ID 101) only. Indicates whether the shipping service
is a Cash On Delivery shipping service.
Returned only if true.

@property (nonatomic, retain) NSNumber *codService

Discussion

Applies to the Italy site (site ID 101) only. Indicates whether the shipping service
is a Cash On Delivery shipping service.
Returned only if true.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ShippingServiceDetailsType.h

costGroupFlat

If returned, this is the shipping service group to which the shipping service belongs.
Valid values are found in CostGroupFlatCodeType.

@property (nonatomic, retain) NSString *costGroupFlat

Discussion

If returned, this is the shipping service group to which the shipping service belongs.
Valid values are found in CostGroupFlatCodeType.

type : NSString, wrapper for primitive string

Declared In

Trading_ShippingServiceDetailsType.h

deprecationDetails

A mechanism by which details about deprecation of a shipping service is
announced. See also MappedToShippingServiceID.
If this container is empty, it means that there is no mapping for this
shipping service and that the shipping service will be dropped from the
listing without an accompanying warning message from the eBay API.

@property (nonatomic, retain) NSMutableArray *deprecationDetails

Discussion

A mechanism by which details about deprecation of a shipping service is
announced. See also MappedToShippingServiceID.
If this container is empty, it means that there is no mapping for this
shipping service and that the shipping service will be dropped from the
listing without an accompanying warning message from the eBay API.

entry type : class Trading_AnnouncementMessageType

Declared In

Trading_ShippingServiceDetailsType.h

description

Display string that applications can use to present a list of shipping service
options in a more user-friendly format (such as in a drop-down list).

@property (nonatomic, retain) NSString *description

Discussion

Display string that applications can use to present a list of shipping service
options in a more user-friendly format (such as in a drop-down list).

type : NSString, wrapper for primitive string

Declared In

Trading_ShippingServiceDetailsType.h

detailVersion

Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.

@property (nonatomic, retain) NSString *detailVersion

Discussion

Returns the latest version number for this field. The version can be
used to determine if and when to refresh cached client data.

type : NSString, wrapper for primitive string

Declared In

Trading_ShippingServiceDetailsType.h

dimensionsRequired

This field is only returned if the shipping service option requires that package
dimensions are provided by the seller. If it is returned, it is always returned
as ‘true’.

@property (nonatomic, retain) NSNumber *dimensionsRequired

Discussion

This field is only returned if the shipping service option requires that package
dimensions are provided by the seller. If it is returned, it is always returned
as ‘true’.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ShippingServiceDetailsType.h

expeditedService

Indicates whether the shipping service is an expedited shipping service.
See Enabling Get It Fast. Only returned for sites for which the Get It
Fast feature is enabled and only if true.

@property (nonatomic, retain) NSNumber *expeditedService

Discussion

Indicates whether the shipping service is an expedited shipping service.
See Enabling Get It Fast. Only returned for sites for which the Get It
Fast feature is enabled and only if true.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ShippingServiceDetailsType.h

internationalService

Indicates whether the shipping service is an international shipping service.
An international shipping service option is required if an item is being
shipped from one country (origin) to another (destination).

@property (nonatomic, retain) NSNumber *internationalService

Discussion

Indicates whether the shipping service is an international shipping service.
An international shipping service option is required if an item is being
shipped from one country (origin) to another (destination).

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ShippingServiceDetailsType.h

mappedToShippingServiceID

The ID of another shipping service that will be used when a
shipping service is deprecated. See also DeprecationDetails.

@property (nonatomic, retain) NSNumber *mappedToShippingServiceID

Discussion

The ID of another shipping service that will be used when a
shipping service is deprecated. See also DeprecationDetails.

type : NSNumber, wrapper for primitive int

Declared In

Trading_ShippingServiceDetailsType.h

serviceType

The types of shipping that this shipping service supports.

@property (nonatomic, retain) NSMutableArray *serviceType

Discussion

The types of shipping that this shipping service supports.

entry type : string constant in Trading_ShippingTypeCodeType.h

Declared In

Trading_ShippingServiceDetailsType.h

shippingCarrier

The kinds of carrier supported by this shipping service.

@property (nonatomic, retain) NSMutableArray *shippingCarrier

Discussion

The kinds of carrier supported by this shipping service.

entry type : string constant in Trading_ShippingCarrierCodeType.h

Declared In

Trading_ShippingServiceDetailsType.h

shippingCategory

Indicates the shipping category. Shipping categories include the following:
ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER, and NONE. International
shipping services are generally grouped into the NONE category. For more
information on these shipping categories, see the
Shipping Basics page on the eBay Shipping Center site.

@property (nonatomic, retain) NSString *shippingCategory

Discussion

Indicates the shipping category. Shipping categories include the following:
ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER, and NONE. International
shipping services are generally grouped into the NONE category. For more
information on these shipping categories, see the
Shipping Basics page on the eBay Shipping Center site.

type : NSString, wrapper for primitive string

Declared In

Trading_ShippingServiceDetailsType.h

shippingPackage

The kinds of packages supported by this shipping service.

@property (nonatomic, retain) NSMutableArray *shippingPackage

Discussion

The kinds of packages supported by this shipping service.

entry type : string constant in Trading_ShippingPackageCodeType.h

Declared In

Trading_ShippingServiceDetailsType.h

shippingService

The name of shipping service option. 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.

@property (nonatomic, retain) NSString *shippingService

Discussion

The name of shipping service option. 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.

type : NSString, wrapper for primitive string

Declared In

Trading_ShippingServiceDetailsType.h

shippingServiceCode

For future use.

@property (nonatomic, retain) NSString *shippingServiceCode

Discussion

For future use.

type: string constant in Trading_ShippingServiceCodeType.h

Declared In

Trading_ShippingServiceDetailsType.h

shippingServiceID

Numeric identifier. A value greater than 50000 represents an
international shipping service (confirmed by
InternationalShippingService being true). Some applications use this ID
to look up shipping services more efficiently.
Also useful for applications that have migrated from the legacy XML API.

@property (nonatomic, retain) NSNumber *shippingServiceID

Discussion

Numeric identifier. A value greater than 50000 represents an
international shipping service (confirmed by
InternationalShippingService being true). Some applications use this ID
to look up shipping services more efficiently.
Also useful for applications that have migrated from the legacy XML API.

type : NSNumber, wrapper for primitive int

Declared In

Trading_ShippingServiceDetailsType.h

shippingServicePackageDetails

Shipping Package level details for the enclosing shipping service, this
complex type replaces the existing ShippingPackage type.

@property (nonatomic, retain) NSMutableArray *shippingServicePackageDetails

Discussion

Shipping Package level details for the enclosing shipping service, this
complex type replaces the existing ShippingPackage type.

entry type : class Trading_ShippingServicePackageDetailsType

Declared In

Trading_ShippingServiceDetailsType.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). Always
returned when ExpeditedService is true or if defined for a particular service.
See Enabling Get It Fast feature.

@property (nonatomic, retain) NSNumber *shippingTimeMax

Discussion

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). Always
returned when ExpeditedService is true or if defined for a particular service.
See Enabling Get It Fast feature.

type : NSNumber, wrapper for primitive int

Declared In

Trading_ShippingServiceDetailsType.h

shippingTimeMin

The minimum 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). Always
returned when ExpeditedService is true or if defined for a
particular service.
See Enabling Get It Fast feature.

@property (nonatomic, retain) NSNumber *shippingTimeMin

Discussion

The minimum 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). Always
returned when ExpeditedService is true or if defined for a
particular service.
See Enabling Get It Fast feature.

type : NSNumber, wrapper for primitive int

Declared In

Trading_ShippingServiceDetailsType.h

surchargeApplicable

True if a surcharge applies for any region that this service ships to.

@property (nonatomic, retain) NSNumber *surchargeApplicable

Discussion

True if a surcharge applies for any region that this service ships to.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ShippingServiceDetailsType.h

updateTime

Gives the time in GMT that the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.

@property (nonatomic, retain) NSDate *updateTime

Discussion

Gives the time in GMT that the feature flags for the details were last
updated. This timestamp can be used to determine if and when to refresh
cached client data.

type : NSDate, wrapper for primitive date

Declared In

Trading_ShippingServiceDetailsType.h

validForSellingFlow

If this field is returned as ‘true’, the shipping service option can be used in a
Add/Revise/Relist API call. If this field is returned as ‘false’, the shipping
service option is not currently supported and cannot be used in a
Add/Revise/Relist API call.

@property (nonatomic, retain) NSNumber *validForSellingFlow

Discussion

If this field is returned as ‘true’, the shipping service option can be used in a
Add/Revise/Relist API call. If this field is returned as ‘false’, the shipping
service option is not currently supported and cannot be used in a
Add/Revise/Relist API call.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ShippingServiceDetailsType.h

weightRequired

If true, a seller who selects this package type for the listing and then offers
this shipping service must specify WeightMajor and WeightMinor in the item definition.
If not returned, WeightRequired is false.

@property (nonatomic, retain) NSNumber *weightRequired

Discussion

If true, a seller who selects this package type for the listing and then offers
this shipping service must specify WeightMajor and WeightMinor in the item definition.
If not returned, WeightRequired is false.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_ShippingServiceDetailsType.h