ePages 6.12.0 - DE_EPAGES/MeinPaket/API/Object/RequestAdapter.pm

Package DE_EPAGES::MeinPaket::API::Object::RequestAdapter

Description

Functions

GetOrderRequest
LoginRequest
MeinPaketConfig
NotificationRequest
Request
UploadRequest
languageID
setRequestCategories
setRequestDescriptions
setRequestHeader
setRequestOffers
setRequestOrders
setRequestStock

GetOrderRequest

Returns Request object for receiving orders

Syntax
RequestAdapter::GetOrderRequest(  $MeinPaketConfig, $DateFrom, $DateTo );
Return
$Request (DE_EPAGES::MeinPaket::API::DTO::QueryRequest)
QueryRequest

LoginRequest

Returns Request object for receiving orders (with dummy date), to test the login parameters

Syntax
RequestAdapter::LoginRequest( $MeinPaketConfig );
Input
$MeinPaketConfig (DE_EPAGES::MeinPaket::API::Object:MeinPaketConfig)
MeinPaketConfig
Return
$Request (DE_EPAGES::MeinPaket::API::DTO::QueryRequest)
QueryRequest

MeinPaketConfig

getter/setter for 'MeinPaketConfig'

Syntax
my $MeinPaketConfig = $Object->MeinPaketConfig;
$Object->MeinPaketConfig('value');
Input
$MeinPaketConfig (any)
value of MeinPaketConfig
Return
$MeinPaketConfig (any)
value of MeinPaketConfig

NotificationRequest

Returns Request object for sending notifications to MeinPaket

Syntax
RequestAdapter::NotificationRequest( $MeinPaketConfig, $OrderDocument );
Input
$MeinPaketConfig (DE_EPAGES::MeinPaket::API::Object:MeinPaketConfig)
MeinPaketConfig
$aOrderDocuments (ref.array.DE_EPAGES::Order::API::Object::OrderDocument)
Order documents
$Action (string)
Notification action
Return
$Request (DE_EPAGES::MeinPaket::API::DTO::NotificationRequest)
NotificationRequest

Request

getter/setter for 'Request'

Syntax
my $Request = $Object->Request;
$Object->Request('value');
Input
$Request (any)
value of Request
Return
$Request (any)
value of Request

UploadRequest

Returns Request object for uploading product information

Syntax
RequestAdapter::UploadRequest( $aOffers, $aElements  );
Return
$Request (DE_EPAGES::MeinPaket::API::DTO::UploadRequest)
UploadRequest

languageID

getter/setter for 'languageID'

Syntax
my $languageID = $Object->languageID;
$Object->languageID('value');
Input
$languageID (any)
value of languageID
Return
$languageID (any)
value of languageID

setRequestCategories

sets request offer category information

Syntax
setRequestCategories( $aOffers );
Input
$aOffers (ref.array.object)
offers

setRequestDescriptions

sets request descriptions

Syntax
setRequestDescriptions( $aOffers );
Input
$aOffers (ref.array.object)
offers

setRequestHeader

sets header info

Syntax
setRequestHeader( );

setRequestOffers

sets request offer informations

Syntax
setRequestDescriptions( $aOffers );
Input
$aOffers (ref.array.object)
offers

setRequestOrders

sets request order timestamps

Syntax
setRequestOrders( $DateFrom, $DateTo );
Input
$DateFrom (DateTime or string: '2005-12-01T12:52:00')
date from
$DateTo (DateTime or string: '2005-12-01T12:52:00')
date to

setRequestStock

Sets stock information for request

Syntax
setRequestStock( $aOffers );
Input
$aOffers (ref.array.object)
offer list