Models

Variation

PropertyValue

Namespace

Plenty\Modules\Pim\DocumentService\Models\Variation

Properties

Type Name Description
string id The id of the relation value
string lang The lang of the relation value
string value The value of the relation value
string description 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
public getField():void
public getAggregation():array
public setInclude(string $string):void
Parameters
string $string
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

CategoryAllTermsAggregation

Aggregate data by all category ids

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():void
public getField():void
public getAggregation():array
public setInclude(string $string):void
Parameters
string $string
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

CategoryPathTermsAggregation

Aggregate data by all category paths

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():void
public getField():void
public getAggregation():array
public setInclude(string $string):void
Parameters
string $string
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

ItemCardinalityAggregation

Get the count of found items

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():void
public getField():void
public getAggregation():array
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

ItemIdTermsAggregation

Aggregate data by item ids

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():void
public getField():void
public getAggregation():array
public setInclude(string $string):void
Parameters
string $string
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

SalableFilterAggregation

Filter Aggregated Data if variation is salable

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():void
public getAggregation():array
public addFilter(TypeInterface
 $filter):void
Parameters
TypeInterface $filter
public setIndex($index):void
Parameters
$index
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

UnitCombinationAggregation

Aggregate data by unit combination ids

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():string
public getField():void
public getAggregation():array
public setInclude(string $string):void
Parameters
string $string
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

Filter

AmazonFilter

Includes filters for amazon

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasAnyFlatFile(array $flatFiles):Filter
Parameters
array $flatFiles
public hasAnyProductType(array $productTypes):Filter
Parameters
array $productTypes
public hasAnyProductTypeId(array $productTypeIds):Filter
Parameters
array $productTypeIds
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

AttributeFilter

Includes filters for attributes

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasAttribute(int $attributeId):Filter
Parameters
int $attributeId
public hasAnyAttribute(array $attributeIds):Filter
Parameters
array $attributeIds
public hasAllAttributes(array $attributeIds):Filter
Parameters
array $attributeIds
public hasAttributeValue(int $attributeValueId):Filter
Parameters
int $attributeValueId
public hasAnyAttributeValue(array $attributeValueIds):Filter
Parameters
array $attributeValueIds
public hasAllAttributeValues(array $attributeValueIds):Filter
Parameters
array $attributeValueIds
public hasNoAttributeValue():void
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

BarcodeFilter

Includes filters for barcodes

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasCode($code, string $precision):Filter
Parameters
$code
string $precision
public hasType(string $type):void

ToDo!

Parameters
string $type
public hasId(int $id):Filter
Parameters
int $id
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

CategoryFilter

Includes filters for categories

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public isInAtLeastOneCategory(array $categoryIds, string $depth = self::DEPTH_ANY):Filter
Parameters
array $categoryIds
string $depth
public static getPathByDepth(string $depth):string
Parameters
string $depth
public isInEachCategory(array $categoryIds, string $depth = self::DEPTH_ANY):Filter
Parameters
array $categoryIds
string $depth
public isInCategory(int $categoryId, string $depth = self::DEPTH_ANY):Filter
Parameters
int $categoryId
string $depth
public isInACategory():Filter
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

CharacteristicFilter

Includes filters for characteristics

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasAtLeastOneProperty(array $ids):Filter
Parameters
array $ids
public hasEachProperty(array $ids):Filter
Parameters
array $ids
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

ClientFilter

Includes filters for clients

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public isVisibleForClient(int $clientId):Filter
Parameters
int $clientId
public isVisibleForAtLeastOneClient(array $clientIds):Filter
Parameters
array $clientIds
public isVisibleForAllClients(array $clientIds):Filter
Parameters
array $clientIds
public hasAutomaticClientVisibility(array $values):Filter

-1, 0, 1, 2

Parameters
array $values
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

CrossSellingFilter

Includes filters for cross selling

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getPath():void
public hasItemId(int $itemId):void
Parameters
int $itemId
public hasRelation(string $relation):Filter
Parameters
string $relation
public hasAnyRelation(array $relations):Filter
Parameters
array $relations
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

FacetFilter

Includes filters for facets

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasAtLeastOneFacet(array $facetIds):Filter
Parameters
array $facetIds
public hasEachFacet(array $facetIds):Filter
Parameters
array $facetIds
public hasFacet(int $facetIds):Filter
Parameters
int $facetIds
public hasFacetValue(int $facetValueIds):Filter
Parameters
int $facetValueIds
public hasAFacet():Filter
public hasAtLeastOneFacetValue(array $valueIds):Filter
Parameters
array $valueIds
public hasEachFacetValue(array $valueIds):Filter
Parameters
array $valueIds
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

FeedbackRangeFilter

Includes filters for feedback

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasFeedbackGreaterThan(int $value):Filter
Parameters
int $value
public getType():string
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

ItemCreatedAtFilter

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(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

ItemFilter

Includes filters for the item

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasId(int $id):Filter
Parameters
int $id
public hasIds(array $ids):Filter
Parameters
array $ids
public hasAnImage():Filter
public hasFlag1(int $flagId):Filter
Parameters
int $flagId
public hasFlag2(int $flagId):Filter
Parameters
int $flagId
public hasManufacturer(int $manufacturerId):Filter
Parameters
int $manufacturerId
public hasManufacturers(array $manufacturerIds):Filter
Parameters
array $manufacturerIds
public hasAManufacturer():Filter
public isItemType(string $itemType):Filter
Parameters
string $itemType
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

ItemLastUpdatedAtFilter

Used to filter by item last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getTimestamp():string
public getType():string
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$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(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

MarketFilter

Includes filters for markets

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public isVisibleForMarket(float $marketId):Filter
Parameters
float $marketId
public isVisibleForAtLeastOneMarket(array $marketIds):Filter
Parameters
array $marketIds
public isVisibleForAllMarkets(array $marketIds):Filter
Parameters
array $marketIds
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

PriceFilter

Includes filters for prices

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getPath():void
public between(float $min = null, float $max = null):void
Parameters
float $min
float $max
public betweenByPriceId(array $priceIds = [], float $min = null, float $max = null):Filter
Parameters
array $priceIds
float $min
float $max
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

PropertyFilter

Includes filters for Properties

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasPropertySelection(int $id):Filter
Parameters
int $id
public hasAtLeastOnePropertySelection(array $ids):Filter
Parameters
array $ids
public hasEachPropertySelection(array $ids):Filter
Parameters
array $ids
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

SalesPriceFilter

Includes filters for salesPrices

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasAtLeastOnePrice(array $priceIds):Filter
Parameters
array $priceIds
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

SkuFilter

Includes filters for skus

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getPath():void
public hasMarketId(float $marketId):Filter
Parameters
float $marketId
public hasAccountId(int $accountId):Filter
Parameters
int $accountId
public hasStatus(string $status):Filter
Parameters
string $status
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

TagFilter

Includes filters for tags

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasTag(int $tagId):Filter
Parameters
int $tagId
public hasAnyTag(array $tagIds):Filter
Parameters
array $tagIds
public hasAllTags(array $tagIds):Filter
Parameters
array $tagIds
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

TextFilter

Includes filters for texts

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasAnyName():Filter
public hasNameInLanguage(string $lang = "de", string $filter = self::FILTER_ANY_NAME):Filter
Parameters
string $lang
string $filter
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement
public static isLanguageSupported(string $lang):bool
Parameters
string $lang
public static isLanguageActivated(string $lang):bool
Parameters
string $lang
public static getM10lByLanguage(string $lang, string $fallback = "en"):string
Parameters
string $lang
string $fallback
public static getLanguageByM10l(string $lang, string $fallback = "english"):string
Parameters
string $lang
string $fallback

VariationAvailabilityUpdatedAtFilter

Used to filter by variation availability last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

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

VariationBaseFilter

Includes filters for the base variation

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasNumber(string $number, string $precision):Filter
Parameters
string $number
string $precision
public hasAnyNumber($numbers):void
Parameters
$numbers
public isActive():Filter
public isInactive():Filter
public hasId(int $id):Filter
Parameters
int $id
public hasIds(array $ids):Filter
Parameters
array $ids
public hasItemId(int $itemId):Filter
Parameters
int $itemId
public hasItemIds(array $itemIds):Filter
Parameters
array $itemIds
public isMain():Filter
public isChild():Filter
public isSalable(bool $bool = true):Filter
Parameters
bool $bool
public isHiddenInCategoryList(bool $bool = true):Filter
Parameters
bool $bool
public hasADescriptionInLanguage(string $language):Filter
Parameters
string $language
public hasAnImageOrItemHasAnImage():Filter
public hasAnImage():Filter
public hasManufacturer(int $manufacturerId):Filter
Parameters
int $manufacturerId
public hasSupplier(int $supplierId):Filter
Parameters
int $supplierId
public hasAtLeastOneAvailability(array $availabilities):Filter
Parameters
array $availabilities
public hasActiveChildren(bool $bool = true):Filter
Parameters
bool $bool
public hasChildren(bool $bool = true):Filter
Parameters
bool $bool
public hasCustomsTariffNumber(string $customsTariffNumber):Filter
Parameters
string $customsTariffNumber
public customsTariffNumberNotExists():Filter
public customsTariffNumberExists():Filter
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

VariationBundleFilter

Includes filters for bundles

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasBundleType(string $bundleType):void
Parameters
string $bundleType
public hasNoBundleType():void
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

VariationCreatedAtFilter

Used to filter by variation created at timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

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

VariationLastUpdatedAtFilter

Used to filter by variation last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

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

VariationStockUpdatedAtFilter

Used to filter by variation stock last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

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

Query

ManagedSearchQuery

Used to search for variations by a specified term.

Namespace

Plenty\Modules\Pim\SearchService\Query

Methods

public setLang($lang):void
Parameters
$lang
public toArray():void
public setOperator($operator):void
Parameters
$operator
public setFuzzy($fuzzy):void
Parameters
$fuzzy
public addFilterField(string $field, int $boost):void
Parameters
string $field
int $boost
public addMultilingualField(string $field, string $language, int $boost):void
Parameters
string $field
string $language
int $boost
public addOtherAnalyzedField(string $field, int $boost):void
Parameters
string $field
int $boost
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement
public static isLanguageSupported(string $lang):bool
Parameters
string $lang
public static isLanguageActivated(string $lang):bool
Parameters
string $lang
public static getM10lByLanguage(string $lang, string $fallback = "en"):string
Parameters
string $lang
string $fallback
public static getLanguageByM10l(string $lang, string $fallback = "english"):string
Parameters
string $lang
string $fallback

SearchQuery

Used to search for variations by a specified term.

Namespace

Plenty\Modules\Pim\SearchService\Query

Methods

public setOperator($operator):void
Parameters
$operator
public setFuzzy($fuzzy):void
Parameters
$fuzzy
public addFilterField(string $field, int $boost):void
Parameters
string $field
int $boost
public addMultilingualField(string $field, string $language, int $boost):void
Parameters
string $field
string $language
int $boost
public addOtherAnalyzedField(string $field, int $boost):void
Parameters
string $field
int $boost
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement
public static isLanguageSupported(string $lang):bool
Parameters
string $lang
public static isLanguageActivated(string $lang):bool
Parameters
string $lang
public static getM10lByLanguage(string $lang, string $fallback = "en"):string
Parameters
string $lang
string $fallback
public static getLanguageByM10l(string $lang, string $fallback = "english"):string
Parameters
string $lang
string $fallback

Aggregations

Facet

NestedFacetValuesAggregation

To be written

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Facet

Methods

public getName():void
public getAggregation():void
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

Feedback

FeedbackRangeAggregation

To be written

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Feedback

Methods

public getName():string
public getField():string
public getRanges():void
public getAggregation():void
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

Price

ItemMinPriceAggregation

Get min price by price id for found variations

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Price

Methods

public getName():void
public getAggregation():void
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

PriceRangeAggregation

Get price range for found variations

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Price

Methods

public getName():void
public setPriceIds(array $ids):void
Parameters
array $ids
public process(array $data):array
Parameters
array $data
public getAggregation():void
public toArray():array
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

Processors

AttributeValueAggregationProcessor

Processor for AttributeValueAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array
Parameters
array $data
public getName():string
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

CategoryAllTermsAggregationProcessor

Processor for CategoryAllTermsAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array
Parameters
array $data
public getName():string
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

CategoryPathTermsAggregationProcessor

Processor for CategoryAllTermsAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array
Parameters
array $data
public getName():string
public setFullPath(bool $fullPath):CategoryPathTermsAggregationProcessor
Parameters
bool $fullPath
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

FacetAggregationProcessor

To be written

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array
Parameters
array $data
public getName():string
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

FeedbackRangeAggregationProcessor

Processor for FeedbackRangeAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array
Parameters
array $data
public getName():string
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

ItemCardinalityAggregationProcessor

Processor for ItemCardinalityAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array
Parameters
array $data
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

ItemIdTermsAggregationProcessor

Processor for ItemIdTermsAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array
Parameters
array $data
public getName():string
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

ItemMinPriceAggregationProcessor

Processor for ItemMinPriceAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array
Parameters
array $data
public getName():string
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

SalableFilterAggregationProcessor

Processor for SalableFilterAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array
Parameters
array $data
public getName():string
public addSubProcessor(ProcessorInterface
 $processor):void
Parameters
ProcessorInterface $processor
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

SearchSuggestionsTermsAggregationProcessor

Processor for SearchSuggestionsTermsAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array
Parameters
array $data
public getName():string
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

UnitCombinationAggregationProcessor

Processor for UnitCombinationAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array
Parameters
array $data
public getName():string
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

SearchSuggestions

SearchSuggestionsTermsAggregation

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

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\SearchSuggestions

Methods

public getName():void
public getField():void
public getAggregation():array
public setInclude(string $string):void
Parameters
string $string
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void
public static isLanguageSupported(string $lang):bool
Parameters
string $lang
public static isLanguageActivated(string $lang):bool
Parameters
string $lang
public static getM10lByLanguage(string $lang, string $fallback = "en"):string
Parameters
string $lang
string $fallback
public static getLanguageByM10l(string $lang, string $fallback = "english"):string
Parameters
string $lang
string $fallback

VariationDataInterface

Contracts

AttributeInterface

To be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Contracts

Methods

public getName():string
public static getVariationAttribute():string
public addLazyLoadParts(array $lazyLoadParts):Contracts
Parameters
array $lazyLoadParts
public getLazyLoadParts():array

VariationDataInterfaceContract

Use this interface to load performant article data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Contracts

Methods

public getResult(VariationDataInterfaceContext
 $context):VariationDataInterfaceResultInterface
Parameters
VariationDataInterfaceContext $context
public getMultipleResults(array $contextList):array
Parameters
array $contextList

VariationDataInterfaceResultInterface

Result

Namespace

Plenty\Modules\Pim\VariationDataInterface\Contracts

Methods

public getContext():VariationDataInterfaceContext
public total():int
public get():void

Get all found variations as Traversable.

public getAdditionalData():array

Get additional data provided by the elasticsearch result

Model

Variation

The Variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model

Properties

Type Name Description
int id The id of the variation.
array additionalSkus The additional skus of the variation.
array attributeValues The attribute values of the variation.
Base base The base data of the variation.
array barcodes The barcodes of the variation.
array bundleComponents The bundle components of the variation.
array categories The categories of the variation.
array clients The clients of the variation.
array defaultCategories The default categories of the variation.
array images The images of the variation.
array markets The markets of the variation.
array marketIdentNumbers The market ident numbers of the variation.
array salesPrices The sales prices of the variation.
array skus The skus of the variation.
array supplier The supplier of the variation.
Timestamp timestamps The timestamps of the variation.
array warehouses The warehouses of the variation.
Unit unit The unit of the variation.
array tags The tags of the variation.
array comments The comments of the variation.
array properties The properties of the variation.
array elasticSearchSource

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(TypeInterface
 $filter):VariationDataInterfaceContext
Parameters
TypeInterface $filter
public addAggregation(AggregationInterface
 $aggregation):VariationDataInterfaceContext
Parameters
AggregationInterface $aggregation
public addSuggestion(SuggestionInterface
 $suggestion):VariationDataInterfaceContext
Parameters
SuggestionInterface $suggestion
public addQuery(TypeInterface
 $filter):VariationDataInterfaceContext
Parameters
TypeInterface $filter
public getFilter():Collection
public getIds():void
public setIds(Collection
 $ids):void
Parameters
Collection $ids
public getAggregations():void
public getSuggestions():void
public getQuery():void
public getParts():void
public addPart(AttributeInterface
 $part):void
Parameters
AttributeInterface $part
public setParts(array $parts):VariationDataInterfaceContext
Parameters
array $parts
public getPlentyIds():void
public setPlentyIds(Collection
 $plentyIds):void
Parameters
Collection $plentyIds
public getLanguages():void
public setLanguages(Collection
 $languages):void
Parameters
Collection $languages
public getPage():int
public setPage(int $page = 1, int $perPage = 50):VariationDataInterfaceContext
Parameters
int $page
int $perPage
public getPerPage():int
public isGetAllFound():bool
public setGetAllFound(bool $getAll):Model
Parameters
bool $getAll
public getBatchSize():int
public setBatchSize(int $batchSize):VariationDataInterfaceContext
Parameters
int $batchSize
public getContextId():string
public getGroupBy():GroupBy
public setGroupBy(GroupBy
 $groupBy):VariationDataInterfaceContext
Parameters
GroupBy $groupBy
public getDecoratedReturnType():string
public getSorting():SortingInterface
public setSorting(SortingInterface
 $sorting):VariationDataInterfaceContext
Parameters
SortingInterface $sorting
public getScoreModifier():ScoreModifierInterface
public setScoreModifier(ScoreModifierInterface
 $scoreModifier):VariationDataInterfaceContext
Parameters
ScoreModifierInterface $scoreModifier
public getAdditionalSource():IndependentSource
public setAdditionalSource(IndependentSource
 $additionalSource):VariationDataInterfaceContext
Parameters
IndependentSource $additionalSource
public hasAdditionalSource():bool

Model

Attributes

VariationAdditionalSkuAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationAttributeValueAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationBarcodeAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationBaseAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationBundleComponentAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationCategoryAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationClientAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationCommentAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationDefaultCategoryAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationImageAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationMarketAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationMarketIdentNumberAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationPropertyAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationSalesPriceAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationSkuAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationSupplierAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationTagAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationTimestampAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationUnitAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationWarehouseAttribute

to be written

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():void
public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$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

DecoratedAttributes

AdditionalSku

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
int id The unique ID of the additional sku
float marketId The ID of the market
int marketAccountId The ID of the market account
string sku The additional sku for this variation.

Methods

public toArray()

Returns this model as an array.

AttributeValue

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int attributeId The unique ID of the attribute
int attributeValueSetId The unique ID of the attribute
int valueId The unique ID of the attribute value

Methods

public toArray()

Returns this model as an array.

Barcode

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
string code The code of the variation's barcode. The combination of code and barcode ID must be unique.
int barcodeId 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

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
bool isMain
int mainVariationId
int itemId
int position
bool isActive
string number
string model
string externalId
int availability
string estimatedAvailableAt
float purchasePrice
float movingAveragePrice
int priceCalculationId
string picking
int stockLimitation
string isVisibleIfNetStockIsPositive
string isInvisibleIfNetStockIsNotPositive
string isAvailableIfNetStockIsPositive
string isUnavailableIfNetStockIsNotPositive
string isVisibleInListIfNetStockIsPositive
string isInvisibleInListIfNetStockIsNotPositive
int mainWarehouseId
float maximumOrderQuantity
float minimumOrderQuantity
float intervalOrderQuantity
string availableUntil
string releasedAt
string name
int weightG
int weightNetG
int widthMM
int lengthMM
int heightMM
float extraShippingCharge1
float extraShippingCharge2
int unitsContained
int palletTypeId
int packingUnits
int packingUnitsTypeId
float transportationCosts
float storageCosts
float customs
float operatingCosts
int vatId
string bundleType
int automaticClientVisibility
int automaticListVisibility
string isHiddenInCategoryList
float defaultShippingCosts
string mayShowUnitPrice
int parentVariationId
float parentVariationQuantity
int singleItemCount
string hasCalculatedBundleWeight
string hasCalculatedBundleNetWeight
string hasCalculatedBundlePurchasePrice
string hasCalculatedBundleMovingAveragePrice
string customsTariffNumber
bool categoriesInherited
bool referrerInherited
bool clientsInherited
bool salesPricesInherited
bool supplierInherited
bool warehousesInherited
bool propertiesInherited
bool tagsInherited

Methods

public toArray()

Returns this model as an array.

BundleComponent

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
int componentVariationId The unique ID of the variation added as bundle component
float componentQuantity The quantity of the variation to be added as bundle component

Methods

public toArray()

Returns this model as an array.

Category

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int categoryId The unique ID of the category
int position The position of the category
string isNeckermannPrimary 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

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
int plentyId The unique ID of the client (store)

Methods

public toArray()

Returns this model as an array.

Comment

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
int id
int userId The unique ID of the user
string text
bool isVisibleForContact

Methods

public toArray()

Returns this model as an array.

DefaultCategory

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int branchId The unique ID of the category branch
int plentyId The unique plenty ID of the client (store)
bool manually

Methods

public toArray()

Returns this model as an array.

Image

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int imageId The unique ID of the image

Methods

public toArray()

Returns this model as an array.

Market

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
float marketId The unique ID of the market

Methods

public toArray()

Returns this model as an array.

MarketIdentNumber

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
int id The unique id of the market ident number (ASIN/ePID)
int countryId The country code of the market ident number (ASIN/ePID)
string type The type of market ident number (ASIN/ePID)
int position The position of the market ident number (ASIN/ePID)
string value The value of the market ident number (ASIN/ePID)

Methods

public toArray()

Returns this model as an array.

Property

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int propertyId The unique ID of the property
array values the values of this relation

Methods

public toArray()

Returns this model as an array.

SalesPrice

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int salesPriceId The unique ID of the sales price
float price The price of the variation saved for this sales price

Methods

public toArray()

Returns this model as an array.

Sku

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
int id The ID of the sku
float marketId The ID of the market
int accountId The ID of the market account
string initialSku 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.
string sku The SKU of the variation. The SKU is adjustable but may not exist twice for the combination of market Id and account Id.
string parentSku The Parent SKU of the variation. The Parent SKU is adjustable. The same Parent SKU value should be used on variations of same article.
bool isActive Flag that indicates if the item is ready for export (currently not in use).
string exportedAt The time the variation was last exported (YYYY-MM-DD HH:MM:SS).
string stockUpdatedAt
string deletedAt The time the variation was deleted (YYYY-MM-DD HH:MM:SS).
string status The status of the variation after the export. Possible entries are INACTIVE, ERROR, SENT and ACTIVE.
string additionalInformation The field that contains additional information.

Methods

public toArray()

Returns this model as an array.

Supplier

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int id The unique ID of the link between variation and supplier.
int supplierId The unique ID of the supplier.
float purchasePrice The price at which the variation was purchased from this supplier.
int minimumPurchase 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.
string itemNumber The external item number assigned to the variation by this supplier.
string lastPriceQuery The date of the last price query to this supplier. This helps to plan price negotiations.
int deliveryTimeInDays The delivery time in days for the variation saved for this supplier.
float discount The discount in percent the supplier grants for the variation.
bool isDiscountable Flag that indicates if the supplier's discount for this variation is active.
float packagingUnit The packaging unit of the supplier if it differs from the packaging unit settings in plentymarkets.
float currencyPurchasePrice The price at which the variation was purchased from this supplier in the currency of the supplier.
string itemDescription The supplier item description.

Methods

public toArray()

Returns this model as an array.

Tag

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int tagId The unique ID of the tag

Methods

public toArray()

Returns this model as an array.

Timestamp

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
Carbon availability The time the availability of the variation was last modified.
Carbon additionalSku The time any additional sku of the variation was last modified.
Carbon barcode The time any barcode of the variation was last modified.
Carbon base The time any field of the variation was last modified.
Carbon bundleComponent The time any bundle component of the variation was last modified.
Carbon category The time any category of the variation was last modified.
Carbon client The time any client of the variation was last modified.
Carbon defaultCategory The time any default category of the variation was last modified.
Carbon image The time any image of the variation was last modified.
Carbon market The time any market of the variation was last modified.
Carbon marketIdentNumber The time any market ident number of the variation was last modified.
Carbon related The time any relation of the variation was last modified.
Carbon salesPrice The time any sales price of the variation was last modified.
Carbon sku The time any sku of the variation was last modified.
Carbon supplier The time any supplier of the variation was last modified.
Carbon warehouse The time any warehouse of the variation was last modified.
Carbon property The time any property of the variation was last modified.
Carbon comment The time any comment of the variation was last added.
Carbon tag The time any tag of the variation was last modified.
Carbon createdAt The time any warehouse of the variation was last modified.

Methods

public toArray()

Returns this model as an array.

Unit

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int unitId The unique ID of the unit
float content The content
int unitCombinationId The unit combinationId

Methods

public toArray()

Returns this model as an array.

Warehouse

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int warehouseId The unique ID of the warehouse
int warehouseZoneId The unique ID of the warehouse zone
string storageLocationType The storage location type of the warehouse
int reorderLevel The reorder level for the variation in this warehouse
int maximumStock The maximum stock for the variation in this warehouse
int stockTurnoverInDays The stock turnover in days for the variation in this warehouse
int storageLocation The storage location of the variation in this warehouse
int stockBuffer The stock buffer for the variation in this warehouse
bool isBatch Is for warehouse and variation stock batch active
bool isBestBeforeDate Is for warehouse and variation stock best before date active

Methods

public toArray()

Returns this model as an array.

Decorators

AttributeValue

With

Namespace

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

Properties

Type Name Description
Attribute attribute
AttributeValue attributeValue

Methods

public toArray()

Returns this model as an array.

Barcode

With

Namespace

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

Properties

Type Name Description
Barcode barcode

Methods

public toArray()

Returns this model as an array.

Base

With

Namespace

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

Properties

Type Name Description
Item item
array characteristics
array crossSelling
array texts
array feedback
Availability availability
array shippingProfiles
array images
array stock
array stockStorageLocations
array serialNumbers
ItemSetConfig setConfig

Methods

public toArray()

Returns this model as an array.

Category

With

Namespace

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

Properties

Type Name Description
Category category
CategoryBranch categoryBranch

Methods

public toArray()

Returns this model as an array.

DefaultCategory

With

Namespace

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

Properties

Type Name Description
Category defaultCategory

Methods

public toArray()

Returns this model as an array.

Images

With

Namespace

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

Properties

Type Name Description
ItemImage image

Methods

public toArray()

Returns this model as an array.

Property

With

Namespace

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

Properties

Type Name Description
Property property

Methods

public toArray()

Returns this model as an array.

SalesPrice

With

Namespace

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

Properties

Type Name Description
SalesPrice salesPrice

Methods

public toArray()

Returns this model as an array.

Supplier

With

Namespace

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

Properties

Type Name Description
Contact supplier

Methods

public toArray()

Returns this model as an array.

Tag

With

Namespace

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

Properties

Type Name Description
Tag tag

Methods

public toArray()

Returns this model as an array.

Unit

With

Namespace

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

Properties

Type Name Description
Unit unit

Methods

public toArray()

Returns this model as an array.

Warehouse

With

Namespace

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

Properties

Type Name Description
Warehouse warehouse

Methods

public toArray()

Returns this model as an array.