eBay::API::XML::DataType::StoreType - eBay::API::XML::DataType::StoreType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::StoreType

DESCRIPTION

Top

The configuration of an eBay Store.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setCustomCategories()

Custom categories for the Store. Deprecated (input ignored) for SetStore with request version 449 or higher. Use SetStoreCategories with request verison 449 or higher to modify store category structures.

# Argument: 'ns:StoreCustomCategoryArrayType'

getCustomCategories()

  Calls: GetStore
  Returned: Always

# Returns: 'ns:StoreCustomCategoryArrayType'

setCustomHeader()

Custom header text for the Store.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'xs:string'

getCustomHeader()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'xs:string'

setCustomHeaderLayout()

Layout for the Store's custom header.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'ns:StoreCustomHeaderLayoutCodeType'

getCustomHeaderLayout()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'ns:StoreCustomHeaderLayoutCodeType'

setCustomListingHeader()

Custom listing header for the Store.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'ns:StoreCustomListingHeaderType'

getCustomListingHeader()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'ns:StoreCustomListingHeaderType'

setDescription()

Store description (300 characters maximum).

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'xs:string'

getDescription()

  Calls: GetStore
  Returned: Always

# Returns: 'xs:string'

setExportListings()

Specifies whether to export the Store listings to comparison shopping websites.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'xs:boolean'

isExportListings()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'xs:boolean'

setHeaderStyle()

Style for the Store header.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'ns:StoreHeaderStyleCodeType'

getHeaderStyle()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'ns:StoreHeaderStyleCodeType'

setHomePage()

Page to use as the Store's homepage (default is 0). To change the homepage, specify the PageID of one of the Store's custom pages.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'xs:long'

getHomePage()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'xs:long'

setItemListLayout()

The default layout type to use for the Store items.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'ns:StoreItemListLayoutCodeType'

getItemListLayout()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'ns:StoreItemListLayoutCodeType'

setItemListSortOrder()

The default sort order to use for the items for sale in the Store.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'ns:StoreItemListSortOrderCodeType'

getItemListSortOrder()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'ns:StoreItemListSortOrderCodeType'

setLastOpenedTime()

Indicates the time the store was last opened or reopened.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'xs:dateTime'

getLastOpenedTime()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'xs:dateTime'

Store logo.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'ns:StoreLogoType'

  Calls: GetStore
  Returned: Conditionally

# Returns: 'ns:StoreLogoType'

setMerchDisplay()

Specifies the chosen customization display scheme for this store's Merch Widgets. See MerchDisplayCodeType for specific values.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'ns:MerchDisplayCodeType'

getMerchDisplay()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'ns:MerchDisplayCodeType'

setName()

Name of the eBay Store. The name is shown at the top of the Store page.

MaxLength: 35

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'xs:string'

getName()

  Calls: GetStore
  Returned: Always

# Returns: 'xs:string'

setSubscriptionLevel()

Subscription level (tier) for the user's eBay Store.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'ns:StoreSubscriptionLevelCodeType'

getSubscriptionLevel()

  Calls: GetStore
  Returned: Always
  OnlyTheseValues: Anchor, Basic, Featured

# Returns: 'ns:StoreSubscriptionLevelCodeType'

setTheme()

Store theme.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'ns:StoreThemeType'

getTheme()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'ns:StoreThemeType'

setURL()

The complete URL of the user's Store. This field is only ever returned, and does not need to be explicitly set.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'xs:anyURI'

getURL()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'xs:anyURI'

setURLPath()

The URL path of the Store (58 characters maximum). Only if you are using Chinese characters in the Name property do you need to use this field, such as if you are opening a Store on the Taiwan site. The reason for this is that the URL path is normally derived from the Store name, but it cannot be derived from the name of the Store if it contains Chinese characters because URLs cannot contain Chinese characters.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'xs:string'

getURLPath()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'xs:string'

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

package eBay::API::XML::DataType::StoreType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. StoreType.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::StoreCustomCategoryArrayType;
use eBay::API::XML::DataType::StoreCustomListingHeaderType;
use eBay::API::XML::DataType::StoreLogoType;
use eBay::API::XML::DataType::StoreThemeType;
use eBay::API::XML::DataType::Enum::MerchDisplayCodeType;
use eBay::API::XML::DataType::Enum::StoreCustomHeaderLayoutCodeType;
use eBay::API::XML::DataType::Enum::StoreHeaderStyleCodeType;
use eBay::API::XML::DataType::Enum::StoreItemListLayoutCodeType;
use eBay::API::XML::DataType::Enum::StoreItemListSortOrderCodeType;
use eBay::API::XML::DataType::Enum::StoreSubscriptionLevelCodeType;


my @gaProperties = ( [ 'CustomCategories', 'ns:StoreCustomCategoryArrayType', ''
	     ,'eBay::API::XML::DataType::StoreCustomCategoryArrayType', '1' ]
	, [ 'CustomHeader', 'xs:string', '', '', '' ]
	, [ 'CustomHeaderLayout', 'ns:StoreCustomHeaderLayoutCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::StoreCustomHeaderLayoutCodeType', '' ]
	, [ 'CustomListingHeader', 'ns:StoreCustomListingHeaderType', ''
	     ,'eBay::API::XML::DataType::StoreCustomListingHeaderType', '1' ]
	, [ 'Description', 'xs:string', '', '', '' ]
	, [ 'ExportListings', 'xs:boolean', '', '', '' ]
	, [ 'HeaderStyle', 'ns:StoreHeaderStyleCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::StoreHeaderStyleCodeType', '' ]
	, [ 'HomePage', 'xs:long', '', '', '' ]
	, [ 'ItemListLayout', 'ns:StoreItemListLayoutCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::StoreItemListLayoutCodeType', '' ]
	, [ 'ItemListSortOrder', 'ns:StoreItemListSortOrderCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::StoreItemListSortOrderCodeType', '' ]
	, [ 'LastOpenedTime', 'xs:dateTime', '', '', '' ]
	, [ 'Logo', 'ns:StoreLogoType', ''
	     ,'eBay::API::XML::DataType::StoreLogoType', '1' ]
	, [ 'MerchDisplay', 'ns:MerchDisplayCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::MerchDisplayCodeType', '' ]
	, [ 'Name', 'xs:string', '', '', '' ]
	, [ 'SubscriptionLevel', 'ns:StoreSubscriptionLevelCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::StoreSubscriptionLevelCodeType', '' ]
	, [ 'Theme', 'ns:StoreThemeType', ''
	     ,'eBay::API::XML::DataType::StoreThemeType', '1' ]
	, [ 'URL', 'xs:anyURI', '', '', '' ]
	, [ 'URLPath', 'xs:string', '', '', '' ]
                    );
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 setCustomCategories {
  my $self = shift;
  $self->{'CustomCategories'} = shift
}


sub getCustomCategories {
  my $self = shift;
  return $self->_getDataTypeInstance( 'CustomCategories'
		,'eBay::API::XML::DataType::StoreCustomCategoryArrayType');
}



sub setCustomHeader {
  my $self = shift;
  $self->{'CustomHeader'} = shift
}


sub getCustomHeader {
  my $self = shift;
  return $self->{'CustomHeader'};
}



sub setCustomHeaderLayout {
  my $self = shift;
  $self->{'CustomHeaderLayout'} = shift
}


sub getCustomHeaderLayout {
  my $self = shift;
  return $self->{'CustomHeaderLayout'};
}



sub setCustomListingHeader {
  my $self = shift;
  $self->{'CustomListingHeader'} = shift
}


sub getCustomListingHeader {
  my $self = shift;
  return $self->_getDataTypeInstance( 'CustomListingHeader'
		,'eBay::API::XML::DataType::StoreCustomListingHeaderType');
}



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


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



sub setExportListings {
  my $self = shift;
  $self->{'ExportListings'} = shift
}


sub isExportListings {
  my $self = shift;
  return $self->{'ExportListings'};
}



sub setHeaderStyle {
  my $self = shift;
  $self->{'HeaderStyle'} = shift
}


sub getHeaderStyle {
  my $self = shift;
  return $self->{'HeaderStyle'};
}



sub setHomePage {
  my $self = shift;
  $self->{'HomePage'} = shift
}


sub getHomePage {
  my $self = shift;
  return $self->{'HomePage'};
}



sub setItemListLayout {
  my $self = shift;
  $self->{'ItemListLayout'} = shift
}


sub getItemListLayout {
  my $self = shift;
  return $self->{'ItemListLayout'};
}



sub setItemListSortOrder {
  my $self = shift;
  $self->{'ItemListSortOrder'} = shift
}


sub getItemListSortOrder {
  my $self = shift;
  return $self->{'ItemListSortOrder'};
}



sub setLastOpenedTime {
  my $self = shift;
  $self->{'LastOpenedTime'} = shift
}


sub getLastOpenedTime {
  my $self = shift;
  return $self->{'LastOpenedTime'};
}



sub setLogo {
  my $self = shift;
  $self->{'Logo'} = shift
}


sub getLogo {
  my $self = shift;
  return $self->_getDataTypeInstance( 'Logo'
		,'eBay::API::XML::DataType::StoreLogoType');
}



sub setMerchDisplay {
  my $self = shift;
  $self->{'MerchDisplay'} = shift
}


sub getMerchDisplay {
  my $self = shift;
  return $self->{'MerchDisplay'};
}



sub setName {
  my $self = shift;
  $self->{'Name'} = shift
}


sub getName {
  my $self = shift;
  return $self->{'Name'};
}



sub setSubscriptionLevel {
  my $self = shift;
  $self->{'SubscriptionLevel'} = shift
}


sub getSubscriptionLevel {
  my $self = shift;
  return $self->{'SubscriptionLevel'};
}



sub setTheme {
  my $self = shift;
  $self->{'Theme'} = shift
}


sub getTheme {
  my $self = shift;
  return $self->_getDataTypeInstance( 'Theme'
		,'eBay::API::XML::DataType::StoreThemeType');
}



sub setURL {
  my $self = shift;
  $self->{'URL'} = shift
}


sub getURL {
  my $self = shift;
  return $self->{'URL'};
}



sub setURLPath {
  my $self = shift;
  $self->{'URLPath'} = shift
}


sub getURLPath {
  my $self = shift;
  return $self->{'URLPath'};
}





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

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



1;