ShippingServiceDetailsType

Details about a specific shipping service.

Types that use ShippingServiceDetailsType:

Call that uses one or more fields of ShippingServiceDetailsType:

Fields

CODService ( boolean )
CostGroupFlat ( token )
DeprecationDetails ( AnnouncementMessageType )
Description ( string )
DetailVersion ( string )
DimensionsRequired ( boolean )
ExpeditedService ( boolean )
InternationalService ( boolean )
MappedToShippingServiceID ( int )
ServiceType ( ShippingTypeCodeType )
ShippingCarrier ( ShippingCarrierCodeType )
ShippingCategory ( token )
ShippingPackage ( ShippingPackageCodeType )
ShippingService ( token )
ShippingServiceCode
ShippingServiceID ( int )
ShippingServicePackageDetails ( ShippingServicePackageDetailsType )
ShippingTimeMax ( int )
ShippingTimeMin ( int )
SurchargeApplicable ( boolean )
UpdateTime ( dateTime )
ValidForSellingFlow ( boolean )
WeightRequired ( boolean )

CODService ( boolean ) [0..1]
This flag is returned as 'true' if the corresponding ShippingServiceDetails.ShippingService value is a COD (Cash-On-Delivery) service.

COD shipping services are not supported by all sites. This field is only returned if 'true'.
See the Field Index to learn which calls use CODService.

CostGroupFlat ( token ) [0..1]
If returned, this is the shipping service group to which the shipping service belongs. Valid values are found in CostGroupFlatCodeType.
See the Field Index to learn which calls use CostGroupFlat.

DeprecationDetails ( AnnouncementMessageType ) [0..*]
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.
See the Field Index to learn which calls use DeprecationDetails.

Description ( string ) [0..1]
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).
See the Field Index to learn which calls use Description.

DetailVersion ( string ) [1]
Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
See the Field Index to learn which calls use DetailVersion.

DimensionsRequired ( boolean ) [0..1]
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'.
See the Field Index to learn which calls use DimensionsRequired.

ExpeditedService ( boolean ) [0..1]
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.
See the Field Index to learn which calls use ExpeditedService.

InternationalService ( boolean ) [0..1]
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).
See the Field Index to learn which calls use InternationalService.

MappedToShippingServiceID ( int ) [0..1]
The ID of another shipping service that will be used when a shipping service is deprecated. See also DeprecationDetails.
See the Field Index to learn which calls use MappedToShippingServiceID.

ServiceType ( see ShippingTypeCodeType for possible values ) [0..*]
The types of shipping that this shipping service supports.
See the Field Index to learn which calls use ServiceType.

ShippingCarrier ( see ShippingCarrierCodeType for possible values ) [0..*]
The kinds of carrier supported by this shipping service.
See the Field Index to learn which calls use ShippingCarrier.

ShippingCategory ( token ) [0..1]
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.
See the Field Index to learn which calls use ShippingCategory.

ShippingPackage ( see ShippingPackageCodeType for possible values ) [0..*]
The kinds of packages supported by this shipping service.
See the Field Index to learn which calls use ShippingPackage.

ShippingService ( token ) [0..1]
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.
See the Field Index to learn which calls use ShippingService.

ShippingServiceCode
Not used by any call.

ShippingServiceID ( int ) [0..1]
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.
See the Field Index to learn which calls use ShippingServiceID.

ShippingServicePackageDetails ( ShippingServicePackageDetailsType ) [0..*]
Shipping Package level details for the enclosing shipping service, this complex type replaces the existing ShippingPackage type.
See the Field Index to learn which calls use ShippingServicePackageDetails.

ShippingTimeMax ( int ) [0..1]
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.
See the Field Index to learn which calls use ShippingTimeMax.

ShippingTimeMin ( int ) [0..1]
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.
See the Field Index to learn which calls use ShippingTimeMin.

SurchargeApplicable ( boolean ) [0..1]
True if a surcharge applies for any region that this service ships to.
See the Field Index to learn which calls use SurchargeApplicable.

UpdateTime ( dateTime ) [1]
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.
See the Field Index to learn which calls use UpdateTime.

ValidForSellingFlow ( boolean ) [0..1]
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.
See the Field Index to learn which calls use ValidForSellingFlow.

WeightRequired ( boolean ) [0..1]
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.
See the Field Index to learn which calls use WeightRequired.

Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.