ePages 6.10 - DE_EPAGES/Order/API/WebService/OrderService.pm

Package DE_EPAGES::Order::API::WebService::OrderService

Implements the Order WebService.

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

Functions

create
delete
exists
find
getInfo
update

create

WebService-Method: create Creates a list of Orders.

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

delete

WebService-Method: delete Deletes a list of Orders.

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

exists

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

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

find

WebService-Method: find Find Orders by some search parameters.

Syntax
$SoapData = $self->find( $InSearchParameters )
Input
$InSearchParameters (ref.hash)
search arguments (all optional):
  • Alias - Order nr - string
  • Product - product alias is part
    of Order - string
  • DateFrom - time frame for order - datetime string
  • DateTo - time frame for order - datetime string
  • IsViewed - is status 'Viewed' - boolean
  • IsCancelled - is status 'Cancelled' - boolean
  • IsInProcess - is status 'InProcess' - boolean
  • IsPending - is status 'Pending' - boolean
  • IsReadyForShipping - is status 'ReadyForShipping' - boolean
  • IsPartlyDispatched - is status 'PartlyDispatched' - boolean
  • IsDispatched - is status 'Dispatched' - boolean
  • IsShipped - is status 'Shipped' - boolean
  • IsPartlyPaid - is status 'PartlyPaid' - boolean
  • IsPaid - is status 'Paid' - boolean
  • IsClosed - is status 'Closed' - boolean
  • IsArchived - is status 'Archived' - boolean
  • IsPartlyInvoiced - is status 'PartlyInvoiced' - boolean
  • IsInvoiced - is status 'Invoiced' - boolean
  • NotViewed - is status not 'Viewed' - boolean
  • NotCancelled - is status not 'Cancelled' - boolean
  • NotInProcess - is status not 'InProcess' - boolean
  • NotPending - is status not 'Pending' - boolean
  • NotReadyForShipping - is status not 'ReadyForShipping'- boolean
  • NotPartlyDispatched - is status not 'PartlyDispatched'- boolean
  • NotDispatched - is status not 'Dispatched' - boolean
  • NotShipped - is status not 'Shipped' - boolean
  • NotPartlyPaid - is status not 'PartlyPaid' - boolean
  • NotPaid - is status not 'Paid' - boolean
  • NotClosed - is status not 'Closed' - boolean
  • NotArchived - is status not 'Archived' - boolean
  • NotPartlyInvoiced - is status not 'PartlyInvoiced' - boolean
  • NotInvoiced - is status not 'Invoiced' - boolean
Return
$SoapData (SOAP::Data)
a SOAP::Data structure with a list
of Order paths

getInfo

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

Syntax
$SoapData = $self->getInfo( $aOrders, $aAttributes, $aLanguageCodes )
Input
$aOrders (ref.array.string)
list of Order 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 Orders

update

WebService-Method: update Updates a list of Orders.

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