ePages 7.19.0 - DE_EPAGES/MeinPaket/API/Object/MeinPaketConfig.pm

Package DE_EPAGES::MeinPaket::API::Object::MeinPaketConfig

Description

Base
DE_EPAGES::ProductPortal::API::Object::PortalConfig

Functions

addProducts
deleteOffers
endOffers
existsOffer
handleNotificationResponse
handleUploadResponse
login
remote
sendNotification
upload

addProducts

Add products to portal, if a product is an super product, only sub products will be added.

Syntax
$PortalConfig->addProducts($aProducts);
Input
$aProducts (ref.array.object)
products
Return
$aMeinPaketOffer (ref.array.object)
created offers

deleteOffers

sends request to MeinPaket API and removes offer from config

Syntax
$Obj->deleteOffers( $aOffers );
Input
$aOffers (array.ref.DE_EPAGES::MeinPaket::API::Object::MeinPaketOffer)
MeinPaketOffer list

endOffers

Sets enddate to $NOW and sends request to MeinPaket API

Syntax
$Obj->endOffers( $aOffers );
Input
$aOffers (array.ref.DE_EPAGES::MeinPaket::API::Object::MeinPaketOffer)
MeinPaketOffer list

existsOffer

Checks if an offer exists for a product

Syntax
$Config->existsOffer( $Product );
Input
$Product (DE_EPAGES::Product::API::Object::Product)
product
Return
$Exists (boolean)
True if offer exists

handleNotificationResponse

Handles notification response message from MeinPaket API

Syntax
$Obj->handleNotificationResponse( $Response, $aOrderDocuments, $Event );
Input
$Response (DE_EPAGES::MeinPaket::API::DTO::NotificationResponse)
MeinPaket response message
$aOrderDocuments (ref.array.DE_EPAGES::Order::API::Object::OrderDocument)
order documents
$Event (string)
Notification event

handleUploadResponse

Handles API UploadResposne messages

Syntax
$Obj->handleUploadResponse( $UploadResponse, $aOffers, $Event );
Input
$UploadResponse (DE_EPAGES::MeinPaket::API::DTO::UploadResponse)
upload response object
$aOffers (ref.array.DE_EPAGES::MeinPaket::API::Object::MeinPaketOffer)
offer list
$Event (string)
event. Valid events are:
  • processResultSuccess - update offers
  • enable - enable offers
  • disable - disable offers
$aElements (array.ref.string)
subset of attributes to update

login

Sends a dummy request to test login via MeinPaket API, throws an error on login failure.

Syntax
$Obj->login( );
Return
$Response (DE_EPAGES::MeinPaket::API::DTO::Response)
MeinPaket API response

remote

Gets RemoteMeinPaket adapter

Syntax
$Obj->remote( );
Return
$Remote (DE_EPAGES::MeinPaket::API::Object::RemoteMeinPaket)
RemoteMeinPaket adapter

sendNotification

Sends notification request to MeinPaket (consignments, cancellations, returns)

Syntax
$Obj->sendNotification( $aOrderDocuments, $Event, $hInfo );
Input
$aOrderDocuments (ref.array.DE_EPAGES::Order::API::Object::CustomerOrder)
Order Documents
$Event (string)
event. Possible values are: Consignment, Cancellation, Return
$hInfo (ref.hash)
Additional info, if needed by notification type

upload

uploads offer information

Syntax
$Obj->upload( $aOffers, $aUpdateElements, $Event );
Input
$aOffers (array.ref.DE_EPAGES::MeinPaket::API::Object::MeinPaketOffer)
MeinPaketOffer list
$aUpdateElements (array.ref.string)
subset of attributes to update
$Event (string)
event