NAME
eBay::API::XML::DataType::ShippingServiceDetailsType
DESCRIPTION
Details about a specific shipping service.
SYNOPSIS
INHERITANCE
eBay::API::XML::DataType::ShippingServiceDetailsType inherits from the eBay::API::XML::BaseDataType class
Subroutines:
setCODService()
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.
# Argument: 'xs:boolean'
isCODService()
Calls: GeteBayDetails
Returned: Conditionally# Returns: 'xs:boolean'
setDeprecationDetails()
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.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DeprecatedShippingServices Title: Deprecated Shipping Services
# Argument: reference to an array of 'ns:AnnouncementMessageType'
getDeprecationDetails()
Calls: GeteBayDetails
Returned: Conditionally# Returns: reference to an array of 'ns:AnnouncementMessageType'
setDescription()
Full name of the shipping service for display purposes.
# Argument: 'xs:string'
getDescription()
Calls: GeteBayDetails
Returned: Conditionally# Returns: 'xs:string'
setDimensionsRequired()
True if this shipping service requires package dimensions.
# Argument: 'xs:boolean'
isDimensionsRequired()
Calls: GeteBayDetails
Returned: Conditionally# Returns: 'xs:boolean'
setExpeditedService()
Indicates whether the shipping service is an expedited shipping service. See Enabling Get It Fast. Whether the service is an expedited shipping service. Only returned for sites for which the Get It Fast feature is enabled and only if true.<br><br> Related fields:<br> Item.DispatchTimeMax and Item.GetItFast in AddItem
# Argument: 'xs:boolean'
isExpeditedService()
Calls: GeteBayDetails
Returned: Conditionally# Returns: 'xs:boolean'
setInternationalService()
Indicates whether the shipping service is an international shipping service, i.e. one that ships from to another country from the country of the specified site.<br><br> Related field: Item.ShippingDetails.InternationalShippingServiceOption in AddItem.
# Argument: 'xs:boolean'
isInternationalService()
Calls: GeteBayDetails
Returned: Conditionally# Returns: 'xs:boolean'
setMappedToShippingServiceID()
The ID of another shipping service that will be used when a shipping service is deprecated. See also DeprecationDetails.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DeprecatedShippingServices Title: Deprecated Shipping Services
# Argument: 'xs:int'
getMappedToShippingServiceID()
Calls: GeteBayDetails
Returned: Conditionally# Returns: 'xs:int'
setServiceType()
The types of shipping that this shipping service supports.
# Argument: reference to an array of 'ns:ShippingTypeCodeType'
getServiceType()
Calls: GeteBayDetails
Returned: Conditionally
OnlyTheseValues: Flat, Calculated# Returns: reference to an array of 'ns:ShippingTypeCodeType'
setShippingCarrier()
The kinds of carrier supported by this shipping service.
# Argument: reference to an array of 'ns:ShippingCarrierCodeType'
getShippingCarrier()
Calls: GeteBayDetails
Returned: Conditionally# Returns: reference to an array of 'ns:ShippingCarrierCodeType'
setShippingPackage()
The kinds of packages supported by this shipping service.
# Argument: reference to an array of 'ns:ShippingPackageCodeType'
getShippingPackage()
Calls: GeteBayDetails
Returned: Conditionally# Returns: reference to an array of 'ns:ShippingPackageCodeType'
setShippingService()
Value used for the shipping service. For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails.<br><br> Related fields:<br> Item.ShippingDetails.InternationalShippingServiceOption.ShippingService in AddItem<br> Item.ShippingDetails.ShippingServiceOptions.ShippingService in AddItem
# Argument: 'xs:token'
getShippingService()
Calls: GeteBayDetails
Returned: Conditionally# Returns: 'xs:token'
setShippingServiceCode()
For future use.
# Argument: 'ns:ShippingServiceCodeType'
getShippingServiceCode()
# Returns: 'ns:ShippingServiceCodeType'
setShippingServiceID()
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.
# Argument: 'xs:int'
getShippingServiceID()
Calls: GeteBayDetails
Returned: Conditionally# Returns: 'xs:int'
setShippingTimeMax()
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.
# Argument: 'xs:int'
getShippingTimeMax()
Calls: GeteBayDetails
Returned: Conditionally# Returns: 'xs:int'
setShippingTimeMin()
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.
# Argument: 'xs:int'
getShippingTimeMin()
Calls: GeteBayDetails
Returned: Conditionally# Returns: 'xs:int'
setSurchargeApplicable()
True if a surcharge applies for any region that this service ships to.
# Argument: 'xs:boolean'
isSurchargeApplicable()
Calls: GeteBayDetails
Returned: Conditionally# Returns: 'xs:boolean'
setValidForSellingFlow()
True if the shipping service is valid for the Sell Your Item flow.
# Argument: 'xs:boolean'
isValidForSellingFlow()
Calls: GeteBayDetails
Returned: Conditionally# Returns: 'xs:boolean'