ePages 6.10 - DE_EPAGES/EbayProvider/API/Object/RemoteStore.pm

Package DE_EPAGES::EbayProvider::API::Object::RemoteStore

stub object for web service requests to store db

Functions

checkEbayToken
fetchToken
get
getCallStatistics
getCallTypes
getCategories
getEbayEnvironment
getSessionID
set
store
testConnection

checkEbayToken

Checks Authentication of an EbayEnvironment

Syntax
if ($self->checkEbayToken( 'US' )) {}
Input
$EnvironmentAlias (string)
Identifier of an EbayEnvironment
Return
$result (boolean)
successful?

fetchToken

fetch a token from ebay

Syntax
$self->fetchToken( $SessionID );
Input
$SessionID (string)
ebay session id
$EnvironmentAlias (string)
Identifier of an EbayEnvironment
Return
$result (hash)
result set (with token)

get

gets attributes of store

Syntax
$self->get( ['Name'], Language->id );
Input
$aNames (ref.array.string)
list of keys
$LanguageID (integer)
Language ID (otional)
Return
$hValues (ref.hash)
attribute name => value hash

getCallStatistics

Get the call statistics for the input args

Syntax
$self->getCallStatistics( $hArgs );
Input
$hArgs (ref.hash)
with following keys:
  • DateFrom - start date - datetime string
  • DateTo - end date - datetime string
  • Interval - interval of statistics periods - integer
  • IntervalType - type of interval (e.g. 'days', 'weeks') - string
  • EbayCallType - id of call type - integer
  • EbayEnvironment - id of ebayenvironment - integer
Return
$result (ref.array.hash)
array of results:
  • StartDate - start date of statistics period - datetime string
  • Count - result for this period - integer

getCallTypes

Get all Call Types

Syntax
$self->getCallTypes();
Return
$result (ref.array.hash)
array of CallTypeInfos

getCategories

Starts asynchronous category download for given environment

Syntax
$self->getCategories( $env->id );
Input
$EnvironmentID (string)
ObjectID of an EbayEnvironment
Return
$result (boolean)
request successful submitted?

getEbayEnvironment

Gets info for all ebay environments on the store

Syntax
$self->getEbayEnvironment();
Return
$aValues (ref.array.hash)
tleHash of each EbayEnvironment

getSessionID

get a sessionID from eBay

Syntax
$self->getSessionID( $RuName, 'US' );
Input
$RuName (string)
applications ru-name
$EnvironmentAlias (string)
Identifier of an EbayEnvironment
Return
$result (hash)
result set (with sessionID)

set

sets attributes of store

Syntax
$self->set( {'Key' => 'Value'}, Language->id );
Input
$hValues (ref.hash)
key-value pairs
$LanguageID (integer)
Language ID (otional)
Return
$hValues (ref.hash.string)
plain attributes

store

Returns the store database object

Syntax
$store = $self->store;
Return
$Store (object)
Store object

testConnection

Tests connection to eBay's API gateway

Syntax
if ($self->testConnection( 'US' )) {}
Input
$EnvironmentAlias (string)
Identifier of an EbayEnvironment
Return
$result (boolean)
successful?