ePages 7.26.0 - DE_EPAGES/ShopConfiguration/API/WebService/ShopConfigService7.pm

Package DE_EPAGES::ShopConfiguration::API::WebService::ShopConfigService7

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/2014/03')
    ->proxy("http://localhost:80/epages/Site.soap");
$ShopConfigService->userinfo( "/Providers/$ProviderAlias/Users/$Login:$Password" );
$ShopConfigService->delete({
    Alias => 'Store.DemoShop'
});

Functions

create
new
setSecondaryDomains
update

create

Creates a new shop on behalf of the current provider. Sets secondary domain names See DE_EPAGES::ShopConfiguration::API::WebService::ShopConfigService::create

Syntax
$ShopID = $ShopConfigService->create({
    Alias => $Alias,
    ...
    SecondaryDomains => $DomainsNames,
})->result;
Example
my $ShopID = $ShopConfigService->create({
    Alias => 'DemoShop',
    ...
    SecondaryDomains => ['test.epages.de'],
})->result;
Input
$Alias (string)
unique shop name for the provider
$SecondaryDomains (ref.array.string)
list of secondary domain names (optional)
Return
$ShopID (integer)
object id of the shop within the database

new

Creates a new web service object as a blessed hash reference and adds the values from the %Options hash.

Syntax
$Service = DE_EPAGES::ShopConfiguration::API::WebService::ShopConfigService7->new( %Options );
Input
%Options (hash)
user-defined values
Return
$Service (object)
web service object

setSecondaryDomains

Set the additional domain names of this shop.

Syntax
$Service->setSecondaryDomains( $ShopID, $aDomainNames );
Input
$hOptions (ref.hash)
with following parameters:
  • Alias | unique shop name for the provider | string
$aDomainNames (ref.array.string)
list of domain names to add

update

Updates a shop. Sets secondary domain names for the shop See DE_EPAGES::ShopConfiguration::API::WebService::ShopConfigService::update

Syntax
$ShopConfigService->update({
    Alias => $Alias,
    ...,
    SecondaryDomains => $aSecondaryDomains,
});
Input
$Alias (string)
unique shop name for the provider
$SecondaryDomains (ref.array.string)
list of secondary domain names to add to the shop