ePages 7.28.0 - DE_EPAGES/ShopConfiguration/API/WebService/ShopConfigService12.pm

Package DE_EPAGES::ShopConfiguration::API::WebService::ShopConfigService12

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

Functions

create
new
update

create

Creates a new shop within the given database on behalf of the current provider. The new shop is given the feature set of the specified shop type. A given shop address and name are set as well. Initial shop data are imported from import file(s). These import files must be pre-configured corresponding to the shop's feature set. Some example import files are located in the directory %EPAGES_CARTRIDGES%/DE_EPAGES/DemoShop/Database/XML.

Syntax
$ShopID = $ShopConfigService->create({
    ShopType => $ShopType,
    Database => $Database,
    Alias => $Alias,
    ShopAlias => $ShopAlias,
    IsClosed    => $IsClosed,
    DomainName  => $DomainName,
    HasSSLCertificate => $HasSSLCertificate,
    WebServerScriptNamePart => $WebServerScriptNamePart,
    IsTrialShop => $IsTrialShop,
    IsInternalTestShop => $IsInternalTestShop,
    ImportFiles => $aImportFiles,
    PublicFilesDir => $PublicFilesDir,
    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 = $ShopConfigService->create({
    ShopType => 'ECommerce100',
    Database => 'Store',
    Alias => 'DemoShop',
    ShopAlias => 'DemoShop',
    IsClosed    => 0,
    DomainName  => 'www.myshop.biz',
    HasSSLCertificate => 1,
    WebServerScriptNamePart => 'demoshop',
    IsTrialShop => 0,
    IsInternalTestShop => 0,
    ImportFiles => [
        '\\Server\Shared\Distributor\CommonData.xml',
        '\\Server\Shared\Distributor\ExampleProducts.xml',
        '\\Server\Shared\Distributor\Styles.xml',
    ],
    PublicFilesDir => '\\Server\Shared\Distributor\ShopImages',
    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 (reference to hash)
with following parameters:
  • ShopType | shop type alias | string
  • Database | database identifier (store alias) | string
  • Alias | unique shop name for the provider | string
  • ShopAlias | unique shop name for the database | string
  • IsClosed | true if the new shop is closed by provider (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
  • WebServerScriptNamePart | script name part of the shop (optional) | string
  • 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
  • aImportFiles | list of import files contianing initial shop date. These
    files must be accessible for the application servers that are
    responsible for the specified database | string
  • PublicFilesDir | directory on the application server where image files
    for the new shop are located. These files are copied to the
    shop directory. (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
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::ShopConfigService12->new( %Options );
Input
%Options (hash)
user-defined values
Return
$Service (object)
web service object

update

Updates a shop by changing the shop type, setting the status, address, name or importing data from XML files.

Syntax
$ShopConfigService->update({
    Alias => $Alias,
    ShopType => $ShopType,
    IsClosed => $IsClosed,
    DomainName => $DomainName,
    HasSSLCertificate => $HasSSLCertificate,
    WebServerScriptNamePart => $WebServerScriptNamePart,
    IsTrialShop => $IsTrialShop,
    IsInternalTestShop => $IsInternalTestShop,
    ImportFiles => $ImportFiles,
    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 (reference to hash)
with following parameters:
  • Alias | unique shop name for the provider | string
  • ShopType | (optional) new shop type alias | string
  • IsClosed | (optional) true if closed by provider | boolean
  • MarkedForDelete | (optional) true if shop is marked for deletion | boolean
  • DomainName | (optional) domain name to access the shop | string
  • HasSSLCertificate | true if the web server has an SSL certificate
    for the shop (optional) | string
  • WebServerScriptNamePart | script name part of the shop (optional) | string
  • 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
  • ImportFiles | (optional) list of files names to import | ref.array.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