Plentymarkets interface documentation

Contracts

Category

CategoryDetailRepositoryContract

To be written…​

Namespace

Plenty\Modules\Pim\Contracts\Category

Methods
Return type: Collection

Search category details

Parameters

Name

Type

Description

$with

array

$page

int

$perPage

int

public getCount():int
public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

CategoryRepositoryContract

To be written…​

Namespace

Plenty\Modules\Pim\Contracts\Category

Methods
Return type: Collection

Search for categories

Parameters

Name

Type

Description

$with

array

$page

int

$perPage

int

$sorting

array

public getById($id, $with = []):Plenty\Modules\Category\Models\Category
Return type: Category

Get one category by ID

Parameters

Name

Type

Description

$id

int

$with

array

public getCount():int
public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Variation

PropertySelectionValue

The Property selection values of the variation

Namespace

Plenty\Modules\Pim\DocumentService\Models\Variation

Properties
Name Type Description

id

int

The id of the relation selection value

selectionId

int

The selection id of the relation selection value

Methods
public toArray()

Returns this model as an array.

PropertyValue

The Property values of the variation

Namespace

Plenty\Modules\Pim\DocumentService\Models\Variation

Properties
Name Type Description

id

int

The id of the relation value

lang

string

The lang of the relation value

value

string

The value of the relation value

description

string

The description of the relation value

Methods
public toArray()

Returns this model as an array.

SearchService

Aggregations

AttributeValueAggregation

Aggregate data by attributeValue ids

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods
public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public setInclude($string):void
Parameters

Name

Type

Description

$string

string

public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

CategoryAllTermsAggregation

Aggregate data by all category ids

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods
public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public setInclude($string):void
Parameters

Name

Type

Description

$string

string

public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

CategoryPathTermsAggregation

Aggregate data by all category paths

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods
public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public setInclude($string):void
Parameters

Name

Type

Description

$string

string

public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

ItemCardinalityAggregation

Get the count of found items

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods
public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

ItemIdTermsAggregation

Aggregate data by item ids

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods
public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public setInclude($string):void
Parameters

Name

Type

Description

$string

string

public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

SalableFilterAggregation

Filter Aggregated Data if variation is salable

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods
public getName():string

Get the name of the aggregation

public getAggregation():array
public addFilter($filter):void
Parameters

Name

Type

Description

$filter

TypeInterface

public setIndex($index):void
Parameters

Name

Type

Description

$index

public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

UnitCombinationAggregation

Aggregate data by unit combination ids

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods
public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public setInclude($string):void
Parameters

Name

Type

Description

$string

string

public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

Filter

AmazonFilter

Includes filters for amazon

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasAnyFlatFile($flatFiles):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the specified flatFiles.

Parameters

Name

Type

Description

$flatFiles

array

public hasAnyProductType($productTypes):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the specified productTypes.

Parameters

Name

Type

Description

$productTypes

array

public hasAnyProductTypeId($productTypeIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the specified typeIds.

Parameters

Name

Type

Description

$productTypeIds

array

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

AttributeFilter

Includes filters for attributes

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasAttribute($attributeId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the specified attributeId.

Parameters

Name

Type

Description

$attributeId

int

public hasAnyAttribute($attributeIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the specified attributeId.

Parameters

Name

Type

Description

$attributeIds

array

public hasAllAttributes($attributeIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to has all of the specified attributeId.

Parameters

Name

Type

Description

$attributeIds

array

public hasAttributeValue($attributeValueId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the specified attributeValueId.

Parameters

Name

Type

Description

$attributeValueId

int

public hasAnyAttributeValue($attributeValueIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the specified attributeValueId.

Parameters

Name

Type

Description

$attributeValueIds

array

public hasAllAttributeValues($attributeValueIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have all of the specified attributeValueId.

Parameters

Name

Type

Description

$attributeValueIds

array

public hasNoAttributeValue():void

Restricts the result to have no attribute value.

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

BarcodeFilter

Includes filters for barcodes

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasCode($code, $precision):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have a specified code.

Parameters

Name

Type

Description

$code

$precision

string

public hasType($type):void

Restricts the result to have a specified type. Not implemented.

Parameters

Name

Type

Description

$type

string

public hasId($id):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have a specified id.

Parameters

Name

Type

Description

$id

int

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

CategoryFilter

Includes filters for categories

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public isInAtLeastOneCategory($categoryIds, $depth = self::DEPTH_ANY):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the categoryIds.

Parameters

Name

Type

Description

$categoryIds

array

$depth

string

public static getPathByDepth($depth):string

Get the path by depth.

Parameters

Name

Type

Description

$depth

string

public isInEachCategory($categoryIds, $depth = self::DEPTH_ANY):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have all of the categoryIds.

Parameters

Name

Type

Description

$categoryIds

array

$depth

string

public isInCategory($categoryId, $depth = self::DEPTH_ANY):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the categoryId.

Parameters

Name

Type

Description

$categoryId

int

$depth

string

public isInACategory():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have a category.

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

CharacteristicFilter

Includes filters for characteristics

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasAtLeastOneProperty($ids):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the characteristicIds.

Parameters

Name

Type

Description

$ids

array

public hasEachProperty($ids):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have all of the characteristicIds.

Parameters

Name

Type

Description

$ids

array

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

ClientFilter

Includes filters for clients

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public isVisibleForClient($clientId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the clientId.

Parameters

Name

Type

Description

$clientId

int

public isVisibleForAtLeastOneClient($clientIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the clientIds.

Parameters

Name

Type

Description

$clientIds

array

public isVisibleForAllClients($clientIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have all of the clientIds.

Parameters

Name

Type

Description

$clientIds

array

public hasAutomaticClientVisibility($values):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the automaticClientVisibilities. (-1, 0, 1, 2)

Parameters

Name

Type

Description

$values

array

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

CrossSellingFilter

Includes filters for cross selling

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getPath():string

get the nested path of the filter

public hasItemId($itemId):void

Restricts the result to have the itemId linked

Parameters

Name

Type

Description

$itemId

int

public hasRelation($relation):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the relation

Parameters

Name

Type

Description

$relation

string

public hasAnyRelation($relations):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any relation

Parameters

Name

Type

Description

$relations

array

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

FacetFilter

Includes filters for facets

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasAtLeastOneFacet($facetIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the facetIds.

Parameters

Name

Type

Description

$facetIds

array

public hasEachFacet($facetIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have all facetIds.

Parameters

Name

Type

Description

$facetIds

array

public hasFacet($facetIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the facetIds.

Parameters

Name

Type

Description

$facetIds

int

public hasFacetValue($facetValueId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the facetValueId.

Parameters

Name

Type

Description

$facetValueId

int

public hasAFacet():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the facetValueIds.

public hasAtLeastOneFacetValue($valueIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the facetValueIds.

Parameters

Name

Type

Description

$valueIds

array

public hasEachFacetValue($valueIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have all the facetValueIds.

Parameters

Name

Type

Description

$valueIds

array

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

FeedbackRangeFilter

Includes filters for feedback

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasFeedbackGreaterThan($value):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have feedback greater than or equal the value.

Parameters

Name

Type

Description

$value

int

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

ItemCreatedAtFilter

Used to filter by item created at timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

ItemFilter

Includes filters for the item

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasId($id):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the item id.

Parameters

Name

Type

Description

$id

int

public hasIds($ids):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have all the item ids.

Parameters

Name

Type

Description

$ids

array

public hasAnImage():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have an image.

public hasFlag1($flagId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the specified flag 1.

Parameters

Name

Type

Description

$flagId

int

public hasFlag2($flagId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the specified flag 2.

Parameters

Name

Type

Description

$flagId

int

public hasManufacturer($manufacturerId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the manufacturer id.

Parameters

Name

Type

Description

$manufacturerId

int

public hasManufacturers($manufacturerIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the manufacturer ids.

Parameters

Name

Type

Description

$manufacturerIds

array

public hasAManufacturer():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have an manufacturer.

public isItemType($itemType):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the specified item type.

Parameters

Name

Type

Description

$itemType

string

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

ItemLastUpdatedAtFilter

Used to filter by item last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

ItemRangeFilter

used to filter the range between item ids

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

ItemUpdatedAtFilter

Used to filter by item created at timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string
public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

MarketFilter

Includes filters for markets

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public isVisibleForMarket($marketId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the market id.

Parameters

Name

Type

Description

$marketId

float

public isVisibleForAtLeastOneMarket($marketIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the market ids.

Parameters

Name

Type

Description

$marketIds

array

public isVisibleForAllMarkets($marketIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have all the market ids.

Parameters

Name

Type

Description

$marketIds

array

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

PriceFilter

Includes filters for prices

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getPath():string

Get the path of the filter

public between($min = null, $max = null):void

Restricts the result to have a price between the specified min and max value.

Parameters

Name

Type

Description

$min

float

$max

float

public betweenByPriceId($priceIds = [], $min = null, $max = null):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to a price between the specified min and max value. The price must be related to one of the specified price ids.

Parameters

Name

Type

Description

$priceIds

array

$min

float

$max

float

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

PropertyFilter

Includes filters for Properties

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasPropertySelection($id):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the property selection id.

Parameters

Name

Type

Description

$id

int

public hasAtLeastOnePropertySelection($ids):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the property selection ids.

Parameters

Name

Type

Description

$ids

array

public hasEachPropertySelection($ids):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have all of the property selection ids.

Parameters

Name

Type

Description

$ids

array

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

SalesPriceFilter

Includes filters for salesPrices

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasAtLeastOnePrice($priceIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the price ids.

Parameters

Name

Type

Description

$priceIds

array

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

SkuFilter

Includes filters for skus

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getPath():string

Get the path of the filter.

public hasMarketId($marketId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have a sku with the market referrer id.

Parameters

Name

Type

Description

$marketId

float

public hasAccountId($accountId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have a sku with the account id.

Parameters

Name

Type

Description

$accountId

int

public hasStatus($status):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have a sku with the status.

Parameters

Name

Type

Description

$status

string

public hasSku($sku):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have a specified sku.

Parameters

Name

Type

Description

$sku

string

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

SupplierFilter

Includes filters for supplier

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public matchSupplierItemNumber($term, $precision = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SEARCH_TYPE_EXACT):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter
Parameters

Name

Type

Description

$term

string

$precision

string

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

TagFilter

Includes filters for tags

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasTag($tagId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the tag id.

Parameters

Name

Type

Description

$tagId

int

public hasAnyTag($tagIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the tag ids.

Parameters

Name

Type

Description

$tagIds

array

public hasAllTags($tagIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have all of the tag ids.

Parameters

Name

Type

Description

$tagIds

array

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

TextFilter

Includes filters for texts

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasAnyName():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any name.

public hasNameInLanguage($lang = "de", $filter = self::FILTER_ANY_NAME):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have specific or any name in language: Possible filter are hasAnyNameInLanguage, hasName1InLanguage, hasName2InLanguage, hasName3InLanguage.

Parameters

Name

Type

Description

$lang

string

$filter

string

public matchAnyName($lang, $term, $precision = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SEARCH_TYPE_EXACT):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter
Parameters

Name

Type

Description

$lang

string

$term

string

$precision

string

public matchName1($lang, $term, $precision = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SEARCH_TYPE_EXACT):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter
Parameters

Name

Type

Description

$lang

string

$term

string

$precision

string

public matchName2($lang, $term, $precision = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SEARCH_TYPE_EXACT):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter
Parameters

Name

Type

Description

$lang

string

$term

string

$precision

string

public matchName3($lang, $term, $precision = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SEARCH_TYPE_EXACT):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter
Parameters

Name

Type

Description

$lang

string

$term

string

$precision

string

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

public static isLanguageSupported($lang):bool
Parameters

Name

Type

Description

$lang

string

public static isLanguageActivated($lang):bool
Parameters

Name

Type

Description

$lang

string

public static getM10lByLanguage($lang, $fallback = "en"):string
Parameters

Name

Type

Description

$lang

string

$fallback

string

public static getLanguageByM10l($lang, $fallback = "english"):string
Parameters

Name

Type

Description

$lang

string

$fallback

string

VariationAvailabilityUpdatedAtFilter

Used to filter by variation availability last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationBarcodeUpdatedAtFilter

Used to filter by variation barcode last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationBaseFilter

Includes filters for the base variation

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasNumber($number, $precision):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the number. Possible precisions are: exact, fuzzy and autocomplete

Parameters

Name

Type

Description

$number

string

$precision

string

public hasAnyNumber($numbers):void

Restricts the result to have any of the numbers.

Parameters

Name

Type

Description

$numbers

array

public isActive():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have active variations only.

public isInactive():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have inactive variations only.

public hasId($id):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the variation id.

Parameters

Name

Type

Description

$id

int

public hasIds($ids):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the variation ids.

Parameters

Name

Type

Description

$ids

array

public hasItemId($itemId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the item id.

Parameters

Name

Type

Description

$itemId

int

public hasAnyPriceCalculationId():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the any price calculation id

public hasPriceCalculationIds($ids):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the any of the price calculation ids

Parameters

Name

Type

Description

$ids

array

public hasItemIds($itemIds):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the any of the item ids

Parameters

Name

Type

Description

$itemIds

array

public isMain():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have no child's

public isChild():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have child's only

public isSalable($bool = true):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result whether is salable or not.

Parameters

Name

Type

Description

$bool

bool

public isHiddenInCategoryList($bool = true):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result whether is hidden in category list or not.

Parameters

Name

Type

Description

$bool

bool

public hasADescriptionInLanguage($language):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

This filter is not implemented. Deprecated.

Parameters

Name

Type

Description

$language

string

public hasAnImageOrItemHasAnImage():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have an image.

public hasAnImage():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have an item image.

public hasManufacturer($manufacturerId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the manufacturer.

Parameters

Name

Type

Description

$manufacturerId

int

public hasSupplier($supplierId):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the supplier.

Parameters

Name

Type

Description

$supplierId

int

public hasAtLeastOneAvailability($availabilities):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have any of the availabilities.

Parameters

Name

Type

Description

$availabilities

array

public hasActiveChildren($bool = true):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have active child variations or not.

Parameters

Name

Type

Description

$bool

bool

public hasChildren($bool = true):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have child variations or not.

Parameters

Name

Type

Description

$bool

bool

public hasCustomsTariffNumber($customsTariffNumber):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the customs tariff number.

Parameters

Name

Type

Description

$customsTariffNumber

string

public customsTariffNumberNotExists():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have no customs tariff number.

public customsTariffNumberExists():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have a customs tariff number.

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationBundleFilter

Includes filters for bundles

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public hasBundleType($bundleType):Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the bundle type.

Parameters

Name

Type

Description

$bundleType

string

public hasNoBundleType():Plenty\Modules\Pim\SearchService\Filter
Return type: Filter

Restricts the result to have the no bundle type.

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationCategoryUpdatedAtFilter

Used to filter by variation category last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationClientUpdatedAtFilter

Used to filter by variation client last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationCreatedAtFilter

Used to filter by variation created at timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationLastUpdatedAtFilter

Used to filter by variation last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationMarketUpdatedAtFilter

Used to filter by variation market last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationPropertyUpdatedAtFilter

Used to filter by variation property last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationSalesPriceUpdatedAtFilter

Used to filter by variation saleyPrice last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationStockUpdatedAtFilter

Used to filter by variation stock last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationSupplierUpdatedAtFilter

Used to filter by variation supplier last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationTagUpdatedAtFilter

Used to filter by variation tag last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

VariationWarehouseUpdatedAtFilter

Used to filter by variation warehouse last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

Query

ManagedSearchQuery

Used to search for variations by a specified term.

Namespace

Plenty\Modules\Pim\SearchService\Query

Methods
public setLang($lang):void

Sets the language to search in.

Parameters

Name

Type

Description

$lang

string

public toArray():array

Returns the search query as array.

public setOperator($operator):void

Set the operator for the terms in the search query. Possible values: or, and

Parameters

Name

Type

Description

$operator

string

public setFuzzy($fuzzy):void

Set whether this is a fuzzy search or not.

Parameters

Name

Type

Description

$fuzzy

string

public addFilterField($field, $boost):void

Add a filter field to search in.

Parameters

Name

Type

Description

$field

string

$boost

int

public addMultilingualField($field, $language, $boost):void

Add a multilingual field to search in.

Parameters

Name

Type

Description

$field

string

$language

string

$boost

int

public addOtherAnalyzedField($field, $boost):void

Add a other analyzed field to search in.

Parameters

Name

Type

Description

$field

string

$boost

int

public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

public static isLanguageSupported($lang):bool
Parameters

Name

Type

Description

$lang

string

public static isLanguageActivated($lang):bool
Parameters

Name

Type

Description

$lang

string

public static getM10lByLanguage($lang, $fallback = "en"):string
Parameters

Name

Type

Description

$lang

string

$fallback

string

public static getLanguageByM10l($lang, $fallback = "english"):string
Parameters

Name

Type

Description

$lang

string

$fallback

string

SearchQuery

Used to search for variations by a specified term.

Namespace

Plenty\Modules\Pim\SearchService\Query

Methods
public setOperator($operator):void

Set the operator for the terms in the search query. Possible values: or, and

Parameters

Name

Type

Description

$operator

string

public setFuzzy($fuzzy):void

Set whether this is a fuzzy search or not.

Parameters

Name

Type

Description

$fuzzy

string

public addFilterField($field, $boost):void

Add a filter field to search in.

Parameters

Name

Type

Description

$field

string

$boost

int

public addMultilingualField($field, $language, $boost):void

Add a multilingual field to search in.

Parameters

Name

Type

Description

$field

string

$language

string

$boost

int

public addOtherAnalyzedField($field, $boost):void

Add a other analyzed field to search in.

Parameters

Name

Type

Description

$field

string

$boost

int

public toArray():array
public addStatement($statement):void
Parameters

Name

Type

Description

$statement

StatementInterface

public addQuery($statement):void
Parameters

Name

Type

Description

$statement

public static isLanguageSupported($lang):bool
Parameters

Name

Type

Description

$lang

string

public static isLanguageActivated($lang):bool
Parameters

Name

Type

Description

$lang

string

public static getM10lByLanguage($lang, $fallback = "en"):string
Parameters

Name

Type

Description

$lang

string

$fallback

string

public static getLanguageByM10l($lang, $fallback = "english"):string
Parameters

Name

Type

Description

$lang

string

$fallback

string

Aggregations

Facet

NestedFacetValuesAggregation

Provides a list of all facet value ids of a specific facet

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Facet

Methods
public getName():string

Get the name of the aggregation

public getAggregation():array

Get the aggregation as array

public toArray():array

Returns the aggregation as array

public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

Feedback

FeedbackRangeAggregation

Provides the count feedbacks in specific ranges (1 to 6, 2 to 6, 3 to 6, 4 to 6 and 5 to 6)

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Feedback

Methods
public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getRanges():array

Get the ranges of the aggregation

public getAggregation():void
public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

Price

ItemMinPriceAggregation

Get min price by price id for found variations

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Price

Methods
public getName():string

Get the name of the aggregation

public getAggregation():array

Get the aggregation as array

public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

PriceRangeAggregation

Get price range for found variations

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Price

Methods
public getName():string

Get the name of the aggregation

public setPriceIds($ids):void

Set the price ids which should be aggregated

Parameters

Name

Type

Description

$ids

array

public process($data):array

Process the provided data

Parameters

Name

Type

Description

$data

array

public getAggregation():array

Get the aggregation as array

public toArray():array
public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

Processors

AttributeValueAggregationProcessor

Processor for AttributeValueAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods
public process($data):array

Processes the data provided by the aggregation

Parameters

Name

Type

Description

$data

array

public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

CategoryAllTermsAggregationProcessor

Processor for CategoryAllTermsAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods
public process($data):array

Processes the data provided by the aggregation

Parameters

Name

Type

Description

$data

array

public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

CategoryPathTermsAggregationProcessor

Processor for CategoryAllTermsAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods
public process($data):array

Processes the data provided by the aggregation

Parameters

Name

Type

Description

$data

array

public getName():string

Get the name of the aggregation

public setFullPath($fullPath):Plenty\Modules\Pim\SearchService\Aggregations\Processors\CategoryPathTermsAggregationProcessor
Return type: CategoryPathTermsAggregationProcessor

Set if the full path should be used, or only the last element

Parameters

Name

Type

Description

$fullPath

bool

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

FacetAggregationProcessor

Processor for MultiAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods
public process($data):array

Processes the data provided by the aggregation

Parameters

Name

Type

Description

$data

array

public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

FeedbackRangeAggregationProcessor

Processor for FeedbackRangeAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods
public process($data):array

Processes the data provided by the aggregation

Parameters

Name

Type

Description

$data

array

public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

ItemCardinalityAggregationProcessor

Processor for ItemCardinalityAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods
public process($data):array

Processes the data provided by the aggregation

Parameters

Name

Type

Description

$data

array

public getDependencies():array

Get dependencies of the aggregation

public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

ItemIdTermsAggregationProcessor

Processor for ItemIdTermsAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods
public process($data):array

Processes the data provided by the aggregation

Parameters

Name

Type

Description

$data

array

public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

ItemMinPriceAggregationProcessor

Processor for ItemMinPriceAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods
public process($data):array

Processes the data provided by the aggregation

Parameters

Name

Type

Description

$data

array

public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

SalableFilterAggregationProcessor

Processor for SalableFilterAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods
public process($data):array

Processes the data provided by the aggregation

Parameters

Name

Type

Description

$data

array

public getName():string

Get the name of the aggregation

public addSubProcessor($processor):void

Add a sub processor to this processor

Parameters

Name

Type

Description

$processor

ProcessorInterface

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

SearchSuggestionsTermsAggregationProcessor

Processor for SearchSuggestionsTermsAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods
public process($data):array

Processes the data provided by the aggregation

Parameters

Name

Type

Description

$data

array

public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

UnitCombinationAggregationProcessor

Processor for UnitCombinationAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods
public process($data):array

Processes the data provided by the aggregation

Parameters

Name

Type

Description

$data

array

public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

SearchSuggestions

SearchSuggestionsTermsAggregation

Get suggestions for found variations, use setInclude to filter them.

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\SearchSuggestions

Methods
public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public setInclude($string):void
Parameters

Name

Type

Description

$string

string

public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void
public static isLanguageSupported($lang):bool
Parameters

Name

Type

Description

$lang

string

public static isLanguageActivated($lang):bool
Parameters

Name

Type

Description

$lang

string

public static getM10lByLanguage($lang, $fallback = "en"):string
Parameters

Name

Type

Description

$lang

string

$fallback

string

public static getLanguageByM10l($lang, $fallback = "english"):string
Parameters

Name

Type

Description

$lang

string

$fallback

string

VariationDataInterface

Contracts

AttributeInterface

The interface of all variation attributes

Namespace

Plenty\Modules\Pim\VariationDataInterface\Contracts

Methods
public getName():string

Get the name of the attribute

public static getVariationAttribute():string

Get the related key on the variation model.

public addLazyLoadParts($lazyLoadParts):Plenty\Modules\Pim\VariationDataInterface\Contracts
Return type: Contracts

Get all parts which should be lazy loaded.

Parameters

Name

Type

Description

$lazyLoadParts

array

public getLazyLoadParts():array

Get all parts which should be lazy loaded.

VariationDataInterfaceContract

Use this interface to load performant article data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Contracts

Methods
public getResult($context):Plenty\Modules\Pim\VariationDataInterface\Contracts\VariationDataInterfaceResultInterface
Return type: VariationDataInterfaceResultInterface

Get the result, using the context.

Parameters

Name

Type

Description

$context

VariationDataInterfaceContext

public getMultipleResults($contextList):array

Get the multiple results, using multiple contexts

Parameters

Name

Type

Description

$contextList

array

VariationDataInterfaceResultInterface

The Result of the variation data interface

Namespace

Plenty\Modules\Pim\VariationDataInterface\Contracts

Methods
public getContext():Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

Get the context which is uses for this result .

public total():int

Get the total found variations.

public get():void

Get all found variations as Traversable.

public getAdditionalData():array

Get additional data provided by the elasticsearch result

Model

Variation

The variation model, contains all possible informations of a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model

Properties
Name Type Description

id

int

The id of the variation.

additionalSkus

array

The additional skus of the variation.

attributeValues

array

The attribute values of the variation.

base

Base

The base data of the variation.

barcodes

array

The barcodes of the variation.

bundleComponents

array

The bundle components of the variation.

categories

array

The categories of the variation.

clients

array

The clients of the variation.

defaultCategories

array

The default categories of the variation.

images

array

The images of the variation.

markets

array

The markets of the variation.

marketIdentNumbers

array

The market ident numbers of the variation.

salesPrices

array

The sales prices of the variation.

skus

array

The skus of the variation.

supplier

array

The supplier of the variation.

timestamps

Timestamp

The timestamps of the variation.

warehouses

array

The warehouses of the variation.

unit

Unit

The unit of the variation.

tags

array

The tags of the variation.

comments

array

The comments of the variation.

properties

array

The properties of the variation.

elasticSearchSource

array

Methods
public toArray()

Returns this model as an array.

VariationDataInterfaceContext

The Conext to define what you get frome the VDI

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model

Methods
public addFilter($filter):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

Add filter to restrict the result.

Parameters

Name

Type

Description

$filter

TypeInterface

public setFilter($filter):Plenty\Modules\Pim\VariationDataInterface\Model
Return type: Model
Parameters

Name

Type

Description

$filter

Collection

public addAggregation($aggregation):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

Add aggregation to aggregate the result.

Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSuggestion($suggestion):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

Add suggestion to get suggestions in the result.

Parameters

Name

Type

Description

$suggestion

SuggestionInterface

public addQuery($filter):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

Add query to restrict the result. Queries affecting the score.

Parameters

Name

Type

Description

$filter

TypeInterface

public getFilter():Illuminate\Support\Collection
Return type: Collection

Get filters which are added to the context.

public getIds():void

Get ids which are added to the context.

public setIds($ids):void

Set ids. All other restrictions are ignored.

Parameters

Name

Type

Description

$ids

Collection

public getAggregations():void

Get aggregations which are added to the result.

public getSuggestions():void

Get suggestions which are added to the result.

public getQuery():void

Get queries which are added to the result.

public getParts():void

Get parts which are added to the result.

public addPart($part):void

Add part to the result. A part specifies what is returned in the result.

Parameters

Name

Type

Description

$part

AttributeInterface

public setParts($parts):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

Set parts. A part specifies what is returned in the result.

Parameters

Name

Type

Description

$parts

array

public getPlentyIds():void

Get plenty ids. No further functionality added yet

public setPlentyIds($plentyIds):void

Set plenty ids. No further functionality added yet

Parameters

Name

Type

Description

$plentyIds

Collection

public getLanguages():void

Get languages. No further functionality added yet

public setLanguages($languages):void

Set languages. No further functionality added yet

Parameters

Name

Type

Description

$languages

Collection

public getPage():int

Get the wanted page value.

public setPage($page = 1, $perPage = 50):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

Set the page and Items per page.

Parameters

Name

Type

Description

$page

int

$perPage

int

public getPerPage():int

Get the wanted per page value.

public isGetAllFound():bool

returns whether get all found or not

public setGetAllFound($getAll):Plenty\Modules\Pim\VariationDataInterface\Model
Return type: Model

set whether the result should return all found entities or not

Parameters

Name

Type

Description

$getAll

bool

public getBatchSize():int

Get the wanted batch size.

public setBatchSize($batchSize):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

Set the batch size of result batch.

Parameters

Name

Type

Description

$batchSize

int

public getContextId():string

Get the current context id.

public getGroupBy():Plenty\Modules\Pim\VariationDataInterface\Model\Context\GroupBy
Return type: GroupBy

Get the wanted group by or null if non is set.

public setGroupBy($groupBy):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

Set a group by for the result.

Parameters

Name

Type

Description

$groupBy

GroupBy

public getDecoratedReturnType():string

Get the decorated return type.

public getSorting():Plenty\Modules\Cloud\ElasticSearch\Lib\Sorting\SortingInterface
Return type: SortingInterface

Get the sorting the result should be sorted by.

public setSorting($sorting):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

SeSett the sorting the result should be sorted by.

Parameters

Name

Type

Description

$sorting

SortingInterface

public getScoreModifier():Plenty\Modules\Cloud\ElasticSearch\Lib\Query\Type\ScoreModifier\ScoreModifierInterface
Return type: ScoreModifierInterface

Get a score modifier. Score modifier are manipulation the score of the result hits.

public setScoreModifier($scoreModifier):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

Set a score modifier. Score modifier are manipulation the score of the result hits.

Parameters

Name

Type

Description

$scoreModifier

ScoreModifierInterface

public getAdditionalSource():Plenty\Modules\Cloud\ElasticSearch\Lib\Source\IndependentSource
Return type: IndependentSource

Get the additional source which should be added to the result.

public setAdditionalSource($additionalSource):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

Set the additional source which should be added to the result.

Parameters

Name

Type

Description

$additionalSource

IndependentSource

public hasAdditionalSource():bool

Returns whether the context has an additional source or not

public getUseInMemoryCache():bool

Returns whether the in memory cache should be used or not

public setUseInMemoryCache($useInMemoryCache):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

Set whether the in memory cache should be used or not. It is recommended to use this cache (Default)

Parameters

Name

Type

Description

$useInMemoryCache

bool

public isHasAdditionalSource():bool

Returns whether the context has an additional source or not

public setHasAdditionalSource($hasAdditionalSource):void

Set whether the context has an additional source or not. This is normally determined automatically

Parameters

Name

Type

Description

$hasAdditionalSource

bool

public getSearchAfterKey():string

Get the search after key.

public setSearchAfterKey($searchAfterKey):Plenty\Modules\Pim\VariationDataInterface\Model
Return type: Model

Set the search after key. Set null for the first page.

Parameters

Name

Type

Description

$searchAfterKey

string

public isSearchAfter():bool

Returns whether this is an search after search.

Model

Attributes

VariationAdditionalSkuAttribute

The additional sku part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationAttributeValueAttribute

The attribute part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationBarcodeAttribute

The barcode part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationBaseAttribute

The base part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationBundleComponentAttribute

The bundle component part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationCategoryAttribute

The category part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationClientAttribute

The client part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationCommentAttribute

The comment part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationDefaultCategoryAttribute

The default category part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationImageAttribute

The image part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationMarketAttribute

The market part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationMarketIdentNumberAttribute

The market ident number part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationPropertyAttribute

The property part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationSalesPriceAttribute

The sales price part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationSkuAttribute

The sku part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationSupplierAttribute

The supplier part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationTagAttribute

The tag part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationTimestampAttribute

The timestamp part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationUnitAttribute

The unit part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

VariationWarehouseAttribute

The warehouse part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods
public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters

Name

Type

Description

$lazyLoadParts

public getLazyLoadParts():void

Context

GroupBy

Group by the result, expects 2 params: field - the field which the result is grouped by, sorting - the inner sorting, must be instance of SortingInterface.)

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Context

Methods
public getField():string

Get the field the result should be grouped by.

DecoratedAttributes

AdditionalSku

contains informations about an additonal sku, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

id

int

The unique ID of the additional sku

marketId

float

The ID of the market

marketAccountId

int

The ID of the market account

sku

string

The additional sku for this variation.

Methods
public toArray()

Returns this model as an array.

AttributeValue

contains informations about an attribute value, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

with

With

attributeId

int

The unique ID of the attribute

attributeValueSetId

int

The unique ID of the attribute

valueId

int

The unique ID of the attribute value

Methods
public toArray()

Returns this model as an array.

Barcode

contains informations about a barcode, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

with

With

code

string

The code of the variation’s barcode. The combination of code and barcode ID must be unique.

barcodeId

int

The unique ID of the barcode linked to the variation. The combination of code and barcode ID must be unique.

Methods
public toArray()

Returns this model as an array.

Base

contains the basic informations of a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

with

With

isMain

bool

mainVariationId

int

itemId

int

position

int

isActive

bool

number

string

model

string

externalId

string

availability

int

estimatedAvailableAt

string

purchasePrice

float

movingAveragePrice

float

priceCalculationId

int

priceCalculationUUID

string

picking

string

stockLimitation

int

isVisibleIfNetStockIsPositive

string

isInvisibleIfNetStockIsNotPositive

string

isAvailableIfNetStockIsPositive

string

isUnavailableIfNetStockIsNotPositive

string

isVisibleInListIfNetStockIsPositive

string

isInvisibleInListIfNetStockIsNotPositive

string

mainWarehouseId

int

maximumOrderQuantity

float

minimumOrderQuantity

float

intervalOrderQuantity

float

availableUntil

string

releasedAt

string

name

string

weightG

int

weightNetG

int

widthMM

int

lengthMM

int

heightMM

int

extraShippingCharge1

float

extraShippingCharge2

float

unitsContained

int

palletTypeId

int

packingUnits

int

packingUnitsTypeId

int

transportationCosts

float

storageCosts

float

customs

float

operatingCosts

float

vatId

int

bundleType

string

automaticClientVisibility

int

automaticListVisibility

int

isHiddenInCategoryList

string

defaultShippingCosts

float

mayShowUnitPrice

string

parentVariationId

int

parentVariationQuantity

float

singleItemCount

int

hasCalculatedBundleWeight

string

hasCalculatedBundleNetWeight

string

hasCalculatedBundlePurchasePrice

string

hasCalculatedBundleMovingAveragePrice

string

customsTariffNumber

string

categoriesInherited

bool

referrerInherited

bool

clientsInherited

bool

salesPricesInherited

bool

supplierInherited

bool

warehousesInherited

bool

propertiesInherited

bool

tagsInherited

bool

Methods
public toArray()

Returns this model as an array.

BundleComponent

contains informations about a barcode, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

id

int

The unique ID of the variation bundle component

componentVariationId

int

The unique ID of the variation added as bundle component

componentQuantity

float

The quantity of the variation to be added as bundle component

Methods
public toArray()

Returns this model as an array.

Category

contains informations about a category, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

with

With

categoryId

int

The unique ID of the category

position

int

The position of the category

isNeckermannPrimary

string

Flag that indicates if the category is the primary category for the market Neckermann for this variation.

Methods
public toArray()

Returns this model as an array.

Client

contains informations about a client, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

plentyId

int

The unique ID of the client (store)

Methods
public toArray()

Returns this model as an array.

Comment

contains informations about a comment, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

id

int

userId

int

The unique ID of the user

text

string

isVisibleForContact

bool

Methods
public toArray()

Returns this model as an array.

DefaultCategory

contains informations about a default category, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

with

With

branchId

int

The unique ID of the category branch

plentyId

int

The unique plenty ID of the client (store)

manually

bool

Methods
public toArray()

Returns this model as an array.

Image

contains informations about an image, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

with

With

imageId

int

The unique ID of the image

Methods
public toArray()

Returns this model as an array.

Market

contains informations about an market, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

marketId

float

The unique ID of the market

Methods
public toArray()

Returns this model as an array.

MarketIdentNumber

contains informations about an market ident number, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

id

int

The unique id of the market ident number (ASIN/ePID)

countryId

int

The country code of the market ident number (ASIN/ePID)

type

string

The type of market ident number (ASIN/ePID)

position

int

The position of the market ident number (ASIN/ePID)

value

string

The value of the market ident number (ASIN/ePID)

Methods
public toArray()

Returns this model as an array.

Property

contains informations about a property, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

with

With

id

int

The unique ID of the property relation

propertyId

int

The unique ID of the property

groupId

int

The unique ID of the property group of the property

markup

float

The markup of the property relation

value

string

The value of the property relation

rawValue

string

The raw value of the property relation (read only)

values

array

The values of this relation

selectionValues

array

The selection values of this relation

Methods
public toArray()

Returns this model as an array.

SalesPrice

contains informations about a client, belongs to a salesPrice

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

with

With

salesPriceId

int

The unique ID of the sales price

price

float

The price of the variation saved for this sales price

Methods
public toArray()

Returns this model as an array.

Sku

contains informations about a sku, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

id

int

The ID of the sku

marketId

float

The ID of the market

accountId

int

The ID of the market account

initialSku

string

The initial SKU of the variation. The initial SKU cannot be modified even if the variation SKU is changed. However, it is possible to reset the variation SKU to the initial SKU.

sku

string

The SKU of the variation. The SKU is adjustable but may not exist twice for the combination of market Id and account Id.

parentSku

string

The Parent SKU of the variation. The Parent SKU is adjustable. The same Parent SKU value should be used on variations of same article.

isActive

bool

Flag that indicates if the item is ready for export (currently not in use).

exportedAt

string

The time the variation was last exported (YYYY-MM-DD HH:MM:SS).

stockUpdatedAt

string

deletedAt

string

The time the variation was deleted (YYYY-MM-DD HH:MM:SS).

status

string

The status of the variation after the export. Possible entries are INACTIVE, ERROR, SENT and ACTIVE.

additionalInformation

string

The field that contains additional information.

Methods
public toArray()

Returns this model as an array.

Supplier

contains informations about a supplier, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

with

With

id

int

The unique ID of the link between variation and supplier.

supplierId

int

The unique ID of the supplier.

purchasePrice

float

The price at which the variation was purchased from this supplier.

minimumPurchase

int

The minimum quantity of the variation that has to be ordered from the supplier. This value is also used as a quantity suggestion when creating reorders.

itemNumber

string

The external item number assigned to the variation by this supplier.

lastPriceQuery

string

The date of the last price query to this supplier. This helps to plan price negotiations.

deliveryTimeInDays

int

The delivery time in days for the variation saved for this supplier.

discount

float

The discount in percent the supplier grants for the variation.

isDiscountable

bool

Flag that indicates if the supplier’s discount for this variation is active.

packagingUnit

float

The packaging unit of the supplier if it differs from the packaging unit settings in plentymarkets.

currencyPurchasePrice

float

The price at which the variation was purchased from this supplier in the currency of the supplier.

itemDescription

string

The supplier item description.

Methods
public toArray()

Returns this model as an array.

Tag

contains informations about a tag, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

with

With

tagId

int

The unique ID of the tag

Methods
public toArray()

Returns this model as an array.

Timestamp

contains informations the timestamps of a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

availability

Carbon

The time the availability of the variation was last modified.

additionalSku

Carbon

The time any additional sku of the variation was last modified.

barcode

Carbon

The time any barcode of the variation was last modified.

base

Carbon

The time any field of the variation was last modified.

bundleComponent

Carbon

The time any bundle component of the variation was last modified.

category

Carbon

The time any category of the variation was last modified.

client

Carbon

The time any client of the variation was last modified.

defaultCategory

Carbon

The time any default category of the variation was last modified.

image

Carbon

The time any image of the variation was last modified.

market

Carbon

The time any market of the variation was last modified.

marketIdentNumber

Carbon

The time any market ident number of the variation was last modified.

related

Carbon

The time any relation of the variation was last modified.

salesPrice

Carbon

The time any sales price of the variation was last modified.

sku

Carbon

The time any sku of the variation was last modified.

supplier

Carbon

The time any supplier of the variation was last modified.

warehouse

Carbon

The time any warehouse of the variation was last modified.

property

Carbon

The time any property of the variation was last modified.

comment

Carbon

The time any comment of the variation was last added.

tag

Carbon

The time any tag of the variation was last modified.

createdAt

Carbon

The time any warehouse of the variation was last modified.

Methods
public toArray()

Returns this model as an array.

Unit

contains informations about the unit of the variaiton

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

with

With

unitId

int

The unique ID of the unit

content

float

The content

unitCombinationId

int

The unit combinationId

Methods
public toArray()

Returns this model as an array.

Warehouse

contains informations about a warehouse, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties
Name Type Description

with

With

warehouseId

int

The unique ID of the warehouse

warehouseZoneId

int

The unique ID of the warehouse zone

storageLocationType

string

The storage location type of the warehouse

reorderLevel

int

The reorder level for the variation in this warehouse

maximumStock

int

The maximum stock for the variation in this warehouse

stockTurnoverInDays

int

The stock turnover in days for the variation in this warehouse

storageLocation

int

The storage location of the variation in this warehouse

stockBuffer

int

The stock buffer for the variation in this warehouse

isBatch

bool

Is for warehouse and variation stock batch active

isBestBeforeDate

bool

Is for warehouse and variation stock best before date active

Methods
public toArray()

Returns this model as an array.

Decorators

AttributeValue

With

contains lazy loaded attribute data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\AttributeValue

Properties
Name Type Description

attribute

Attribute

attributeValue

AttributeValue

Methods
public toArray()

Returns this model as an array.

Barcode

With

contains lazy loaded barcode data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Barcode

Properties
Name Type Description

barcode

Barcode

Methods
public toArray()

Returns this model as an array.

Base

With

contains lazy loaded base data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Base

Properties
Name Type Description

item

Item

characteristics

array

crossSelling

array

texts

array

feedback

array

availability

Availability

shippingProfiles

array

images

array

stock

array

stockStorageLocations

array

serialNumbers

array

setConfig

ItemSetConfig

Methods
public toArray()

Returns this model as an array.

Category

With

contains lazy loaded category data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Category

Properties
Name Type Description

category

Category

categoryBranch

CategoryBranch

Methods
public toArray()

Returns this model as an array.

DefaultCategory

With

contains lazy loaded default category data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\DefaultCategory

Properties
Name Type Description

defaultCategory

Category

Methods
public toArray()

Returns this model as an array.

Images

With

contains lazy loaded image data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Images

Properties
Name Type Description

image

ItemImage

Methods
public toArray()

Returns this model as an array.

Property

With

contains lazy loaded property data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Property

Methods
public toArray()

Returns this model as an array.

SalesPrice

With

contains lazy loaded sales price data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\SalesPrice

Properties
Name Type Description

salesPrice

SalesPrice

Methods
public toArray()

Returns this model as an array.

Supplier

With

contains lazy loaded supplier data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Supplier

Properties
Name Type Description

supplier

Contact

Methods
public toArray()

Returns this model as an array.

Tag

With

contains lazy loaded tag data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Tag

Properties
Name Type Description

tag

Tag

Methods
public toArray()

Returns this model as an array.

Unit

With

contains lazy loaded unit data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Unit

Properties
Name Type Description

unit

Unit

Methods
public toArray()

Returns this model as an array.

Warehouse

With

contains lazy loaded warehouse data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Warehouse

Properties
Name Type Description

warehouse

Warehouse

Methods
public toArray()

Returns this model as an array.