Package DE_EPAGES::Ebay::API::Object::RemoteEbay
stub object for web service requests to ebay
Functions
- addItem
- endItem
- environment
- fetchToken
- getAllBidders
- getAttributesCS
- getCategories
- getCategory2CS
- getCategoryFeatures
- getCategorySpecifics
- getEbayDetails
- getEbayNamespace
- getEbayOfficialTime
- getItem
- getItemTransactions
- getNotificationPreferences
- getOrders
- getSellerList
- getSellerTransactions
- getSessionID
- getStore
- getUser
- getUserPreferences
- leaveFeedback
- relistFixedPriceItem
- relistItem
- reviseCheckoutStatus
- setNotificationPreferences
- setUserPreferencesDisplayPayNowButton
- shopEnvironment
- store
- useProvider
- variableNamePrefix
- verifyAddItem
addItem
upload auction to ebay
Syntax |
$self->addItem($Auction); |
Input |
|
Return |
|
endItem
ends an ebay item
Syntax |
$self->endItem($externalAuctionId); |
Input |
|
Return |
|
environment
Returns which eBay Environment should be used
Syntax |
$store = $self->environment; |
Return |
|
fetchToken
get the Token
Syntax |
$self->fetchToken($SessionID); |
Input |
|
Return |
|
getAllBidders
get a all bidders from auction, for second offer change
Syntax |
$self->getAllBidders($externalAuctionId); |
Input |
|
Return |
|
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 |
|
Return |
|
getCategories
download categories
Syntax |
$self->getCategories($DoCheckOnly, $LevelLimit, $ParentId); |
Input |
|
Return |
|
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 |
|
Return |
|
getCategoryFeatures
calls GetCategoryFeatures. All parameters are optional
Syntax |
$self->getCategoryFeatures( $CategoryID, $FeatureID, $ViewAllNodes, $AllFeaturesForCategory ); |
Input |
|
Return |
|
getCategorySpecifics
Retrieve custom item specifics for a category.
Syntax |
$self->getCategorySpecifics( $CategoryID ); |
Input |
|
Return |
|
getEbayDetails
download countries, regions, shippings.
Syntax |
$self->getEbayDetails($Name); |
getEbayNamespace
Returns the namespace that eBay uses in its XML
Syntax |
$ebayNamespace = $self->getEbayNamespace; |
Return |
|
getEbayOfficialTime
get the ebay official time
Syntax |
$self->getEbayOfficialTime($NoToken); |
Input |
|
Return |
|
getItem
get a single item
Syntax |
$self->getItem($externalAuctionId); |
Input |
|
Return |
|
getItemTransactions
get transactions of item
Syntax |
$self->getItemTransactions($externalAuctionId, $modTimeFrom); |
Input |
|
Return |
|
getNotificationPreferences
Retrieves notification preferences
Syntax |
$self->getNotificationPreferences( $PreferenceLevel ); |
Input |
|
Return |
|
getOrders
Get list of ebay orders (transactions with combined payment)
Syntax |
$self->getOrders($aParams); |
Example |
my $bIsStoreOwner = $RemoteEbay->getOrders(['StoreOwner'])->{'StoreOwner'}; |
Input |
|
Return |
|
getSellerList
Returns a list of items a seller has listed for auction.
Syntax |
$self->getSellerList($startTimeFrom, $page); |
Input |
|
Return |
|
getSellerTransactions
get transactions of seller
Syntax |
$self->getSellerTransactions($modTimeFrom, $page); |
Input |
|
Return |
|
getSessionID
get the SessionID to fetch a token
Syntax |
$self->getSessionID(); |
Input |
|
Return |
|
getStore
retrieves the store of a ebay seller
Syntax |
$self->getStore($Transaction, $CommentType, $CommentText); |
Return |
|
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 |
|
Return |
|
getUserPreferences
Retrieve user preferences
Syntax |
$self->getUserPreferences( $aShowPreferenceCategory ); |
Example |
my $hPrefs = $self->getUserPreferences( ['ShowSellerPaymentPreferences'] ); |
Input |
|
Return |
|
leaveFeedback
leave feedback for a transaction
Syntax |
$self->leaveFeedback($Transaction, $CommentType, $CommentText); |
Input |
|
Return |
|
relistFixedPriceItem
relists an ebay fixed price item
Syntax |
$self->relistFixedPriceItem($externalAuctionId); |
Input |
|
Return |
|
relistItem
relists an ebay auction item
Syntax |
$self->relistItem($externalAuctionId); |
Input |
|
Return |
|
reviseCheckoutStatus
Revise a transaction's checkout status
Syntax |
$self->reviseCheckoutStatus($TransactionID, $ItemID, $hParams); |
Example |
$RemoteEbay->reviseCheckoutStatus($t, $i, {'CheckoutStatus'=>'Complete'}}; |
Input |
|
setNotificationPreferences
set notification preferences
Syntax |
$self->setNotificationPreferences( $aEnableEvents, $aDisableEvents, $URL ); |
Input |
|
setUserPreferencesDisplayPayNowButton
Set user preference: DisplayPayNowButton. This enables / disables ebays platform integrated checkout functionality. For a list of valid options see ebay API documentation for Type "DisplayPayNowButtonCodeType"
Syntax |
$self->setUserPreferencesDisplayPayNowButton( $DisplayPayNowButtonSetting ); |
Example |
$self->setUserPreferencesDisplayPayNowButton( 'ShowPayNowButtonForAllPaymentMethods' ); |
Input |
|
shopEnvironment
Returns the shop environment object (for Token purposes)
Syntax |
$shop = $self->shopEnvironment; |
Return |
|
store
Returns the store database object
Syntax |
$store = $self->store; |
Return |
|
useProvider
Returns which Token should be used (Provider or Shop)
Syntax |
$useProvider = $self->useProvider; |
Return |
|
variableNamePrefix
'eBaySandBox' or 'eBay' depends on enviroment
Syntax |
$Prefix = $self->variableNamePrefix; |
verifyAddItem
upload auction for test purposes
Syntax |
$self->verifyAddItem($Auction); |
Input |
|
Return |
|