ePages 7.38.0 - DE_EPAGES/ShopConfiguration/API/WebService/SimpleProvisioningService6.pm

Package DE_EPAGES::ShopConfiguration::API::WebService::SimpleProvisioningService6

Provides simpliefied web service access to create and update shops

Example
use DE_EPAGES::WebService::API::Client;
my $SimpleProvisioningService = DE_EPAGES::WebService::API::Client
    ->uri('urn://epages.de/WebService/SimpleProvisioningService/2017/11')
    ->proxy("http://localhost:80/epages/Site.soap")
    ->userinfo( "/Providers/$ProviderAlias/Users/$Login:$Password" );
    ->create({
      Alias => 'DemoShop2',
      ShopType => 'ECom100',
});

Functions

create
new
update

create

Creates a new shop on behalf of the current provider. Sets login, email and password for the primary administrator as well as the shop address and the shop name.

Syntax
$SimpleProvisioningService->create({
    Alias => $Alias,
    ShopType => $ShopType,
    IsClosed => $IsClosed,
    IsTrialShop => $IsTrialShop,
    IsInternalTestShop => $IsInternalTestShop,
    DomainName  => $DomainName,
    HasSSLCertificate => $HasSSLCertificate,
    MerchantLogin => $MerchantLogin,
    MerchantPassword => $MerchantPassword,
    MerchantEMail => $MerchantEMail,
    ShopAddress_FirstName => $FirstName,
    ShopAddress_LastName => $LastName,
    ShopAddress_CountryID => $CountryID,
    ShopAddress_Street => $Street,
    ShopAddress_Zipcode => $Zipcode,
    ShopAddress_City => $City,
    ShopAddress_State => $State,
    Name => $Name,
})->result;
Example
my $ShopID = $SimpleProvisioningService->create({
    Alias => 'DemoShop',
    ShopType => 'ECom100',
    MerchantLogin => 'smith',
    MerchantPassword => 'geheim',
    MerchantEMail => 'asmith@hotmail.com',
    MerchantEMail => 'hab@ich.net',
    ShopAddress_FirstName => 'Max',
    ShopAddress_LastName => 'Mustermann',
    ShopAddress_CountryID => '276',
    ShopAddress_Street => 'Heinrich-Heine-Straße 1',
    ShopAddress_Zipcode => '07749',
    ShopAddress_City => 'Jena',
    ShopAddress_State => 'TH',
    Name => 'Milestones',
})->result;
Input
$hOptions (ref.hash.string)
shop data
  • Alias | unique shop identifier | string
  • ShopType | shop type alias | string
  • IsClosed | true if the new shop is closed by provider (optional, default: 0) | boolean
  • IsTrialShop | true if the shop is in trial period (optional, default: 0) | boolean
  • IsInternalTestShop | true if the shop is used for test or support purposes (optional, default: 0) | boolean
  • DomainName | domain name to access the shop (optional) | string
  • HasSSLCertificate | true if the web server has an SSL certificate for the shop (optional) | string
  • MerchantLogin | merchant login (optional) | string
  • MerchantPassword | merchant password (optional) | string
  • MerchantEMail | merchant email address (optional) | string
  • ShopAddress_FirstName | merchant first name | string
  • ShopAddress_LastName | merchant last name | string
  • ShopAddress_CountryID | merchant enumeric country code according to ISO 3166-1 | integer
  • ShopAddress_Street | merchant street and house number | string
  • ShopAddress_Zipcode | merchant zipcode | string
  • ShopAddress_City | merchant city | string
  • ShopAddress_State | merchant state code according to ISO 3166-2 | string
  • Name | name of the shop | string

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::SimpleProvisioningService6->new( %Options );
Input
%Options (hash)
user-defined values
Return
$Service (object)
web service object

update

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

Syntax
$SimpleProvisioningService->update({
    Alias => $Alias,
    ShopType => $ShopType,
    IsClosed => $IsClosed,
    IsTrialShop => $IsTrialShop,
    IsInternalTestShop => $IsInternalTestShop,
    DomainName => $DomainName,
    HasSSLCertificate => $HasSSLCertificate,
    MerchantLogin => $MerchantLogin,
    MerchantPassword => $MerchantPassword,
    MerchantEMail => $MerchantEMail,
    ShopAddress_FirstName => $FirstName,
    ShopAddress_LastName => $LastName,
    ShopAddress_CountryID => $CountryID,
    ShopAddress_Street => $Street,
    ShopAddress_Zipcode => $Zipcode,
    ShopAddress_City => $City,
    ShopAddress_State => $State,
    Name => $Name,
});
Input
$hOptions (ref.hash.string)
shop data
  • Alias | unique shop identifier | string
  • IsClosed | true if the new shop is closed by provider (optional, default: 0) | boolean
  • IsTrialShop | true if the shop is in trial period (optional, default: 0) | boolean
  • IsInternalTestShop | true if the shop is used for test or support purposes (optional, default: 0) | boolean
  • DomainName | domain name to access the shop (optional) | string
  • HasSSLCertificate | true if the web server has an SSL certificate for the shop (optional) | string
  • MerchantLogin | merchant login (optional) | string
  • MerchantPassword | merchant password (optional) | string
  • MerchantEMail | merchant email address (optional) | string
  • ShopAddress_FirstName | merchant first name | string
  • ShopAddress_LastName | merchant last name | string
  • ShopAddress_CountryID | merchant enumeric country code according to ISO 3166-1 | integer
  • ShopAddress_Street | merchant street and house number | string
  • ShopAddress_Zipcode | merchant zipcode | string
  • ShopAddress_City | merchant city | string
  • ShopAddress_State | merchant state code according to ISO 3166-2 | string
  • Name | name of the shop | string