ePages 7.38.0 - 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
getCallStatistics
getCallTypes
getCategories
getEbayEnvironment
getOAuthTokensByAuthCode
saveOAuthToken

checkEbayToken

Checks Authentication of an EbayEnvironment

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

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
$aEnvironmentIDs (ref.array.int)
list of ObjectIDs of EbayEnvironments
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

getOAuthTokensByAuthCode

fetch a token from eBay

Syntax
$self->getOAuthTokensByAuthCode( $AuthCode, 'US' );
Input
$AuthCode (string)
authentication code for fetching tokens
$EnvironmentAlias (string)
Identifier of an EbayEnvironment
Return
$result (ref hash)
result set (with token)

saveOAuthToken

fetch a token from eBay

Syntax
$self->saveOAuthToken( $hTokenInfo, 'US' );
Input
$hTokenInfo (ref hash)
tokens with info
$EnvironmentAlias (string)
Identifier of an EbayEnvironment