ePages 6.11.0 - DE_EPAGES/Ebay/API/Ebay.pm

Package DE_EPAGES::Ebay::API::Ebay

This package provides the main ebay functions.

@EXPORT_OK
UpdateCategories
UpdateAuctions
UpdateShopAuctions
UploadScheduledAuctions
UploadScheduledShopAuctions
GetCustomerByEbayUserName
ResetAuctionCount
CheckTokenExpiryDate
UpdateTransactionList
UpdateRunningAuctions
TransactionToOrder
CheckProviderTokenExpiryDate

Functions

CheckProviderTokenExpiryDate
CheckTokenExpiryDate
GetCustomerByEbayUserName
ResetAuctionCount
TransactionToOrder
UpdateAuctions
UpdateCategories
UpdateRunningAuctions
UpdateShopAuctions
UpdateShopEnvironmentAuctions
UpdateTransactionList
UpdateTransactions
UploadScheduledAuctions

CheckProviderTokenExpiryDate

Checks eBay provider token if it is about to expire. Prints a warning if token expires in less than 30 days. Prints an error if token has already expired.

Syntax
CheckProviderTokenExpiryDate();

CheckTokenExpiryDate

Searches for eBay shop environments which ebay tokens are about to expire. Sends off email to the merchant if the ebay token expires in less than ten days.

Syntax
CheckTokenExpiryDate($NoOutput);
Input
$NoOutput (boolean)
don't print any output if true

GetCustomerByEbayUserName

Gets customer object from a eBay username.

Syntax
$customer = GetCustomerByEbayUserName( $ShopEnv, $EbayUserName );
Input
$ShopEnv (EbayShopEnvironment object)
shop environment of transaction/user
$EbayUserName (String)
username (login at eBay)
Return
$customer (Customer object)
customer to this EbayUserName or undef if no customer was found

ResetAuctionCount

Resets AuctionCount for each Shop which has the feature "EbayAuctions" if its current count is greater than zero.

Syntax
ResetAuctionCount();

TransactionToOrder

Generates a CustomerOrder from an ebay transaction.

Syntax
TransactionToOrder( $Transaction, $Customer,
$EbayShippingMethodName, $EbayPaymentMethodName, $ShippingCost );
Input
$Transaction (object)
EbayTransaction
$Customer (object)
Customer
$EbayShippingMethodName (string)
Customer selected shipping method
$EbayPaymentMethodName (string)
Customer selected payment method
$ShippingCost (float)
Shipping cost as defined on ebay
Hook
API_OrderCreated
hook parameter keys :
  • Order - customerorder - object

UpdateAuctions

Updates Auctions from eBay
(used by scripts).

Syntax
UpdateAuctions( $printOutput );
Input
$printOutput (boolean)
print output to console

UpdateCategories

Updates Categories from eBay
(used by scripts).

Syntax
UpdateCategories( $EnvironmentAlias, $printOutput );
Input
$EnvironmentAlias (string)
identifier of an environment
$printOutput (boolean)
print output to console
$Force (boolean)
force update, even when IsUpdating flag is set

UpdateRunningAuctions

Updates all running auctions of an shop environment (get highest bid etc.).

Syntax
UpdateRunningAuctions(ShopEnv, $printOutput);
Input
$ShopEnv (EbayShopEnvironment object)
shop environment
$printOutput (boolean)
print output to console

UpdateShopAuctions

Updates all Auctions of a Shop (get highest bid etc.).

Syntax
UpdateShopAuctions( $printOutput );
Input
$Shop (Shop object)
shop
$printOutput (boolean)
print output to console

UpdateShopEnvironmentAuctions

Updates all Auctions of a eBay shop env (get highest bid etc.).

Syntax
UpdateShopEnvironmentAuctions($ShopEnv, $printOutput);
Input
$ShopEnv (EbayShopEnvironment object)
shop environment
$printOutput (boolean)
print output to console

UpdateTransactionList

Description

Syntax
UpdateTransactionList( $ShopEnv, $aTransactions, $printOutput );
Input
$ShopEnv (object)
Ebay ShopEnvironment
$aTransactions (array.hash.ref)
result of getSellerTransactions
$printOutput (boolean)
true if printed output wanted

UpdateTransactions

Updates all transactions of running and shortly ended auctions of an shop environment. May create customers and send fulfillment mail.

Syntax
UpdateTransactions(ShopEnv, $printOutput);
Input
$ShopEnv (EbayShopEnvironment object)
shop environment
$printOutput (boolean)
print output to console

UploadScheduledAuctions

Sends scheduled Auctions to eBay
(used by scripts).

Syntax
UploadScheduledAuctions( $printOutput );
Input
$printOutput (boolean)
print output to console