eBay::API::XML::DataType::ShippingServiceDetailsType - eBay::API::XML::DataType::ShippingServiceDetailsType documentation

eBay-API documentation Contained in the eBay-API distribution.

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::ShippingServiceDetailsType

DESCRIPTION

Top

Details about a specific shipping service.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::DataType::ShippingServiceDetailsType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

Top

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'

eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::DataType::ShippingServiceDetailsType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. ShippingServiceDetailsType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  


use eBay::API::XML::BaseDataType;
our @ISA = ("eBay::API::XML::BaseDataType");

use eBay::API::XML::DataType::AnnouncementMessageType;
use eBay::API::XML::DataType::Enum::ShippingCarrierCodeType;
use eBay::API::XML::DataType::Enum::ShippingPackageCodeType;
use eBay::API::XML::DataType::Enum::ShippingServiceCodeType;
use eBay::API::XML::DataType::Enum::ShippingTypeCodeType;


my @gaProperties = ( [ 'CODService', 'xs:boolean', '', '', '' ]
	, [ 'DeprecationDetails', 'ns:AnnouncementMessageType', '1'
	     ,'eBay::API::XML::DataType::AnnouncementMessageType', '1' ]
	, [ 'Description', 'xs:string', '', '', '' ]
	, [ 'DimensionsRequired', 'xs:boolean', '', '', '' ]
	, [ 'ExpeditedService', 'xs:boolean', '', '', '' ]
	, [ 'InternationalService', 'xs:boolean', '', '', '' ]
	, [ 'MappedToShippingServiceID', 'xs:int', '', '', '' ]
	, [ 'ServiceType', 'ns:ShippingTypeCodeType', '1'
	     ,'eBay::API::XML::DataType::Enum::ShippingTypeCodeType', '' ]
	, [ 'ShippingCarrier', 'ns:ShippingCarrierCodeType', '1'
	     ,'eBay::API::XML::DataType::Enum::ShippingCarrierCodeType', '' ]
	, [ 'ShippingPackage', 'ns:ShippingPackageCodeType', '1'
	     ,'eBay::API::XML::DataType::Enum::ShippingPackageCodeType', '' ]
	, [ 'ShippingService', 'xs:token', '', '', '' ]
	, [ 'ShippingServiceCode', 'ns:ShippingServiceCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::ShippingServiceCodeType', '' ]
	, [ 'ShippingServiceID', 'xs:int', '', '', '' ]
	, [ 'ShippingTimeMax', 'xs:int', '', '', '' ]
	, [ 'ShippingTimeMin', 'xs:int', '', '', '' ]
	, [ 'SurchargeApplicable', 'xs:boolean', '', '', '' ]
	, [ 'ValidForSellingFlow', 'xs:boolean', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};


sub new {
  my $classname = shift;
  my %args = @_;
  my $self = $classname->SUPER::new(%args);
  return $self;
}

sub isScalar {
   return 0; 
}




sub setCODService {
  my $self = shift;
  $self->{'CODService'} = shift
}


sub isCODService {
  my $self = shift;
  return $self->{'CODService'};
}



sub setDeprecationDetails {
  my $self = shift;
  $self->{'DeprecationDetails'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


sub getDeprecationDetails {
  my $self = shift;
  return $self->_getDataTypeArray('DeprecationDetails');
}



sub setDescription {
  my $self = shift;
  $self->{'Description'} = shift
}


sub getDescription {
  my $self = shift;
  return $self->{'Description'};
}



sub setDimensionsRequired {
  my $self = shift;
  $self->{'DimensionsRequired'} = shift
}


sub isDimensionsRequired {
  my $self = shift;
  return $self->{'DimensionsRequired'};
}



sub setExpeditedService {
  my $self = shift;
  $self->{'ExpeditedService'} = shift
}


sub isExpeditedService {
  my $self = shift;
  return $self->{'ExpeditedService'};
}



sub setInternationalService {
  my $self = shift;
  $self->{'InternationalService'} = shift
}


sub isInternationalService {
  my $self = shift;
  return $self->{'InternationalService'};
}



sub setMappedToShippingServiceID {
  my $self = shift;
  $self->{'MappedToShippingServiceID'} = shift
}


sub getMappedToShippingServiceID {
  my $self = shift;
  return $self->{'MappedToShippingServiceID'};
}



sub setServiceType {
  my $self = shift;
  $self->{'ServiceType'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


sub getServiceType {
  my $self = shift;
  return $self->_getDataTypeArray('ServiceType');
}



sub setShippingCarrier {
  my $self = shift;
  $self->{'ShippingCarrier'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


sub getShippingCarrier {
  my $self = shift;
  return $self->_getDataTypeArray('ShippingCarrier');
}



sub setShippingPackage {
  my $self = shift;
  $self->{'ShippingPackage'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


sub getShippingPackage {
  my $self = shift;
  return $self->_getDataTypeArray('ShippingPackage');
}



sub setShippingService {
  my $self = shift;
  $self->{'ShippingService'} = shift
}


sub getShippingService {
  my $self = shift;
  return $self->{'ShippingService'};
}



sub setShippingServiceCode {
  my $self = shift;
  $self->{'ShippingServiceCode'} = shift
}


sub getShippingServiceCode {
  my $self = shift;
  return $self->{'ShippingServiceCode'};
}



sub setShippingServiceID {
  my $self = shift;
  $self->{'ShippingServiceID'} = shift
}


sub getShippingServiceID {
  my $self = shift;
  return $self->{'ShippingServiceID'};
}



sub setShippingTimeMax {
  my $self = shift;
  $self->{'ShippingTimeMax'} = shift
}


sub getShippingTimeMax {
  my $self = shift;
  return $self->{'ShippingTimeMax'};
}



sub setShippingTimeMin {
  my $self = shift;
  $self->{'ShippingTimeMin'} = shift
}


sub getShippingTimeMin {
  my $self = shift;
  return $self->{'ShippingTimeMin'};
}



sub setSurchargeApplicable {
  my $self = shift;
  $self->{'SurchargeApplicable'} = shift
}


sub isSurchargeApplicable {
  my $self = shift;
  return $self->{'SurchargeApplicable'};
}



sub setValidForSellingFlow {
  my $self = shift;
  $self->{'ValidForSellingFlow'} = shift
}


sub isValidForSellingFlow {
  my $self = shift;
  return $self->{'ValidForSellingFlow'};
}





##  Attribute and Property lists
sub getPropertiesList {
   my $self = shift;
   return \@gaProperties;
}

sub getAttributesList {
   my $self = shift;
   return \@gaAttributes;
}



1;