The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::StoreType

NAME

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

DESCRIPTION

The configuration of an eBay Store.

SYNOPSIS

INHERITANCE

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

Subroutines:

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'

setLogo()

Store logo.

Calls: SetStore
RequiredInput: Conditionally

# Argument: 'ns:StoreLogoType'

getLogo()

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'