Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
complexType "ns:ShippingServiceDetailsType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 23 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 23 elements, elem. wildcard
Used:
at 1 location
Component Diagram
XML Representation Summary
<...>
   
Content: 
ns:Description?, ns:ExpeditedService?, ns:InternationalService?, ns:ShippingService?, ns:ShippingServiceID?, ns:ShippingTimeMax?, ns:ShippingTimeMin?, ns:ShippingServiceCode?, ns:ServiceType*, ns:ShippingPackage*, ns:DimensionsRequired?, ns:ValidForSellingFlow?, ns:SurchargeApplicable?, ns:ShippingCarrier*, ns:CODService?, ns:DeprecationDetails*, ns:MappedToShippingServiceID?, ns:CostGroupFlat?, ns:ShippingServicePackageDetails*, ns:WeightRequired?, ns:DetailVersion?, ns:UpdateTime?, ns:ShippingCategory?, {any}*
</...>
All Direct / Indirect Based Elements (1):
ns:ShippingServiceDetails (in ns:GeteBayDetailsResponse)
Known Usage Locations
Annotation
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.

ShippingServiceDetails containers are returned if a DetailName field is included in the call request and set to ShippingServiceDetails, or if no DetailName field is included in the call request.
XML Source (w/o annotations (24); see within schema source)
<xs:complexType name="ShippingServiceDetailsType">
<xs:sequence>
<xs:element minOccurs="0" name="Description" type="xs:string"/>
<xs:element minOccurs="0" name="ExpeditedService" type="xs:boolean"/>
<xs:element minOccurs="0" name="InternationalService" type="xs:boolean"/>
<xs:element minOccurs="0" name="ShippingService" type="xs:token"/>
<xs:element minOccurs="0" name="ShippingServiceID" type="xs:int"/>
<xs:element minOccurs="0" name="ShippingTimeMax" type="xs:int"/>
<xs:element minOccurs="0" name="ShippingTimeMin" type="xs:int"/>
<xs:element minOccurs="0" name="ShippingServiceCode" type="ns:ShippingServiceCodeType"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="ServiceType" type="ns:ShippingTypeCodeType"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="ShippingPackage" type="ns:ShippingPackageCodeType"/>
<xs:element minOccurs="0" name="DimensionsRequired" type="xs:boolean"/>
<xs:element minOccurs="0" name="ValidForSellingFlow" type="xs:boolean"/>
<xs:element minOccurs="0" name="SurchargeApplicable" type="xs:boolean"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="ShippingCarrier" type="ns:ShippingCarrierCodeType"/>
<xs:element minOccurs="0" name="CODService" type="xs:boolean"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="DeprecationDetails" type="ns:AnnouncementMessageType"/>
<xs:element minOccurs="0" name="MappedToShippingServiceID" type="xs:int"/>
<xs:element minOccurs="0" name="CostGroupFlat" type="xs:token"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="ShippingServicePackageDetails" type="ns:ShippingServicePackageDetailsType"/>
<xs:element minOccurs="0" name="WeightRequired" type="xs:boolean"/>
<xs:element minOccurs="0" name="DetailVersion" type="xs:string"/>
<xs:element minOccurs="0" name="UpdateTime" type="xs:dateTime"/>
<xs:element minOccurs="0" name="ShippingCategory" type="xs:token"/>
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
</xs:sequence>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 24/24)
ns:CODService
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:CODService>
   
Content: 
{ xs:boolean }
</ns:CODService>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CODService" type="xs:boolean"/>
ns:CostGroupFlat
Type:
xs:token, predefined, simple content
If returned, this is the shipping service group to which the shipping service belongs. Valid values are found in CostGroupFlatCodeType.
XML Representation Summary
<ns:CostGroupFlat>
   
Content: 
{ xs:token }
</ns:CostGroupFlat>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CostGroupFlat" type="xs:token"/>
ns:DeprecationDetails
Type:
ns:AnnouncementMessageType, complex content
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.
Component Diagram
XML Representation Summary
<ns:DeprecationDetails>
   
Content: 
ns:AnnouncementStartTime?, ns:EventTime?, ns:MessageType?, {any}*
</ns:DeprecationDetails>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="DeprecationDetails" type="ns:AnnouncementMessageType"/>
ns:Description
Type:
xs:string, predefined, simple content
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).
XML Representation Summary
<ns:Description>
   
Content: 
{ xs:string }
</ns:Description>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Description" type="xs:string"/>
ns:DetailVersion
Type:
xs:string, predefined, simple content
Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data.
XML Representation Summary
<ns:DetailVersion>
   
Content: 
{ xs:string }
</ns:DetailVersion>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="DetailVersion" type="xs:string"/>
ns:DimensionsRequired
Type:
xs:boolean, predefined, simple content
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'.
XML Representation Summary
<ns:DimensionsRequired>
   
Content: 
{ xs:boolean }
</ns:DimensionsRequired>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="DimensionsRequired" type="xs:boolean"/>
ns:ExpeditedService
Type:
xs:boolean, predefined, simple content
Indicates whether a domestic shipping service option is an expedited shipping service. This field is only returned under a ShippingServiceDetails if true. Expedited generally means that the shipment of the order can arrive at the buyer's location within one or two business days.
XML Representation Summary
<ns:ExpeditedService>
   
Content: 
{ xs:boolean }
</ns:ExpeditedService>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ExpeditedService" type="xs:boolean"/>
ns:InternationalService
Type:
xs:boolean, predefined, simple content
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).
XML Representation Summary
<ns:InternationalService>
   
Content: 
{ xs:boolean }
</ns:InternationalService>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="InternationalService" type="xs:boolean"/>
ns:MappedToShippingServiceID
Type:
xs:int, predefined, simple content
The ID of another shipping service that will be used when a shipping service is deprecated. See also DeprecationDetails.
XML Representation Summary
<ns:MappedToShippingServiceID>
   
Content: 
{ xs:int }
</ns:MappedToShippingServiceID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="MappedToShippingServiceID" type="xs:int"/>
ns:ServiceType
Type:
ns:ShippingTypeCodeType, simple content
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.
XML Representation Summary
<ns:ServiceType>
   
Content: 
{ enumeration of xs:token }
</ns:ServiceType>
Simple Content
Enumeration:
see details at ns:ShippingTypeCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="ServiceType" type="ns:ShippingTypeCodeType"/>
ns:ShippingCarrier
Type:
ns:ShippingCarrierCodeType, simple content
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.
XML Representation Summary
<ns:ShippingCarrier>
   
Content: 
{ enumeration of xs:token }
</ns:ShippingCarrier>
Simple Content
Enumeration:
see details at ns:ShippingCarrierCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="ShippingCarrier" type="ns:ShippingCarrierCodeType"/>
ns:ShippingCategory
Type:
xs:token, predefined, simple content
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).
XML Representation Summary
<ns:ShippingCategory>
   
Content: 
{ xs:token }
</ns:ShippingCategory>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShippingCategory" type="xs:token"/>
ns:ShippingPackage
Type:
ns:ShippingPackageCodeType, simple content
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.
XML Representation Summary
<ns:ShippingPackage>
   
Content: 
{ enumeration of xs:token }
</ns:ShippingPackage>
Simple Content
Enumeration:
see details at ns:ShippingPackageCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="ShippingPackage" type="ns:ShippingPackageCodeType"/>
ns:ShippingService
Type:
xs:token, predefined, simple content
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.
XML Representation Summary
<ns:ShippingService>
   
Content: 
{ xs:token }
</ns:ShippingService>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShippingService" type="xs:token"/>
ns:ShippingServiceCode
Type:
ns:ShippingServiceCodeType, simple content
For future use.
XML Representation Summary
<ns:ShippingServiceCode>
   
Content: 
{ enumeration of xs:token }
</ns:ShippingServiceCode>
Simple Content
Enumeration:
see details at ns:ShippingServiceCodeType
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShippingServiceCode" type="ns:ShippingServiceCodeType"/>
ns:ShippingServiceID
Type:
xs:int, predefined, simple content
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.
XML Representation Summary
<ns:ShippingServiceID>
   
Content: 
{ xs:int }
</ns:ShippingServiceID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShippingServiceID" type="xs:int"/>
ns:ShippingServicePackageDetails
Type:
ns:ShippingServicePackageDetailsType, complex content
Shipping Package level details for the enclosing shipping service, this complex type replaces the existing ShippingPackage type.
Component Diagram
XML Representation Summary
<ns:ShippingServicePackageDetails>
   
Content: 
ns:Name?, ns:DimensionsRequired?, {any}*
</ns:ShippingServicePackageDetails>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="ShippingServicePackageDetails" type="ns:ShippingServicePackageDetailsType"/>
ns:ShippingTimeMax
Type:
xs:int, predefined, simple content
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.
XML Representation Summary
<ns:ShippingTimeMax>
   
Content: 
{ xs:int }
</ns:ShippingTimeMax>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShippingTimeMax" type="xs:int"/>
ns:ShippingTimeMin
Type:
xs:int, predefined, simple content
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.
XML Representation Summary
<ns:ShippingTimeMin>
   
Content: 
{ xs:int }
</ns:ShippingTimeMin>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ShippingTimeMin" type="xs:int"/>
ns:SurchargeApplicable
Type:
xs:boolean, predefined, simple content
This field is only returned if 'true', and indicates that a shipping surcharge is applicable for this shipping service option.
XML Representation Summary
<ns:SurchargeApplicable>
   
Content: 
{ xs:boolean }
</ns:SurchargeApplicable>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="SurchargeApplicable" type="xs:boolean"/>
ns:UpdateTime
Type:
xs:dateTime, predefined, simple content
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.
XML Representation Summary
<ns:UpdateTime>
   
Content: 
{ xs:dateTime }
</ns:UpdateTime>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="UpdateTime" type="xs:dateTime"/>
ns:ValidForSellingFlow
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:ValidForSellingFlow>
   
Content: 
{ xs:boolean }
</ns:ValidForSellingFlow>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ValidForSellingFlow" type="xs:boolean"/>
ns:WeightRequired
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:WeightRequired>
   
Content: 
{ xs:boolean }
</ns:WeightRequired>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="WeightRequired" type="xs:boolean"/>
{any element from any namespace}
XML Source (see within schema source)
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.