ePages 6.11.0 - DE_EPAGES/Product/API/WebService/ProductTypeService.pm

Package DE_EPAGES::Product::API::WebService::ProductTypeService

Implements the Product Type WebService.

Base
DE_EPAGES::Content::API::WebService::BaseContentService

Functions

buildSoapPreDefAttribute
buildSoapProductType
create
createPreDefAttribute
createProductAttribute
delete
deletePreDefAttribute
deleteProductAttribute
exists
existsPreDefAttribute
existsProductAttribute
getAllInfo
getAllPreDefAttributesInfo
getAllProductAttributesInfo
getBaseProductType
getInfo
getLayout
getPreDefAttributeInfo
getProductAttributeInfo
setPreDefAttributeParameters
setProductAttributeParameters
update
updatePreDefAttribute
updateProductAttribute

buildSoapPreDefAttribute

No WebService-Method! Build SOAP::Data object for PreDefAttribute.

Syntax
$self->buildSoapPreDefAttribute($PreDefAttribute)
Input
$PreDefAttribute (PreDefAttribute object)
predefined attribute
$aAttributes (ref.array.string)
list of attribute alias (optional)
$aLanguages (ref.array.string)
list of language codes (optional)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure representing the predefined attribute

buildSoapProductType

No WebService-Method! Build SOAP::Data object for ProductType.

Syntax
$self->buildSoapProductType($ProductType, $aAttributes, $aLanguages)
Input
$ProductType (ProductType object)
product type
$aAttributes (ref.array.string)
list of attribute alias (optional)
$aLanguages (ref.array.string)
list of language codes (optional)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure representing the product type

create

WebService-Method: create Creates a list of product types.

Syntax
$SoapData = $self->create($aProductTypes);
Input
$aProductTypes (ref.array.string)
list of product type info (data to update)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
create status of all given product types

createPreDefAttribute

WebService-Method: createPreDefAttribute Creates a list of predefined attributes.

Syntax
$SoapData = $self->createPreDefAttribute($ProductAttributePath, $aPreDefAttributes);
Input
$ProductAttributePath (string)
path of product attribute
$aPreDefAttributes (ref.array.hash)
list of predefined attribute info (alias and data to set)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
create status of all given predefined attributes

createProductAttribute

WebService-Method: createProductAttribute Creates a list of product attributes.

Syntax
$SoapData = $self->createProductAttribute($ProductTypePath, $aProductAttributes);
Input
$ProductTypePath (string)
path of product type
$aProductAttributes (ref.array.hash)
list of product attribute info (alias and data to set)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
create status of all given product attributes

delete

WebService-Method: delete Deletes a list of product types.

Syntax
$SoapData = $self->delete($aProductTypess);
Input
$aProductTypes (ref.array.string)
list of product type paths
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
delete status of all given product types

deletePreDefAttribute

WebService-Method: deletePreDefAttribute Deletes a list of product attributes.

Syntax
$SoapData = $self->deletePreDefAttribute($aProductTypess);
Input
$ProductAttributePath (string)
path of product type
$aPreDefAttributes (ref.array.string)
list of product attribute aliases
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
delete status of all given product attributes

deleteProductAttribute

WebService-Method: deleteProductAttribute Deletes a list of product attributes.

Syntax
$SoapData = $self->deleteProductAttribute($aProductTypess);
Input
$ProductTypePath (string)
path of product type
$aProductAttributes (ref.array.string)
list of product attribute aliases
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
delete status of all given product attributes

exists

WebService-Method: exists Returns exists status of a list of product types.

Syntax
$SoapData = $self->exists($aProductTypes);
Input
$aProductTypes (ref.array.string)
list of product type paths
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
exist status of all given product types

existsPreDefAttribute

WebService-Method: existsPreDefAttribute Returns exists status of a list of predefined attributes.

Syntax
$SoapData = $self->existsPreDefAttribute($ProductAttributePath, $aPreDefAttributes);
Input
$ProductAttributePath (string)
path of product attribute
$aPreDefAttributes (ref.array.string)
list of predefined attribute aliases
$aLanguageCodes (ref.array.string)
list of LanguageCodes
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
exist status of all given predefined attributes

existsProductAttribute

WebService-Method: existsProductAttribute Returns exists status of a list of product attributes.

Syntax
$SoapData = $self->existsProductAttribute($ProductTypePath, $aProductAttributes);
Input
$ProductTypePath (string)
path of product type
$aProductAttributes (ref.array.string)
list of product attribute aliases
$aLanguageCodes (ref.array.string)
list of LanguageCodes
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
exist status of all given product attributes

getAllInfo

WebService-Method: getAllInfo Returns information about all existing product types of the current shop

Syntax
$SoapData = $self->getAllInfo($aAttributes, $aLanguageCodes);
Input
$aAttributes (ref.array.string)
list of AttributeIDs
$aLanguageCodes (ref.array.string)
list of LanguageCodes
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with
info of all existing product types

getAllPreDefAttributesInfo

WebService-Method: getAllPreDefAttributesInfo Gets all predefined attributes of the product attribute.

Syntax
$SoapData = $self->getAllPreDefAttributesInfo('/Shops/DemoShop/ProductTypes/Jacket/Attributes/Size');
$SoapData = $self->getAllPreDefAttributesInfo($ProductAttributePath, ['de', 'en']);
Input
$ProductAttributePath (string)
path of product attribute
$aLanguageCodes (ref.array.string)
list of LanguageCodes
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
infos of all predefined attributes

getAllProductAttributesInfo

WebService-Method: getAllProductAttributesInfo Gets all product attributes of the product type.

Syntax
$SoapData = $self->getAllProductAttributesInfo('/Shops/DemoShop/ProductTypes/Tent');
$SoapData = $self->getAllProductAttributesInfo('/Shops/DemoShop/ProductTypes/Tent', ['de', 'en']);
Input
$ProductTypePath (string)
path of product type
$aLanguageCodes (ref.array.string)
list of LanguageCodes
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
infos of all product attributes

getBaseProductType

WebService-Method: getBaseProductType Returns the path of the base product type.

Syntax
$SoapData = $self->getBaseProductType();
Return
$SoapData (SOAP::Data)
a SOAP::Data string containing the path
of the base product type

getInfo

WebService-Method: getInfo Returns information about a list of product types.

Syntax
$SoapData = $self->getInfo($aProductTypes, $aAttributes, $aLanguageCodes);
Input
$aProductTypes (ref.array.string)
list of product type paths
$aAttributes (ref.array.string)
list of AttributeIDs
$aLanguageCodes (ref.array.string)
list of LanguageCodes
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
info of all given product types

getLayout

No WebService-Method! Get the templates for the layout options.

Syntax
$self->getLayout($ProductType)
Input
$ProductType (ProductType object)
product type
Return
$hLayout (ref.hash)
a hash with templates (keys: 'Content-Base', 'Content-Variation', 'Content-Bundles')

getPreDefAttributeInfo

WebService-Method: getPreDefAttributeInfo Returns information about a list of predefined attributes for one product attribute.

Syntax
$SoapData = $self->getPreDefAttributeInfo($ProductAttributePath, $aPreDefAttributes, $aLanguageCodes);
Input
$ProductAttributePath (string)
path of product attribute
$aPreDefAttributes (ref.array.string)
list of predefined attribute aliases
$aLanguageCodes (ref.array.string)
list of LanguageCodes
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
info of all given predefined attributes

getProductAttributeInfo

WebService-Method: getProductAttributeInfo Returns information about a list of product attributes for one product type.

Syntax
$SoapData = $self->getProductAttributeInfo($ProductTypePath, $aAttributes, $aLanguageCodes);
Input
$ProductTypePath (string)
path of product type
$aProductAttributes (ref.array.string)
list of product attribute aliases
$aLanguageCodes (ref.array.string)
list of LanguageCodes
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
info of all given product attributes

setPreDefAttributeParameters

No WebService-Method! Sets parameters of a predefined attribute (for create and update predefined attributes).

Syntax
$self->setPreDefAttributeParameters($PreDefAttribute, $hPreDefAttribute);
Input
$PreDefAttribute (predefined attribute object)
predefined attribute to update
$hPreDefAttribute (ref.hash)
data to assign to the predefined attribute
  • Position - int
  • ValueString - string (for non-localized product attributes)
  • ValueLocString - LocalizedString (for localized product attributes)

setProductAttributeParameters

No WebService-Method! Sets parameters of a product attribute (for create and update product attributes).

Syntax
$self->setProductAttributeParameters($ProductAttribute, $hProductAttribute);
Input
$ProductAttribute (product attribute object)
product attribute to update
$hProductAttribute (ref.hash)
data to assign to the product attribute
  • Name - LocalizedString
  • Description - LocalizedString
  • Position - int
  • IsVisible - boolean

update

WebService-Method: update Updates a list of product types.

Syntax
$SoapData = $self->update($aProductTypes);
Input
$aProductTypes (ref.array.string)
list of product type info (path and
data to update)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
update status of all given product types

updatePreDefAttribute

WebService-Method: updatePreDefAttribute Updates a list of predefined attributes.

Syntax
$SoapData = $self->updatePreDefAttribute($aProductTypes);
Input
$ProductAttributePath (string)
path of product attribute
$aPreDefAttributes (ref.array.hash)
list of predefined attribute info (alias and
data to update)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
update status of all given predefined attributes

updateProductAttribute

WebService-Method: updateProductAttribute Updates a list of product attributes.

Syntax
$SoapData = $self->updateProductAttribute($aProductTypes);
Input
$ProductTypePath (string)
path of product type
$aProductAttributes (ref.array.hash)
list of product attribute info (alias and
data to update)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
update status of all given product attributes