ePages 6.10 - DE_EPAGES/ShopConfiguration/API/WebService/ShopConfigService6.pm

Package DE_EPAGES::ShopConfiguration::API::WebService::ShopConfigService6

Provides web service access to create and delete shops

Example
use DE_EPAGES::WebService::API::Client;
my $ShopConfigService = DE_EPAGES::WebService::API::Client
    ->uri('urn://epages.de/WebService/ShopConfigService/2009/09')
    ->proxy("http://localhost:80/epages/Site.soap");
$ShopConfigService->userinfo( "/Providers/$ProviderAlias/Users/$Login:$Password" );
$ShopConfigService->delete({
    Alias => 'Store.DemoShop'
});

Functions

create
getInfo
update

create

Creates a new shop on behalf of the current provider. Sets login, email and password for the primary administrator. See DE_EPAGES::ShopConfiguration::API::WebService::ShopConfigService::create

Syntax
$ShopID = $ShopConfigService->create({
    Alias => $Alias,
    ...
    MerchantLogin => $MerchantLogin,
    MerchantPassword => $MerchantPassword,
    MerchantEMail => $MerchantEMail,
})->result;
Example
my $ShopID = $ShopConfigService->create({
    Alias => 'DemoShop',
    ...
    MerchantLogin => $MerchantLogin,
    MerchantPassword => $MerchantPassword,
    MerchantEMail => $MerchantEMail,
})->result;
Input
$Alias (string)
unique shop name for the provider
$MerchantLogin (string)
merchant login (optional)
$MerchantPassword (string)
merchant password (optional)
$MerchantEMail (string)
merchant email address (optional)
Return
$ShopID (integer)
object id of the shop within the database

getInfo

Returns information about a shop from the site database.

Syntax
$hShopInfo = $ShopConfigService->getInfo({
    Alias => $Alias
})->result;
Input
$Alias (string)
unique shop name for the provider
Return
$hShopInfo (ref.hash.string)
shop data
  • Provider - provider alias - string
  • Alias - unique shop name for the provider - string
  • ShopType - shop type alias - string
  • Database - store database identifier - string
  • ObjectPath - object path of the shop in the store database - string
  • IsClosed - true if closed by provider - boolean
  • IsDeleted - true if deleted in store database - boolean
  • DomainName - shop domain name - string
  • HasSSLCertificate - true if the web server has an SSL certificate
    for the shop - string

update

Updates a shop. Sets login, email and password for the primary administrator. See DE_EPAGES::ShopConfiguration::API::WebService::ShopConfigService::update

Syntax
$ShopConfigService->update({
    Alias => $Alias,
    ...,
    MerchantLogin => $MerchantLogin,
    MerchantPassword => $MerchantPassword,
    MerchantEMail => $MerchantEMail,
});
Input
$Alias (string)
unique shop name for the provider
$MerchantLogin (string)
merchant login (optional)
$MerchantPassword (string)
merchant password (optional)
$MerchantEMail (string)
merchant email address (optional)