ePages 7.48.0 - DE_EPAGES/Ebay/API/Object/EbayShopEnvironment.pm

Package DE_EPAGES::Ebay::API::Object::EbayShopEnvironment

object interface for EbayShopEnvironment.

Base
DE_EPAGES::Shop::API::Object::ShopObject

Functions

className
dbPackage
filterSellerProfiles
filterSellerProfilesByDefault
getBusinessPolicies
getSellerProfiles
isBusinessPolicyActivated
isSellerProfileEmpty
new

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $EbayShopEnvironment->className;
Return
$ClassName (String)
class name

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $EbayShopEnvironment->dbPackage;
Return
$DbPackage (String)
database package name

filterSellerProfiles

Returns the ebay seller profiles for a given type ('PAYMENT', 'SHIPPING' or 'RETURN_POLICY')

Syntax
$ahFilteredSellerProfiles = $self->filterSellerProfiles($hresult, $sellerProfileType);
Input
$hResult (ref.hash)
the whole result of the seller profile call
$sellerProfileType (string)
type of the profile to be filtered
Return
$hresult (ref.hash)
hash with attribute values of the filtered seller profile

filterSellerProfilesByDefault

Returns the default profile for a given seller profile type (business policy type)

Syntax
$hDefaultProfile = $EbayShopEnvironment->filterSellerProfilesByDefault(
                        $hBusinessPolicySellerProfiles, 'PAYMENT');
Input
$hResult (ref.hash)
the whole result of the seller profile call
$sellerProfileType (string)
type of the profile to be filtered
Return
$hFilteredSellerProfile (ref.hash)
hash with attribute values of the default seller profile

getBusinessPolicies

Returns an array with all business policies for a shop environment

Syntax
$aBusinessPolicies = $ShopEnv->getBusinessPolicies();
Return
$hArray (ref.array)
array with all business policies

getSellerProfiles

Returns the ebay seller profile of an ebay shop environment

Syntax
my $hBusinessPolicySellerProfiles = $EbayShopEnvironment->getSellerProfiles;
Return
$hresult (ref.hash)
hash with attribute values of the seller profile

isBusinessPolicyActivated

Returns 1 if the business policy feature is activated for the used ebay account

Syntax
$isBusinessPoliciesActivated = $ShopEnv->isBusinessPolicyActivated($aSellerProfiles);
Input
$hResult (ref.hash)
the whole result of the seller profile call
Return
$result (boolean)
returns 1 if business policy is activate

isSellerProfileEmpty

Returns true if the sellerProfile hash is empty

Syntax
my $isSellerProfileEmpty = $EbayShopEnvironment->isSellerProfileEmpty;
Return
$isSellerProfileEmpty (boolean)
isSellerProfileEmpty

new

overloads DE_EPAGES::Core::API::BaseObject->new to decrypt attributes before store in cache

Syntax
$Object = $Package->new('ObjectID' => $ObjectID, ... );
Input
%Attributes (hash)
attribute value hash
Return
$Object (object)
existing object