ePages 6.10 - DE_EPAGES/Ebay/API/Object/RemoteEbay.pm

Package DE_EPAGES::Ebay::API::Object::RemoteEbay

stub object for web service requests to ebay

Functions

addItem
endItem
environment
fetchToken
getAllBidders
getAttributesCS
getCategories
getCategory2CS
getEbayDetails
getEbayNamespace
getEbayOfficialTime
getItem
getItemTransactions
getOrders
getSellerList
getSellerTransactions
getSessionID
getStore
getUser
leaveFeedback
relistFixedPriceItem
relistItem
reviseCheckoutStatus
shopEnvironment
store
useProvider
variableNamePrefix
verifyAddItem

addItem

upload auction to ebay

Syntax
$self->addItem($Auction);
Input
$Auction (EbayAuction object)
auction
Return
$result (ref.hash)
with following keys:
  • Timestamp - ebay timestamp - string
  • Ack - "Success" if successful - string
  • CorrelationID - ebay correlation id - string
  • Version - ebay api version - string
  • Build - ebay build no - string
  • ItemID - ebay item id of auction - string
  • StartTime - start of auction - string
  • EndTime - end of auction - string
  • Fee - array of fees - ref.array

endItem

ends an ebay item

Syntax
$self->endItem($externalAuctionId);
Input
$externalAuctionId (string)
auction id of item
Return
(0 on failure 1 on success.)
$Success

environment

Returns which eBay Environment should be used

Syntax
$store = $self->environment;
Return
$environment (Object)
ebay Environment (incl EbaySiteId)

fetchToken

get the Token

Syntax
$self->fetchToken($SessionID);
Input
$DoUpdate (boolean)
Update existing entry or add new entry
$SessionID (string)
ebay session id
Return
$result (ref.hash)
with following keys:
  • eBayAuthToken - ebay token - string
  • HardExpirationTime - exiration time - string

getAllBidders

get a all bidders from auction, for second offer change

Syntax
$self->getAllBidders($externalAuctionId);
Input
$externalAuctionId (string)
auction id of item
Return
$hBidders (ref.hash)
info of item

getAttributesCS

Retrieves attributes for a given AttributeSet If no AttributeSetID is given, all mappings are retrieved. (not usefull) If no AttributeSystemVersion is given, the changed mappings are retrieved, otherwise only mappings with version > AttributeSystemVersion are retrieved

Syntax
$self->getAttributesCS($AttributeSetID,AttributeSystemVersion);
Input
$AttributeSetID (int or ref.array)
eBay AttributeSetID Id (optional)
$AttributeSystemVersion (optional) (int)
A version of the mappings for the site.
Return
$result (ref.hash)
with following keys:
  • Timestamp - ebay timestamp - string
  • Ack - "Success" if successful - string
  • CorrelationID - ebay correlation id - string
  • Version - ebay api version - string
  • Build - ebay build no - string
  • AttributeSystemVersion - Current version of the mappings for the site. - string
  • AttributeData - xml attribute data string - string

getCategories

download categories

Syntax
$self->getCategories($DoCheckOnly, $LevelLimit, $ParentId);
Input
$DoCheckOnly (boolean)
flag, 0=only check for new version,
1=download cat. list
$LevelLimit (int)
restrict to tree depth
$ParentId (int)
eBay Category Id, only get childs of this category
Return
$result (ref.hash)
with following keys:
  • Timestamp - ebay timestamp - string
  • Ack - "Success" if successful - string
  • CorrelationID - ebay correlation id - string
  • Version - ebay api version - string
  • Build - ebay build no - string
  • CategoryVersion - version of category list - int
  • UpdateTime - last update of category list - string
  • CategoryCount - number of categories - int
  • Category - array of categories - ref.array

getCategory2CS

Retrieves mappings between categories and characteristics sets Retrieves all mappings or just those that match category IDs passed in the call If no CategoryID is given, all mappings are retrieved. If no AttributeSystemVersion is given, all mappings are retrieved, otherwise only mappings with version > AttributeSystemVersion are retrieved

Syntax
$self->getCategory2CS($CategoryID,AttributeSystemVersion);
Input
$CategoryID (int)
eBay Category Id (optional)
$AttributeSystemVersion (optional) (int)
A version of the mappings for the site.
Return
$result (ref.hash)
with following keys:
  • Timestamp - ebay timestamp - string
  • Ack - "Success" if successful - string
  • CorrelationID - ebay correlation id - string
  • Version - ebay api version - string
  • Build - ebay build no - string
  • AttributeSystemVersion - Current version of the mappings for the site. - string
  • Category - array of return url entries - ref.array
  • SiteWideCharacteristicSets - array of return url entries - ref.array

getEbayDetails

download countries, regions, shippings.

Syntax
$self->getEbayDetails($Name);

getEbayNamespace

Returns the namespace that eBay uses in its XML

Syntax
$ebayNamespace = $self->getEbayNamespace;
Return
$ebayNamespace (String)
e.g. "urn:ebay:apis:eBLBaseComponents"

getEbayOfficialTime

get the ebay official time

Syntax
$self->getEbayOfficialTime($NoToken);
Input
$NoToken (int)
connect without using the token
Return
$result (ref.hash)
with following keys:
  • Timestamp - ebay timestamp - string
  • Ack - "Success" if successful - string
  • CorrelationID - ebay correlation id - string
  • Version - ebay api version - string
  • Build - ebay build no - string

getItem

get a single item

Syntax
$self->getItem($externalAuctionId);
Input
$externalAuctionId (string)
auction id of item
Return
$hItem (ref.hash)
info of item

getItemTransactions

get transactions of item

Syntax
$self->getItemTransactions($externalAuctionId, $modTimeFrom);
Input
$externalAuctionId (string)
auction id of item
$modTimeFrom (DateTime object)
start with this date
Return
$Transactions (ref.array.hash)
array of transactions

getOrders

Get informations about the eBay user (http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/index.html)

Syntax
$self->getOrders($aParams);
Example
my $bIsStoreOwner = $RemoteEbay->getOrders(['StoreOwner'])->{'StoreOwner'};
Input
$aParams (ref.array)
array with fields to get
Return
$hresult (ref.hash)
hash with results

getSellerList

Returns a list of items a seller has listed for auction.

Syntax
$self->getSellerList($startTimeFrom, $page);
Input
$dateFrom (DateTime object)
start with this date
Return
$Items (ref.array.hash)
array of items

getSellerTransactions

get transactions of seller

Syntax
$self->getSellerTransactions($modTimeFrom, $page);
Input
$modTimeFrom (DateTime object)
start with this date
Return
$Transactions (ref.array.hash)
array of transactions

getSessionID

get the SessionID to fetch a token

Syntax
$self->getSessionID();
Input
$RuName (string)
the runame for the application set on ebay
Return
$result (ref.hash)
with following keys:
  • SessionID - ebay session id - string
  • Timestamp - ebay timestamp - string
  • Ack - "Success" if successful - string
  • CorrelationID - ebay correlation id - string
  • Version - ebay api version - string
  • Build - ebay build no - string

getStore

retrieves the store of a ebay seller

Syntax
$self->getStore($Transaction, $CommentType, $CommentText);
Return
$result (ref.hash)
with following keys:
  • CustomCategories - list of store categories - ref.array.hash
  • Description - store description - string
  • Name - store name - string
  • SubscriptionLevel - store's level - string
  • URL - store's url - string
  • and some more info

getUser

Get informations about the eBay user (http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/index.html)

Syntax
$self->getUser($aParams);
Example
my $bIsStoreOwner = $RemoteEbay->getUser(['StoreOwner'])->{'StoreOwner'};
Input
$aParams (ref.array)
array with fields to get
Return
$hresult (ref.hash)
hash with results

leaveFeedback

leave feedback for a transaction

Syntax
$self->leaveFeedback($Transaction, $CommentType, $CommentText);
Input
$Transaction (EbayTransaction object)
ebay transaction
$CommentType (string)
comment type
$CommentText (string)
comment text
Return
$result (ref.hash)
with following keys:
  • Timestamp - ebay timestamp - string
  • Ack - "Success" if successful - string
  • CorrelationID - ebay correlation id - string
  • Version - ebay api version - string
  • Build - ebay build no - string

relistFixedPriceItem

relists an ebay fixed price item

Syntax
$self->relistFixedPriceItem($externalAuctionId);
Input
$externalAuctionId (string)
auction id of item
Return
(0 on failure 1 on success.)
$Success

relistItem

relists an ebay auction item

Syntax
$self->relistItem($externalAuctionId);
Input
$externalAuctionId (string)
auction id of item
Return
(0 on failure 1 on success.)
$Success

reviseCheckoutStatus

Get informations about the eBay user (http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/index.html)

Syntax
$self->reviseCheckoutStatus($aParams);
Example
my $bIsStoreOwner = $RemoteEbay->reviseCheckoutStatus(['StoreOwner'])->{'StoreOwner'};
Input
$aParams (ref.array)
array with fields to get
Return
$hresult (ref.hash)
hash with results

shopEnvironment

Returns the shop environment object (for Token purposes)

Syntax
$shop = $self->shopEnvironment;
Return
$shopEnvironment (object)
shop environment object

store

Returns the store database object

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

useProvider

Returns which Token should be used (Provider or Shop)

Syntax
$useProvider = $self->useProvider;
Return
$useProvider (Boolean)
1=use Provider Token, 0=use Shop Token

variableNamePrefix

'eBaySandBox' or 'eBay' depends on enviroment

Syntax
$Prefix = $self->variableNamePrefix;

verifyAddItem

upload auction for test purposes

Syntax
$self->verifyAddItem($Auction);
Input
$Auction (EbayAuction object)
auction
Return
$result (ref.hash)
with following keys:
  • Timestamp - ebay timestamp - string
  • Ack - "Success" if successful - string
  • CorrelationID - ebay correlation id - string
  • Version - ebay api version - string
  • Build - ebay build no - string
  • ItemID - ebay item id of auction - string
  • Fee - array of fees - ref.array