eBay::API::XML::DataType::ShipmentType - eBay::API::XML::DataType::ShipmentType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::ShipmentType

DESCRIPTION

Top

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setDeliveryDate()

Revise only

# Argument: 'xs:dateTime'

getDeliveryDate()

# Returns: 'xs:dateTime'

setDeliveryStatus()

Revise only

# Argument: 'ns:ShipmentDeliveryStatusCodeType'

getDeliveryStatus()

# Returns: 'ns:ShipmentDeliveryStatusCodeType'

setEstimatedDeliveryDate()

# Argument: 'xs:dateTime'

getEstimatedDeliveryDate()

# Returns: 'xs:dateTime'

setInsuredValue()

# Argument: 'ns:AmountType'

getInsuredValue()

# Returns: 'ns:AmountType'

setItemTransactionID()

# Argument: reference to an array of 'ns:ItemTransactionIDType'

getItemTransactionID()

# Returns: reference to an array of 'ns:ItemTransactionIDType'

setPackageDepth()

Depth dimension of the package needed to ship the item after it is sold. For calculated shipping only.

# Argument: 'ns:MeasureType'

getPackageDepth()

# Returns: 'ns:MeasureType'

setPackageLength()

Length dimension of the package needed to ship the item after it is sold. For calculated shipping only.

# Argument: 'ns:MeasureType'

getPackageLength()

# Returns: 'ns:MeasureType'

setPackageWidth()

Width dimension of the package needed to ship the item after it is sold. For calculated shipping only.

# Argument: 'ns:MeasureType'

getPackageWidth()

# Returns: 'ns:MeasureType'

setPayPalShipmentID()

# Argument: 'xs:string'

getPayPalShipmentID()

# Returns: 'xs:string'

setPostageTotal()

# Argument: 'ns:AmountType'

getPostageTotal()

# Returns: 'ns:AmountType'

setPrintedTime()

# Argument: 'xs:dateTime'

getPrintedTime()

# Returns: 'xs:dateTime'

setRefundGrantedTime()

Revise only

# Argument: 'xs:dateTime'

getRefundGrantedTime()

# Returns: 'xs:dateTime'

setRefundRequestedTime()

Revise only

# Argument: 'xs:dateTime'

getRefundRequestedTime()

# Returns: 'xs:dateTime'

setShipFromAddress()

The address from which the item is being shipped.

# Argument: 'ns:AddressType'

getShipFromAddress()

# Returns: 'ns:AddressType'

setShipmentID()

# Argument: 'xs:long'

getShipmentID()

# Returns: 'xs:long'

setShipmentTrackingNumber()

The tracking number associated with the shipment. The format of the shipment tracking number must be consistent with the specified ShippingCarrierUsed.

  Calls: CompleteSale
  RequiredInput: No

# Argument: 'xs:string'

getShipmentTrackingNumber()

# Returns: 'xs:string'

setShippingAddress()

The address to which the item is to be shipped.

# Argument: 'ns:AddressType'

getShippingAddress()

# Returns: 'ns:AddressType'

setShippingCarrierUsed()

The shipping carrier used.

  Calls: CompleteSale
  RequiredInput: No
  OnlyTheseValues: USPS, UPS

# Argument: 'ns:ShippingCarrierCodeType'

getShippingCarrierUsed()

# Returns: 'ns:ShippingCarrierCodeType'

setShippingFeature()

# Argument: reference to an array of 'ns:ShippingFeatureCodeType'

getShippingFeature()

# Returns: reference to an array of 'ns:ShippingFeatureCodeType'

setShippingPackage()

The size of the package used to ship the item(s). See ShippingPackageCodeType for its possible values. Input.

# Argument: 'ns:ShippingPackageCodeType'

getShippingPackage()

# Returns: 'ns:ShippingPackageCodeType'

setShippingServiceUsed()

The size of the package used to ship the item(s). See ShippingPackageCodeType for its possible values. Input.

# Argument: 'xs:token'

getShippingServiceUsed()

# Returns: 'xs:token'

setStatus()

Status, for revise only

# Argument: 'ns:ShipmentStatusCodeType'

getStatus()

# Returns: 'ns:ShipmentStatusCodeType'

setWeightMajor()

See the documentation regarding "Working with Item Weights". The 'unit' attribute can have a value of lbs.

# Argument: 'ns:MeasureType'

getWeightMajor()

# Returns: 'ns:MeasureType'

setWeightMinor()

See the documentation regarding "Working with Item Weights". The 'unit' attribute is optional and assumed to be the minor compared to the value of 'unit' in WeightMajor.

# Argument: 'ns:MeasureType'

getWeightMinor()

# Returns: 'ns:MeasureType'

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

package eBay::API::XML::DataType::ShipmentType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. ShipmentType.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::AddressType;
use eBay::API::XML::DataType::AmountType;
use eBay::API::XML::DataType::ItemTransactionIDType;
use eBay::API::XML::DataType::MeasureType;
use eBay::API::XML::DataType::Enum::ShipmentDeliveryStatusCodeType;
use eBay::API::XML::DataType::Enum::ShipmentStatusCodeType;
use eBay::API::XML::DataType::Enum::ShippingCarrierCodeType;
use eBay::API::XML::DataType::Enum::ShippingFeatureCodeType;
use eBay::API::XML::DataType::Enum::ShippingPackageCodeType;


my @gaProperties = ( [ 'DeliveryDate', 'xs:dateTime', '', '', '' ]
	, [ 'DeliveryStatus', 'ns:ShipmentDeliveryStatusCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::ShipmentDeliveryStatusCodeType', '' ]
	, [ 'EstimatedDeliveryDate', 'xs:dateTime', '', '', '' ]
	, [ 'InsuredValue', 'ns:AmountType', ''
	     ,'eBay::API::XML::DataType::AmountType', '1' ]
	, [ 'ItemTransactionID', 'ns:ItemTransactionIDType', '1'
	     ,'eBay::API::XML::DataType::ItemTransactionIDType', '1' ]
	, [ 'PackageDepth', 'ns:MeasureType', ''
	     ,'eBay::API::XML::DataType::MeasureType', '1' ]
	, [ 'PackageLength', 'ns:MeasureType', ''
	     ,'eBay::API::XML::DataType::MeasureType', '1' ]
	, [ 'PackageWidth', 'ns:MeasureType', ''
	     ,'eBay::API::XML::DataType::MeasureType', '1' ]
	, [ 'PayPalShipmentID', 'xs:string', '', '', '' ]
	, [ 'PostageTotal', 'ns:AmountType', ''
	     ,'eBay::API::XML::DataType::AmountType', '1' ]
	, [ 'PrintedTime', 'xs:dateTime', '', '', '' ]
	, [ 'RefundGrantedTime', 'xs:dateTime', '', '', '' ]
	, [ 'RefundRequestedTime', 'xs:dateTime', '', '', '' ]
	, [ 'ShipFromAddress', 'ns:AddressType', ''
	     ,'eBay::API::XML::DataType::AddressType', '1' ]
	, [ 'ShipmentID', 'xs:long', '', '', '' ]
	, [ 'ShipmentTrackingNumber', 'xs:string', '', '', '' ]
	, [ 'ShippingAddress', 'ns:AddressType', ''
	     ,'eBay::API::XML::DataType::AddressType', '1' ]
	, [ 'ShippingCarrierUsed', 'ns:ShippingCarrierCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::ShippingCarrierCodeType', '' ]
	, [ 'ShippingFeature', 'ns:ShippingFeatureCodeType', '1'
	     ,'eBay::API::XML::DataType::Enum::ShippingFeatureCodeType', '' ]
	, [ 'ShippingPackage', 'ns:ShippingPackageCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::ShippingPackageCodeType', '' ]
	, [ 'ShippingServiceUsed', 'xs:token', '', '', '' ]
	, [ 'Status', 'ns:ShipmentStatusCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::ShipmentStatusCodeType', '' ]
	, [ 'WeightMajor', 'ns:MeasureType', ''
	     ,'eBay::API::XML::DataType::MeasureType', '1' ]
	, [ 'WeightMinor', 'ns:MeasureType', ''
	     ,'eBay::API::XML::DataType::MeasureType', '1' ]
                    );
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 setDeliveryDate {
  my $self = shift;
  $self->{'DeliveryDate'} = shift
}


sub getDeliveryDate {
  my $self = shift;
  return $self->{'DeliveryDate'};
}



sub setDeliveryStatus {
  my $self = shift;
  $self->{'DeliveryStatus'} = shift
}


sub getDeliveryStatus {
  my $self = shift;
  return $self->{'DeliveryStatus'};
}



sub setEstimatedDeliveryDate {
  my $self = shift;
  $self->{'EstimatedDeliveryDate'} = shift
}


sub getEstimatedDeliveryDate {
  my $self = shift;
  return $self->{'EstimatedDeliveryDate'};
}



sub setInsuredValue {
  my $self = shift;
  $self->{'InsuredValue'} = shift
}


sub getInsuredValue {
  my $self = shift;
  return $self->_getDataTypeInstance( 'InsuredValue'
		,'eBay::API::XML::DataType::AmountType');
}



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


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



sub setPackageDepth {
  my $self = shift;
  $self->{'PackageDepth'} = shift
}


sub getPackageDepth {
  my $self = shift;
  return $self->_getDataTypeInstance( 'PackageDepth'
		,'eBay::API::XML::DataType::MeasureType');
}



sub setPackageLength {
  my $self = shift;
  $self->{'PackageLength'} = shift
}


sub getPackageLength {
  my $self = shift;
  return $self->_getDataTypeInstance( 'PackageLength'
		,'eBay::API::XML::DataType::MeasureType');
}



sub setPackageWidth {
  my $self = shift;
  $self->{'PackageWidth'} = shift
}


sub getPackageWidth {
  my $self = shift;
  return $self->_getDataTypeInstance( 'PackageWidth'
		,'eBay::API::XML::DataType::MeasureType');
}



sub setPayPalShipmentID {
  my $self = shift;
  $self->{'PayPalShipmentID'} = shift
}


sub getPayPalShipmentID {
  my $self = shift;
  return $self->{'PayPalShipmentID'};
}



sub setPostageTotal {
  my $self = shift;
  $self->{'PostageTotal'} = shift
}


sub getPostageTotal {
  my $self = shift;
  return $self->_getDataTypeInstance( 'PostageTotal'
		,'eBay::API::XML::DataType::AmountType');
}



sub setPrintedTime {
  my $self = shift;
  $self->{'PrintedTime'} = shift
}


sub getPrintedTime {
  my $self = shift;
  return $self->{'PrintedTime'};
}



sub setRefundGrantedTime {
  my $self = shift;
  $self->{'RefundGrantedTime'} = shift
}


sub getRefundGrantedTime {
  my $self = shift;
  return $self->{'RefundGrantedTime'};
}



sub setRefundRequestedTime {
  my $self = shift;
  $self->{'RefundRequestedTime'} = shift
}


sub getRefundRequestedTime {
  my $self = shift;
  return $self->{'RefundRequestedTime'};
}



sub setShipFromAddress {
  my $self = shift;
  $self->{'ShipFromAddress'} = shift
}


sub getShipFromAddress {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ShipFromAddress'
		,'eBay::API::XML::DataType::AddressType');
}



sub setShipmentID {
  my $self = shift;
  $self->{'ShipmentID'} = shift
}


sub getShipmentID {
  my $self = shift;
  return $self->{'ShipmentID'};
}



sub setShipmentTrackingNumber {
  my $self = shift;
  $self->{'ShipmentTrackingNumber'} = shift
}


sub getShipmentTrackingNumber {
  my $self = shift;
  return $self->{'ShipmentTrackingNumber'};
}



sub setShippingAddress {
  my $self = shift;
  $self->{'ShippingAddress'} = shift
}


sub getShippingAddress {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ShippingAddress'
		,'eBay::API::XML::DataType::AddressType');
}



sub setShippingCarrierUsed {
  my $self = shift;
  $self->{'ShippingCarrierUsed'} = shift
}


sub getShippingCarrierUsed {
  my $self = shift;
  return $self->{'ShippingCarrierUsed'};
}



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


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



sub setShippingPackage {
  my $self = shift;
  $self->{'ShippingPackage'} = shift
}


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



sub setShippingServiceUsed {
  my $self = shift;
  $self->{'ShippingServiceUsed'} = shift
}


sub getShippingServiceUsed {
  my $self = shift;
  return $self->{'ShippingServiceUsed'};
}



sub setStatus {
  my $self = shift;
  $self->{'Status'} = shift
}


sub getStatus {
  my $self = shift;
  return $self->{'Status'};
}



sub setWeightMajor {
  my $self = shift;
  $self->{'WeightMajor'} = shift
}


sub getWeightMajor {
  my $self = shift;
  return $self->_getDataTypeInstance( 'WeightMajor'
		,'eBay::API::XML::DataType::MeasureType');
}



sub setWeightMinor {
  my $self = shift;
  $self->{'WeightMinor'} = shift
}


sub getWeightMinor {
  my $self = shift;
  return $self->_getDataTypeInstance( 'WeightMinor'
		,'eBay::API::XML::DataType::MeasureType');
}





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

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



1;