eBay Trading APIVersion 1067

ShippingServiceDetailsType

Type used by the ShippingServiceDetails containers that are returned in the GeteBayDetails response. Each ShippingServiceDetails container consists of detailed information about each shipping service option available for the specified country. These details include the shipping service enumeration value to use when specifying shipping service options in an Add/Revise/Relist call, the shipping carrier, the shipping category (e.g. expedited, economy, etc.), the shipping packages that can be used, and the shipping delivery window.

Type that uses ShippingServiceDetailsType:

Call that uses ShippingServiceDetailsType:

Fields



CODService ( boolean ) [0..1]
This field is only returned if'true', and indicates that the corresponding ShippingServiceDetails.ShippingService value is a COD (Cash-On-Delivery) service.

COD shipping services are not supported by all sites.
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 ) [0..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. This field is only returned if '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. This field is only returned if the shipping service is an expedited shipping service (value=true). Expedited generally means that the shipment can arrive at the buyer's location within one or two business days.
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 ( ShippingTypeCodeType ) [0..*]
The shipping cost types that this shipping service option supports, such as flat-rate or calculated. A ServiceType field is returned for each shipping cost type supported by the shipping service option.
See the Field Index to learn which calls use ServiceType.

ShippingCarrier ( ShippingCarrierCodeType ) [0..*]
The enumeration value for the shipping carrier associated with the shipping service option.

Note: Commonly used shipping carriers can also be found by calling GeteBayDetails with DetailName set to ShippingCarrierDetails and examining the returned ShippingCarrierDetails.ShippingCarrier field.
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 about these shipping categories, see the Shipping Basics page on the eBay Shipping Center site.

Note: This field is returned only for those sites that support shipping categories: US (0), CA (2), CAFR (210), UK (3), AU (15), FR (71), DE (77), IT (101) and ES (186).
See the Field Index to learn which calls use ShippingCategory.

ShippingPackage ( ShippingPackageCodeType ) [0..*]
The shipping packages that can be used for this shipping service option. A ShippingPackage field is returned for each shipping package supported by the shipping service option.
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 and true. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

This token value is the text that a seller will provide in the ShippingDetails.ShippingServiceOptions.ShippingService field when creating a listing.
See the Field Index to learn which calls use ShippingService.

ShippingServiceCode ( ShippingServiceCodeType ) [0..1]
Not used by any call.

For future use.
See the Field Index to learn which calls use ShippingServiceCode.

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.
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 integer value returned here indicates the maximum number of business days that the shipping carrier (indicated in the corresponding ShippingCarrier field) will take to ship an item using the corresponding shipping service option (indicated in the ShippingService field).

This maximum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.

For sellers opted into and using eBay Guaranteed Delivery, they should be looking at this value, and this value plus their handling time stated in the listing cannot be greater than 4 business days in order for that listing to be eligible for eBay Guaranteed Delivery.
See the Field Index to learn which calls use ShippingTimeMax.

ShippingTimeMin ( int ) [0..1]
The integer value returned here indicates the minimum number of business days that the shipping carrier (indicated in the corresponding ShippingCarrier field) will take to ship an item using the corresponding shipping service option (indicated in the ShippingService field).

This minimum shipping time does not include the seller's handling time, and the clock starts on the shipping time only after the seller has delivered the item to the shipping carrier for shipment to the buyer. 'Business days' can vary by shipping carrier and by country, but 'business days' are generally Monday through Friday, excluding holidays. This field is returned if defined for that particular shipping service option.
See the Field Index to learn which calls use ShippingTimeMin.

SurchargeApplicable ( boolean ) [0..1]
This field is only returned if 'true', and indicates that a shipping surcharge is applicable for this shipping service option.
See the Field Index to learn which calls use SurchargeApplicable.

UpdateTime ( dateTime ) [0..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.