eBay::API::XML::DataType::CartType - eBay::API::XML::DataType::CartType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::CartType

DESCRIPTION

Top

Details about an eBay Express shopping cart.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setCartID()

The ID of the shopping cart.

Default: # Argument: 'xs:long'

getCartID()

  Calls: GetCart
         SetCart
  Returned: Always

# Returns: 'xs:long'

setCartItemArray()

Array of CartItem (details about items and what is to be done with each, such as add, delete, update). This is only returned if there are items in the cart.

# Argument: 'ns:CartItemArrayType'

getCartItemArray()

  Calls: GetCart
         SetCart
  Returned: Conditionally

# Returns: 'ns:CartItemArrayType'

setCartStatus()

Status of the eBay Express cart.

# Argument: 'ns:OrderStatusCodeType'

getCartStatus()

  Calls: GetCart
         SetCart
  Returned: Always
  OnlyTheseValues: 
								Active, Authenticated, Cancelled, Completed, InProcess, Inactive

# Returns: 'ns:OrderStatusCodeType'

setCheckoutCompleteRedirect()

When the user has completed eBay Express checkout with the shopping cart, the user is shown a link to your website. The values of this element were established via SetCart input.

# Argument: 'ns:CheckoutCompleteRedirectType'

getCheckoutCompleteRedirect()

  Calls: GetCart
         SetCart
  Returned: Conditionally

# Returns: 'ns:CheckoutCompleteRedirectType'

setCheckoutURL()

The eBay-specified URL to which the third party site should direct the user for checking out.

# Argument: 'xs:anyURI'

getCheckoutURL()

  Calls: GetCart
         SetCart
  Returned: Always

# Returns: 'xs:anyURI'

setCreationTime()

Cart creation date time.

# Argument: 'xs:dateTime'

getCreationTime()

  Calls: GetCart
         SetCart
  Returned: Always

# Returns: 'xs:dateTime'

setExpirationTime()

The time at which the cart will no longer exist in the eBay Express domain. This is currently 7 days after the CreationTime but may be changed by eBay in the future.

# Argument: 'xs:dateTime'

getExpirationTime()

  Calls: GetCart
         SetCart
  Returned: Always

# Returns: 'xs:dateTime'

setOrderDetail()

Details of the order for the checked out cart. This container and its children are only returned if checkout was completed on eBay Express.

# Argument: 'ns:CheckoutOrderDetailType'

getOrderDetail()

  Calls: GetCart
         SetCart
  Returned: Conditionally

# Returns: 'ns:CheckoutOrderDetailType'

setShippingAddress()

The address to which the items in the cart are to be shipped. This is echoed from the ShippingAddress provided on input, if provided.

# Argument: 'ns:AddressType'

getShippingAddress()

  Calls: GetCart
         SetCart
  Returned: Conditionally

# Returns: 'ns:AddressType'

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

package eBay::API::XML::DataType::CartType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. CartType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 07/07/2008 17:42
# API Release Number: ... 571
#
##########################################################################  


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

use eBay::API::XML::DataType::AddressType;
use eBay::API::XML::DataType::CartItemArrayType;
use eBay::API::XML::DataType::CheckoutCompleteRedirectType;
use eBay::API::XML::DataType::CheckoutOrderDetailType;
use eBay::API::XML::DataType::Enum::OrderStatusCodeType;


my @gaProperties = ( [ 'CartID', 'xs:long', '', '', '' ]
	, [ 'CartItemArray', 'ns:CartItemArrayType', ''
	     ,'eBay::API::XML::DataType::CartItemArrayType', '1' ]
	, [ 'CartStatus', 'ns:OrderStatusCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::OrderStatusCodeType', '' ]
	, [ 'CheckoutCompleteRedirect', 'ns:CheckoutCompleteRedirectType', ''
	     ,'eBay::API::XML::DataType::CheckoutCompleteRedirectType', '1' ]
	, [ 'CheckoutURL', 'xs:anyURI', '', '', '' ]
	, [ 'CreationTime', 'xs:dateTime', '', '', '' ]
	, [ 'ExpirationTime', 'xs:dateTime', '', '', '' ]
	, [ 'OrderDetail', 'ns:CheckoutOrderDetailType', ''
	     ,'eBay::API::XML::DataType::CheckoutOrderDetailType', '1' ]
	, [ 'ShippingAddress', 'ns:AddressType', ''
	     ,'eBay::API::XML::DataType::AddressType', '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 setCartID {
  my $self = shift;
  $self->{'CartID'} = shift
}


sub getCartID {
  my $self = shift;
  return $self->{'CartID'};
}



sub setCartItemArray {
  my $self = shift;
  $self->{'CartItemArray'} = shift
}


sub getCartItemArray {
  my $self = shift;
  return $self->_getDataTypeInstance( 'CartItemArray'
		,'eBay::API::XML::DataType::CartItemArrayType');
}



sub setCartStatus {
  my $self = shift;
  $self->{'CartStatus'} = shift
}


sub getCartStatus {
  my $self = shift;
  return $self->{'CartStatus'};
}



sub setCheckoutCompleteRedirect {
  my $self = shift;
  $self->{'CheckoutCompleteRedirect'} = shift
}


sub getCheckoutCompleteRedirect {
  my $self = shift;
  return $self->_getDataTypeInstance( 'CheckoutCompleteRedirect'
		,'eBay::API::XML::DataType::CheckoutCompleteRedirectType');
}



sub setCheckoutURL {
  my $self = shift;
  $self->{'CheckoutURL'} = shift
}


sub getCheckoutURL {
  my $self = shift;
  return $self->{'CheckoutURL'};
}



sub setCreationTime {
  my $self = shift;
  $self->{'CreationTime'} = shift
}


sub getCreationTime {
  my $self = shift;
  return $self->{'CreationTime'};
}



sub setExpirationTime {
  my $self = shift;
  $self->{'ExpirationTime'} = shift
}


sub getExpirationTime {
  my $self = shift;
  return $self->{'ExpirationTime'};
}



sub setOrderDetail {
  my $self = shift;
  $self->{'OrderDetail'} = shift
}


sub getOrderDetail {
  my $self = shift;
  return $self->_getDataTypeInstance( 'OrderDetail'
		,'eBay::API::XML::DataType::CheckoutOrderDetailType');
}



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


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





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

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



1;