/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::StoreVacationPreferencesType

NAME

eBay::API::XML::DataType::StoreVacationPreferencesType

DESCRIPTION

Specifies a set of Store vacation preferences.

SYNOPSIS

INHERITANCE

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

Subroutines:

setDisplayMessageStoreCustomText()

Display custom message on the Store pages instead of the default message.

MaxLength: 10000

Calls: SetStorePreferences
RequiredInput: No

# Argument: 'xs:boolean'

isDisplayMessageStoreCustomText()

Calls: GetStorePreferences
Returned: Always

# Returns: 'xs:boolean'

setHideFixedPriceStoreItems()

Hide Store Inventory format items when the Store owner is on vacation.<br><br> When OnVacation is true, the Store owner's listings do not appear on Express, regardless of the listing format and regardless of how the seller has configured their vacation settings for items that appear on eBay.

Calls: SetStorePreferences
RequiredInput: No

# Argument: 'xs:boolean'

isHideFixedPriceStoreItems()

Calls: GetStorePreferences
Returned: Always

# Returns: 'xs:boolean'

setMessageItem()

Add a message when the Store owner is on vacation to all their active items.

Calls: SetStorePreferences
RequiredInput: No

# Argument: 'xs:boolean'

isMessageItem()

Calls: GetStorePreferences
Returned: Always

# Returns: 'xs:boolean'

setMessageStore()

Add a message to all the Store pages when the Store owner is on vacation.

Calls: SetStorePreferences
RequiredInput: No

# Argument: 'xs:boolean'

isMessageStore()

Calls: GetStorePreferences
Returned: Always

# Returns: 'xs:boolean'

setMessageStoreCustomText()

The custom message to display for the Store when the user is on vacation. May contain HTML markup.

Calls: SetStorePreferences
RequiredInput: No

# Argument: 'xs:string'

getMessageStoreCustomText()

Calls: GetStorePreferences
Returned: Conditionally

# Returns: 'xs:string'

setOnVacation()

Specifies whether the Store owner is on vacation.<br> When OnVacation is true, the Store owner's listings do not appear on Express, regardless of the listing format and regardless of how the seller has configured their vacation settings for items that appear on eBay.

Calls: SetStorePreferences
RequiredInput: No

# Argument: 'xs:boolean'

isOnVacation()

Calls: GetStorePreferences
Returned: Always

# Returns: 'xs:boolean'

setReturnDate()

Seller return date from vacation.

Calls: SetStorePreferences
RequiredInput: No

# Argument: 'xs:dateTime'

getReturnDate()

Calls: GetStorePreferences
Returned: Conditionally

# Returns: 'xs:dateTime'