eBay::API::XML::Call::SetShippingDiscountProfiles::SetShippingDiscountProfilesRequestType - eBay::API::XML::Call::SetShippingDiscountProfiles::SetShippingDiscountProfilesRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::SetShippingDiscountProfiles::SetShippingDiscountProfilesRequestType

DESCRIPTION

Top

Enables a seller to define shipping cost discount profiles and a few additional parameters related to combined payment, such as shipping insurance and packaging handling costs.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::SetShippingDiscountProfiles::SetShippingDiscountProfilesRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setCalculatedHandlingDiscount()

The data for the specific packaging/handling cost details for combined payment.

  RequiredInput: No
#    Argument: 'ns:CalculatedHandlingDiscountType'

getCalculatedHandlingDiscount()

# Returns: 'ns:CalculatedHandlingDiscountType'

setCalculatedShippingDiscount()

Details of a shipping cost discount profile for calculated shipping. If this is provided, FlatShippingDiscount and PromotionalShippingDiscountDetails should be omitted.

  RequiredInput: No
#    Argument: 'ns:CalculatedShippingDiscountType'

getCalculatedShippingDiscount()

# Returns: 'ns:CalculatedShippingDiscountType'

setCombinedDuration()

Only those items purchased within CombinedDuration days of each other can be combined into an order and benefit from any shipping discounts.

  RequiredInput: Yes
#    Argument: 'ns:CombinedPaymentPeriodCodeType'

getCombinedDuration()

# Returns: 'ns:CombinedPaymentPeriodCodeType'

setCurrencyID()

The ID of the currency to be used for shipping cost discounts and insurance for combined payment. A discount profile can only be associated with a listing if the currency ID of the profile matches the currency ID of the listing. Required if the user creates flat rate shipping discount profiles, a promotional discount, a packaging/handling cost profile based on a variable discount rule, or if the user defines shipping insurance range/fee pairs. <br><br> Note: There is a currencyID attribute on many elements of SetShippingDiscountProfiles. To avoid an error, be sure to use the same value of CurrencyCodeType in each occurrence within the same request.

  RequiredInput: Conditionally
#    Argument: 'ns:CurrencyCodeType'

getCurrencyID()

# Returns: 'ns:CurrencyCodeType'

setFlatShippingDiscount()

Details of a shipping cost discount profile for flat rate shipping. If this is provided, CalculatedShippingDiscount and PromotionalShippingDiscountDetails should be omitted.

  RequiredInput: No
#    Argument: 'ns:FlatShippingDiscountType'

getFlatShippingDiscount()

# Returns: 'ns:FlatShippingDiscountType'

setInternationalShippingInsurance()

Information establishing what fee to apply for international shipping insurance for combined payment depending on which range the order item- total price falls into.

  RequiredInput: No
#    Argument: 'ns:ShippingInsuranceType'

getInternationalShippingInsurance()

# Returns: 'ns:ShippingInsuranceType'

setModifyActionCode()

Indicates what action to take on the specified flat shipping discount, calculated shipping discount or promotional discount. If the action is Delete and if a flat rate or calculated shipping discount profile is specified, the discount profile identified by DiscountProfile.DiscountProfileID is deleted (see DiscountProfile.MappedDiscountProfileID for related details).

  RequiredInput: Yes
#    Argument: 'ns:ModifyActionCodeType'

getModifyActionCode()

# Returns: 'ns:ModifyActionCodeType'

setPromotionalShippingDiscountDetails()

The data for the promotional shipping discount. If this is provided, FlatShippingDiscount and CalculatedShippingDiscount should be omitted.

  RequiredInput: No
#    Argument: 'ns:PromotionalShippingDiscountDetailsType'

getPromotionalShippingDiscountDetails()

# Returns: 'ns:PromotionalShippingDiscountDetailsType'

setShippingInsurance()

Information establishing what fee to apply for domestic shipping insurance for combined payment depending on which range the order item-total price falls into.

  RequiredInput: No
#    Argument: 'ns:ShippingInsuranceType'

getShippingInsurance()

# Returns: 'ns:ShippingInsuranceType'

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

package eBay::API::XML::Call::SetShippingDiscountProfiles::SetShippingDiscountProfilesRequestType;

use strict;
use warnings;  

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


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

use eBay::API::XML::DataType::CalculatedHandlingDiscountType;
use eBay::API::XML::DataType::CalculatedShippingDiscountType;
use eBay::API::XML::DataType::FlatShippingDiscountType;
use eBay::API::XML::DataType::PromotionalShippingDiscountDetailsType;
use eBay::API::XML::DataType::ShippingInsuranceType;
use eBay::API::XML::DataType::Enum::CombinedPaymentPeriodCodeType;
use eBay::API::XML::DataType::Enum::CurrencyCodeType;
use eBay::API::XML::DataType::Enum::ModifyActionCodeType;


my @gaProperties = ( [ 'CalculatedHandlingDiscount', 'ns:CalculatedHandlingDiscountType', ''
	     ,'eBay::API::XML::DataType::CalculatedHandlingDiscountType', '1' ]
	, [ 'CalculatedShippingDiscount', 'ns:CalculatedShippingDiscountType', ''
	     ,'eBay::API::XML::DataType::CalculatedShippingDiscountType', '1' ]
	, [ 'CombinedDuration', 'ns:CombinedPaymentPeriodCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::CombinedPaymentPeriodCodeType', '' ]
	, [ 'CurrencyID', 'ns:CurrencyCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::CurrencyCodeType', '' ]
	, [ 'FlatShippingDiscount', 'ns:FlatShippingDiscountType', ''
	     ,'eBay::API::XML::DataType::FlatShippingDiscountType', '1' ]
	, [ 'InternationalShippingInsurance', 'ns:ShippingInsuranceType', ''
	     ,'eBay::API::XML::DataType::ShippingInsuranceType', '1' ]
	, [ 'ModifyActionCode', 'ns:ModifyActionCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::ModifyActionCodeType', '' ]
	, [ 'PromotionalShippingDiscountDetails', 'ns:PromotionalShippingDiscountDetailsType', ''
	     ,'eBay::API::XML::DataType::PromotionalShippingDiscountDetailsType', '1' ]
	, [ 'ShippingInsurance', 'ns:ShippingInsuranceType', ''
	     ,'eBay::API::XML::DataType::ShippingInsuranceType', '1' ]
                    );
push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()};

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


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

sub isScalar {
   return 0; 
}




sub setCalculatedHandlingDiscount {
  my $self = shift;
  $self->{'CalculatedHandlingDiscount'} = shift
}


sub getCalculatedHandlingDiscount {
  my $self = shift;
  return $self->_getDataTypeInstance( 'CalculatedHandlingDiscount'
		,'eBay::API::XML::DataType::CalculatedHandlingDiscountType');
}



sub setCalculatedShippingDiscount {
  my $self = shift;
  $self->{'CalculatedShippingDiscount'} = shift
}


sub getCalculatedShippingDiscount {
  my $self = shift;
  return $self->_getDataTypeInstance( 'CalculatedShippingDiscount'
		,'eBay::API::XML::DataType::CalculatedShippingDiscountType');
}



sub setCombinedDuration {
  my $self = shift;
  $self->{'CombinedDuration'} = shift
}


sub getCombinedDuration {
  my $self = shift;
  return $self->{'CombinedDuration'};
}



sub setCurrencyID {
  my $self = shift;
  $self->{'CurrencyID'} = shift
}


sub getCurrencyID {
  my $self = shift;
  return $self->{'CurrencyID'};
}



sub setFlatShippingDiscount {
  my $self = shift;
  $self->{'FlatShippingDiscount'} = shift
}


sub getFlatShippingDiscount {
  my $self = shift;
  return $self->_getDataTypeInstance( 'FlatShippingDiscount'
		,'eBay::API::XML::DataType::FlatShippingDiscountType');
}



sub setInternationalShippingInsurance {
  my $self = shift;
  $self->{'InternationalShippingInsurance'} = shift
}


sub getInternationalShippingInsurance {
  my $self = shift;
  return $self->_getDataTypeInstance( 'InternationalShippingInsurance'
		,'eBay::API::XML::DataType::ShippingInsuranceType');
}



sub setModifyActionCode {
  my $self = shift;
  $self->{'ModifyActionCode'} = shift
}


sub getModifyActionCode {
  my $self = shift;
  return $self->{'ModifyActionCode'};
}



sub setPromotionalShippingDiscountDetails {
  my $self = shift;
  $self->{'PromotionalShippingDiscountDetails'} = shift
}


sub getPromotionalShippingDiscountDetails {
  my $self = shift;
  return $self->_getDataTypeInstance( 'PromotionalShippingDiscountDetails'
		,'eBay::API::XML::DataType::PromotionalShippingDiscountDetailsType');
}



sub setShippingInsurance {
  my $self = shift;
  $self->{'ShippingInsurance'} = shift
}


sub getShippingInsurance {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ShippingInsurance'
		,'eBay::API::XML::DataType::ShippingInsuranceType');
}





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

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



1;