ePages 6.11.0 - DE_EPAGES/Order/API/WebService/OrderDocumentService.pm

Package DE_EPAGES::Order::API::WebService::OrderDocumentService

Implements the OrderDocument WebService.

Base
DE_EPAGES::Order::API::WebService::BaseOrderService

Functions

create
delete
exists
getCreditNotes
getInfo
getInvoices
getPackingSlips
new

create

WebService-Method: create Creates a list of OrderDocuments.

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

delete

WebService-Method: delete Deletes a list of OrderDocuments.

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

exists

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

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

getCreditNotes

WebService-Method: getCreditNotes Returns paths of all credit notes of an order.

Syntax
$SoapData = $self->getCreditNotes($aOrders);
Input
$aOrders (ref.array.string)
list of Order paths
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the paths of all credit notes

getInfo

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

Syntax
$SoapData = $self->getInfo($aOrderDocuments, $aAttributes, $aLanguageCodes);
Input
$aOrderDocuments (ref.array.string)
list of OrderDocument 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 OrderDocuments

getInvoices

WebService-Method: getInvoices Returns paths of all invoices of an order.

Syntax
$SoapData = $self->getInvoices($aOrders);
Input
$aOrders (ref.array.string)
list of Order paths
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the paths of all invoices

getPackingSlips

WebService-Method: getPackingSlips Returns paths of all packing slips of an order.

Syntax
$SoapData = $self->getPackingSlips($aOrders);
Input
$aOrders (ref.array.string)
list of Order paths
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with the paths of all packing slips

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