ePages 6.17.15 - DE_EPAGES/Order/API/WebService/BasketService.pm

Package DE_EPAGES::Order::API::WebService::BasketService

Implements the Basket WebService.

Base
DE_EPAGES::Order::API::WebService::BaseBasketService

Functions

addProductLineItem
create
delete
deleteLineItem
exists
getInfo
new
update
updateLineItem

addProductLineItem

WebService-Method: addProductLineItem adds product line items to a Basket.

Syntax
$SoapData = $self->addProductLineItem( $BasketPath, $ahProductItem )
Input
$BasketPath (string)
object path to basket
$ahProductItem (ref.array.string)
array of product line item infos
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
update status

create

WebService-Method: create Creates a list of Baskets.

Syntax
$SoapData = $self->create( $aBaskets )
Input
$aBaskets (ref.array.string)
list of Basket info (data to create)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
create status of all given Baskets

delete

WebService-Method: delete Deletes a list of Baskets.

Syntax
$SoapData = $self->delete( $aBaskets )
Input
$aBaskets (ref.array.string)
list of Basket paths
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
delete status of all given Baskets

deleteLineItem

WebService-Method: deleteLineItem delete line items of a Basket.

Syntax
$SoapData = $self->updateLineItem( $BasketPath, $aLineItemAlias )
Input
$BasketPath (string)
object path to basket
$ahLineItem (ref.array.string)
array of line item alias
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
update status

exists

WebService-Method: exists Returns exists status of a list of Baskets.

Syntax
$SoapData = $self->exists( $aBaskets )
Input
$aBaskets (ref.array.string)
list of Basket paths
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
exist status of all given Baskets

getInfo

WebService-Method: getInfo Returns information about a list of Baskets (incl. line items, attributes).

Syntax
$SoapData = $self->getInfo($aBaskets, $aAttributes, $aAddressAttributes, $aLanguageCodes)
Input
$aBaskets (ref.array.string)
list of Basket paths
$aAttributes (ref.array.string)
list of AttributeIDs
$aAddressAttributes (ref.array.string)
list of AttributeIDs
$aLineItemAttributes (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 Baskets

new

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

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

update

WebService-Method: update Updates a list of Baskets.

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

updateLineItem

WebService-Method: updateLineItem Updates a line item of a Basket.

Syntax
$SoapData = $self->updateLineItem( $BasketPath, $ahLineItem )
Input
$BasketPath (string)
object path to basket
$ahLineItem (ref.array.string)
array of line item info (alias and
data to update)
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the
update status