Plentymarkets interface documentation

System

Contracts

SystemInformationRepositoryContract

Repository for SystemInformation

Namespace

Plenty\Modules\System\Contracts

Methods
public loadValue($key):void

Loads a system information value by key

Parameters

Name

Type

Description

$key

string

WebstoreConfigurationRepositoryContract

Repository for Webstore Configuration

Namespace

Plenty\Modules\System\Contracts

Methods
public findByPlentyId($plentyId):Plenty\Modules\System\Models\WebstoreConfiguration
Return type: WebstoreConfiguration

Get the WebstoreConfiguration by plentyId

Parameters

Name

Type

Description

$plentyId

int

public findByWebstoreId($webstoreId):Plenty\Modules\System\Models\WebstoreConfiguration
Return type: WebstoreConfiguration

Get the WebstoreConfiguration by webstoreId

Parameters

Name

Type

Description

$webstoreId

int

public updateByPlentyId($data, $plentyId):Plenty\Modules\System\Models\WebstoreConfiguration
Return type: WebstoreConfiguration
Parameters

Name

Type

Description

$data

array

$plentyId

int

WebstoreRepositoryContract

Repository for Webstore

Namespace

Plenty\Modules\System\Contracts

Methods
public loadAll($columns = []):array

Shows all webstores

Parameters

Name

Type

Description

$columns

array

public loadAllPreview():array

Shows a preview of all webstores with id and name

public findByPlentyId($plentyId):Plenty\Modules\System\Models\Webstore
Return type: Webstore

Shows a specific webstore from type plentymarkets

Parameters

Name

Type

Description

$plentyId

int

public findByStoreIdentifier($storeIdentifier):Plenty\Modules\System\Models\Webstore
Return type: Webstore

Shows a specific webstore

Parameters

Name

Type

Description

$storeIdentifier

int

public findById($clientId):Plenty\Modules\System\Models\Webstore
Return type: Webstore

Shows a specific webstore

Parameters

Name

Type

Description

$clientId

int

The client ID (webstore ID).

Events

AfterPluginSetAssociated

Event after a plugin set is assigned to a webstore.

Namespace

Plenty\Modules\System\Events

Methods
public getWebstore():Plenty\Modules\System\Models\Webstore
Return type: Webstore

Get the webstore the plugin set was associated with.

public getPluginSet():Plenty\Modules\Plugin\PluginSet\Models\PluginSet
Return type: PluginSet

Get the newly associated plugin set.

Models

Webstore

The webstore model appending the WebstoreConfiguration

Namespace

Plenty\Modules\System\Models

Properties
Name Type Description

id

int

The ID of the client (store)

name

string

The name of the client (store)

type

string

The type of the client (store)

storeIdentifier

int

The identifier of the client (store)

configuration

WebstoreConfiguration

The configuration information of the client (store)

locations

The accounting locations of the client (store)

pluginSet

PluginSet

The plugin set of the client (store)

pluginSetId

int

The plugin set id of the client (store)

Methods
public toArray()

Returns this model as an array.

WebstoreConfiguration

The Webstore Configuration Model

Namespace

Plenty\Modules\System\Models

Properties
Name Type Description

webstoreId

int

error404ContentPageId

int

attributesDropDown

int

attributeSelectDefaultOption

int

attributeVariantCheck

int

attributeWithMarkup

int

bankContentPageId

int

basketReservationTime

int

cancellationRightsContentPageId

int

categoryItemCount

int

categoryLevelLimit

int

closed

int

defaultAccountingLocation

int

defaultCurrency

string

defaultLanguage

string

defaultLayout

string

defaultShippingCountryId

int

defaultShippingCountryList

array

defaultCurrencyList

array

defaultParcelServiceId

int

defaultParcelServicePresetId

int

defaultMethodOfPaymentId

int

defaultCustomerClassId

int

dhlPackstationValidation

int

dhlAllowPackstationActive

int

dhlLimitOrderAmountForPackstation

float

dhlAllowPostidentActive

int

displayAttributeMarkup

float

displayItemName

string

displayItemOnly4Customer

int

displayPriceColumn

int

displayPriceNetto

int

doctype

string

domain

string

domainSsl

string

dontSplitItemBundle

int

faviconPath

string

frontPageContentPageId

int

helpContentPageId

int

itemNotFoundContentPageId

int

paymentMethodsContentPageId

int

contactContentPageId

int

legalDisclosureContentPageId

int

blogRatingActive

int

blogMaxRatingPoints

int

blogCommentsActive

int

blogNewFeedbackVisibility

int

blogCustomerNameVisibility

int

itemMaxRatingPoints

int

itemCommentsActive

int

itemNewFeedbackVisibility

int

itemCustomerNameVisibility

int

categoryRatingActive

int

categoryMaxRatingPoints

int

categoryCommentsActive

int

categoryNewFeedbackVisibility

int

categoryCustomerNameVisibility

int

choiceNominationRatingActive

int

choiceNominationMaxRatingPoints

int

choiceNominationCommentsActive

int

choiceNominationNewFeedbackVisibility

int

choiceNominationCustomerNameVisibility

int

feedbackRatingActive

int

feedbackMaxRatingPoints

int

feedbackCommentsActive

int

feedbackNewFeedbackVisibility

int

feedbackCustomerNameVisibility

int

languageList

array

languageMode

int

loginMode

int

oversellingWarning

int

maxLoginAttempts

int

mobileRedirectActive

int

mobileRedirectUrl

int

mobileRedirectItemUrl

int

name

string

newsletterDirId

int

paypalAccount

int

ebayAccount

array

privacyPolicyContentPageId

int

rootDir

string

sessionLifetime

int

shippingContentPageId

int

socialMedia

int

termsConditionsContentPageId

int

trustedShopsCertificationDeSealHtml

string

trustedShopsCertificationDeTrustedShopsId

string

trustedShopsCertificationEnSealHtml

string

trustedShopsCertificationEnTrustedShopsId

string

trustedShopsCertificationFrSealHtml

string

trustedShopsCertificationFrTrustedShopsId

string

urlFacebook

string

urlFileExtension

string

urlGooglePlus

string

urlItemCategory

string

urlItemContent

string

urlLinking

string

urlNeedle

string

urlTitleItemContent

string

urlTitleItemName

string

urlTwitter

string

useCharacterCrossSelling

int

useDefaultShippingCountryAsShopCountry

int

calcEbayShippingCostsActive

int

autoGroupOpenEbayTransactions

int

calcRicardoShippingCostsActive

int

calcHoodShippingCostsActive

int

ebayDownsellingActive

int

addressCheckRegistrationSave

int

addressCheckRegistrationInput

int

addressCheckInvoiceDetailsSave

int

addressCheckInvoiceDetailsInput

int

addressCheckShippingDetailsSave

int

addressCheckShippingDetailsInput

int

addressCheckCustomerDetailsSave

int

addressCheckCustomerDetailsInput

int

addressCheckAfterDays

int

facebookLoginActive

int

itemCategorySorting1

int

itemCategorySorting2

int

itemSortByMonthlySales

int

showBasePriceActive

int

jumpPaymentActive

int

jumpShippingActive

int

showContentTermsFsk

int

newsletterRegistrationActive

int

ignoreCouponMinOrderValueActive

int

ipAddressSaveInactive

int

reuseOrderActive

int

editOrderActive

int

currencySymbol

int

externalVatCheckInactive

int

externalVatCheckServiceUnavailableFallbackStatus

float

customerRegistrationCheck

int

schedulerPropertyID

int

customerLoginMethod

int

watchlistActive

int

itemwishlistActive

int

documentsActive

int

dynamicExportActive

int

couponVisibilityActive

int

retoureMethod

int

itemlistPrice

int

itemlistWeight

int

schedulerActive

int

editSchedulerPaymentMethodActive

int

showSEPAMandateDownload

int

changeEmailActive

int

changePasswordActive

int

changePasswordSendmail

int

logoutHiddenActive

int

displayStatusInactive

int

displayMyAccountPaymentDateInactive

int

displayMyAccountDeliveryDateInactive

int

displayWeightInactive

int

displayInvoiceDownload

int

displayShippingDateActive

int

minimumOrderValue

int

itemAvailabilityDisabledList

array

itemMeasureUnit

array

quickloginValidDays

int

captchaCodeInactive

int

itemListingOrderImportItemName

int

orderRowDeliveryDate

int

browserLanguage

array

categoryRedirectActive

int

itemRedirectActive

int

googleRecaptchaApiWebsitekey

string

itemSearchEngine

string

itemRatingAllowComments

bool

itemRatingMaxRatingPoints

bool

itemRatingActive

bool

currencyConversion

int

urlTrailingSlash

int

isCookieSubdomainIndependent

bool

useVariationOrderProperties

bool

itemSearchOperator

string

itemAutocompleteSearchOperator

string

Methods
public toArray()

Returns this model as an array.

Module

Contracts

PlentyModuleRepositoryContract

Repository for PlentyModule

Namespace

Plenty\Modules\System\Module\Contracts

Methods
public isActive($module):bool

Returns whether or not a given module is active

Parameters

Name

Type

Description

$module

string

The keyPath for the module

public isHidden($module):bool

Returns whether or not a given module is hidden

Parameters

Name

Type

Description

$module

string

The keyPath for the module

public getQuantity($module):int

Get the 'quantity' attribute of the given module

Parameters

Name

Type

Description

$module

string

keyPath of the module in Question

public getValueForModule($module, $value):void

Get any value for any module

Parameters

Name

Type

Description

$module

string

The keyPath of the module

$value

string

The key for the value

Statistic

Models

CloudMetrics

Represent cloud metrics for a specific day

Namespace

Plenty\Modules\System\Statistic\Models

Properties
Name Type Description

plentyId

int

date

string

webspaceMB

int

webspaceDocumentsMB

int

websiteContentMB

int

cloudSpaceDocumentsMB

int

cloudSpaceItemsMB

int

cloudSpacePrivateMB

int

cloudSpacePublicMB

int

dbSpaceMb

int

websiteTrafficMB

int

cdnTrafficMB

int

cdnTrafficCount

int

contentCachingPutRequests

int

contentCachingGetRequests

int

userAccounts

int

warehouses

int

warehousesSales

int

facetSearchItems

int

facetSearchCalls

int

items

int

itemVariations

int

hbciDailyAccounts

int

hbciHourlyAccounts

int

ebicsDailyAccounts

int

ebicsHourlyAccounts

int

emailAccountsWithTicketGeneration

int

ebayAccountsWithTicketGeneration

int

Methods
public toArray()

Returns this model as an array.

CloudMetricsList

Represent a list of cloud metrics objects

Namespace

Plenty\Modules\System\Statistic\Models

Properties
Name Type Description

page

int

totalsCount

int

isLastPage

bool

objects

array

Methods
public toArray()

Returns this model as an array.