ePages 6.10 - DE_EPAGES/Ebay/API/WebService/EbayConfigService.pm

Package DE_EPAGES::Ebay::API::WebService::EbayConfigService

web service module for configuring ebay cartridge on a store db

Functions

checkEbayToken
fetchToken
getCallStatistics
getCallTypes
getCategories
getEbayEnvironment
getSessionID
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, 'US' );
Input
$SessionID (string)
applications ru-name
$EnvironmentAlias (string)
Identifier of an EbayEnvironment
Return
$result (ref hash)
result set (with token)

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
$ebayconfigservice->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 (ref hash)
result set (with sessionID)

testConnection

Tests connection to eBay via a getSessionID call.

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