Plentymarkets interface documentation

Variation

Contracts

ExportTypeContract

The export type to load variation data through the catalogue. This should not be extended, instead just consume the constant when registering a template.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Contracts

Filters

DefaultVariationFilterBuilderContainer

Default variation filter builder container. Contains all available filter builders.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters

Methods
public removeFilterBuilder($key):void
Parameters

Name

Type

Description

$key

public addFilterBuilder($filterBuilder):void
Parameters

Name

Type

Description

$filterBuilder

CatalogFilterBuilderContract

public getFilterBuilders():array

FilterBuilder

Used to represent the base of all filters in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters

Methods
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

public getKey():string
public setFilterData($filterData):void

This method will be filled by the specified values in a catalog. It should be used to provide the necessary manipulation so the filter that is returned by getFilter can be consumed by the export.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):void

Returns the filter that will be given to the export

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter

Returns the UI representation of the filter

FilterBuilderFactory

This factory provides methods to retrieve all available catalog filter builders.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters

Methods
public variationHasAtLeastOneAvailability():Plenty\Modules\Pim\Catalog\Variation\Filters\Availability\VariationHasAtLeastOneAvailability
Return type: VariationHasAtLeastOneAvailability
public variationHasAtLeastOneBundleType():Plenty\Modules\Pim\Catalog\Variation\Filters\BundleType\VariationHasAtLeastOneBundleType
Return type: VariationHasAtLeastOneBundleType
public variationIsInAtLeastOneCategory():Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInAtLeastOneCategory
Return type: VariationIsInAtLeastOneCategory
public variationIsInCategories():Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInCategories
Return type: VariationIsInCategories
public variationHasAtLeastOneClient():Plenty\Modules\Pim\Catalog\Variation\Filters\Client\VariationHasAtLeastOneClient
Return type: VariationHasAtLeastOneClient
public variationHasClients():Plenty\Modules\Pim\Catalog\Variation\Filters\Client\VariationHasClients
Return type: VariationHasClients
public variationHasImage():Plenty\Modules\Pim\Catalog\Variation\Filters\Image\VariationHasImage
Return type: VariationHasImage
public itemBelongsToAtLeastOneAmazonFlatFile():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemBelongsToAtLeastOneAmazonFlatFile
Return type: ItemBelongsToAtLeastOneAmazonFlatFile
public itemCreatedAt():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemCreatedAt
Return type: ItemCreatedAt
public itemHasAtLeastOneFlagOne():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneFlagOne
Return type: ItemHasAtLeastOneFlagOne
public itemHasAtLeastOneFlagTwo():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneFlagTwo
Return type: ItemHasAtLeastOneFlagTwo
public itemHasAtLeastOneId():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneId
Return type: ItemHasAtLeastOneId
public itemIsType():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemIsType
Return type: ItemIsType
public itemUpdatedAt():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemUpdatedAt
Return type: ItemUpdatedAt
public itemHasAtLeastOneManufacturer():Plenty\Modules\Pim\Catalog\Variation\Filters\Manufacturer\ItemHasAtLeastOneManufacturer
Return type: ItemHasAtLeastOneManufacturer
public variationIsVisibleForAtLeastOneMarket():Plenty\Modules\Pim\Catalog\Variation\Filters\Markets\VariationIsVisibleForAtLeastOneMarket
Return type: VariationIsVisibleForAtLeastOneMarket
public variationIsVisibleForMarkets():Plenty\Modules\Pim\Catalog\Variation\Filters\Markets\VariationIsVisibleForMarkets
Return type: VariationIsVisibleForMarkets
public variationHasAtLeastOnePropertySelection():Plenty\Modules\Pim\Catalog\Variation\Filters\Property\VariationHasAtLeastOnePropertySelection
Return type: VariationHasAtLeastOnePropertySelection
public variationHasPropertySelections():Plenty\Modules\Pim\Catalog\Variation\Filters\Property\VariationHasPropertySelections
Return type: VariationHasPropertySelections
public variationHasSku():Plenty\Modules\Pim\Catalog\Variation\Filters\Sku\VariationHasSku
Return type: VariationHasSku
public variationHasAtLeastOneTag():Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationHasAtLeastOneTag
Return type: VariationHasAtLeastOneTag
public variationHasTags():Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationHasTags
Return type: VariationHasTags
public variationCreatedAt():Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationCreatedAt
Return type: VariationCreatedAt
public variationHasChildren():void
public variationIsActive():Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationIsActive
Return type: VariationIsActive
public variationIsMain():Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationIsMain
Return type: VariationIsMain
public variationUpdatedAt():Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationUpdatedAt
Return type: VariationUpdatedAt
public salesPriceUpdatedAt():Plenty\Modules\Pim\Catalog\Variation\Filters\Price\SalesPriceUpdatedAt
Return type: SalesPriceUpdatedAt
public stockUpdatedAt():Plenty\Modules\Pim\Catalog\Variation\Filters\Stock\StockUpdatedAt
Return type: StockUpdatedAt

Filters

Availability

VariationHasAtLeastOneAvailability

Used to represent the VariationHasAtLeastOneAvailability filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Availability

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilter
Return type: VariationBaseFilter

Will return a VariationBaseFilter if at least one availability is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setAvailabilities($availabilities):Plenty\Modules\Pim\Catalog\Variation\Filters\Availability\VariationHasAtLeastOneAvailability
Return type: VariationHasAtLeastOneAvailability
Parameters

Name

Type

Description

$availabilities

int

public addAvailability($availabilitiy):Plenty\Modules\Pim\Catalog\Variation\Filters\Availability\VariationHasAtLeastOneAvailability
Return type: VariationHasAtLeastOneAvailability
Parameters

Name

Type

Description

$availabilitiy

int

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

BundleType

VariationHasAtLeastOneBundleType

Used to represent the hasBundleType filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\BundleType

Methods
public getKey():string
public setFilterData($filterData):void
Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBundleFilter
Return type: VariationBundleFilter
Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setBundleTypes($bundleTypes):Plenty\Modules\Pim\Catalog\Variation\Filters\BundleType\VariationHasAtLeastOneBundleType
Return type: VariationHasAtLeastOneBundleType
Parameters

Name

Type

Description

$bundleTypes

array

public addBundleType($bundleType):Plenty\Modules\Pim\Catalog\Variation\Filters\BundleType\VariationHasAtLeastOneBundleType
Return type: VariationHasAtLeastOneBundleType
Parameters

Name

Type

Description

$bundleType

string

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Category

VariationIsInACategory

Used to represent the IsInACategory filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Category

Methods
public getKey():string
public setFilterData($filterData):void
Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\CategoryFilter
Return type: CategoryFilter

Will return a CategoryFilter if a category id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setShouldBeInACategory($shouldBeInACategory):Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInACategory
Return type: VariationIsInACategory
Parameters

Name

Type

Description

$shouldBeInACategory

bool

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationIsInAtLeastOneCategory

Used to represent the isInAtLeastOneCategory filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Category

Methods
public getKey():string
public setFilterData($filterData):void
Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\CategoryFilter
Return type: CategoryFilter

Will return a CategoryFilter if a category id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setCategoryIds($categoryIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInAtLeastOneCategory
Return type: VariationIsInAtLeastOneCategory
Parameters

Name

Type

Description

$categoryIds

int

public addCategoryId($categoryId):Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInAtLeastOneCategory
Return type: VariationIsInAtLeastOneCategory
Parameters

Name

Type

Description

$categoryId

int

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationIsInCategories

Used to represent the isInEachCategory filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Category

Methods
public getKey():string
public setFilterData($filterData):void
Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\CategoryFilter
Return type: CategoryFilter

Will return a CategoryFilter if a category id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setCategoryIds($categoryIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInCategories
Return type: VariationIsInCategories
Parameters

Name

Type

Description

$categoryIds

int

public addCategoryId($categoryId):Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInCategories
Return type: VariationIsInCategories
Parameters

Name

Type

Description

$categoryId

int

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Client

VariationHasAtLeastOneClient

Used to represent the isVisibleForAtLeastOneClient filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Client

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ClientFilter
Return type: ClientFilter

Will return a ClientFilter if at least one client id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setClientIds($clientIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Client\VariationHasAtLeastOneClient
Return type: VariationHasAtLeastOneClient
Parameters

Name

Type

Description

$clientIds

int

public addClientId($clientId):Plenty\Modules\Pim\Catalog\Variation\Filters\Client\VariationHasAtLeastOneClient
Return type: VariationHasAtLeastOneClient
Parameters

Name

Type

Description

$clientId

int

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationHasClients

Used to represent the isVisibleForAllClients filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Client

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ClientFilter
Return type: ClientFilter

Will return a ClientFilter if at least one client id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setClientIds($clientIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Client\VariationHasClients
Return type: VariationHasClients
Parameters

Name

Type

Description

$clientIds

int

public addClientId($clientId):Plenty\Modules\Pim\Catalog\Variation\Filters\Client\VariationHasClients
Return type: VariationHasClients
Parameters

Name

Type

Description

$clientId

int

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Image

VariationHasImage

Used to represent the HasAnImage filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Image

Methods
public getKey():string
public setFilterData($filterData):void
Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilter
Return type: VariationBaseFilter

Will return a VariationBaseFilter if shouldHaveImage is set. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setShouldHaveImage($shouldHaveImage):Plenty\Modules\Pim\Catalog\Variation\Filters\Image\VariationHasImage
Return type: VariationHasImage
Parameters

Name

Type

Description

$shouldHaveImage

bool

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Item

ItemBelongsToAtLeastOneAmazonFlatFile

Used to represent the ItemBelongsToAmazonFlatFile filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Item

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\AmazonFilter
Return type: AmazonFilter

Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setAmazonFlatFiles($flatFiles):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemBelongsToAtLeastOneAmazonFlatFile
Return type: ItemBelongsToAtLeastOneAmazonFlatFile
Parameters

Name

Type

Description

$flatFiles

string

public addAmazonFlatFile($flatFile):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemBelongsToAtLeastOneAmazonFlatFile
Return type: ItemBelongsToAtLeastOneAmazonFlatFile
Parameters

Name

Type

Description

$flatFile

string

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

ItemCreatedAt

Used to represent the ItemCreatedAtFilter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Item

Methods
public getKey():string
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemCreatedAtFilter
Return type: ItemCreatedAtFilter

Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public setFilterData($filterData):void
Parameters

Name

Type

Description

$filterData

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):void
Parameters

Name

Type

Description

$fromDate

Carbon

$toDate

Carbon

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

ItemHasAtLeastOneFlagOne

Used to represent the ItemHasFlagOne filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Item

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemFilter
Return type: ItemFilter

Will return a ItemFilter if a flag is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setFlags($flags):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneFlagOne
Return type: ItemHasAtLeastOneFlagOne
Parameters

Name

Type

Description

$flags

array

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

ItemHasAtLeastOneFlagTwo

Used to represent the ItemHasFlagTwo filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Item

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemFilter
Return type: ItemFilter

Will return a ItemFilter if a flag is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setFlags($flags):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneFlagTwo
Return type: ItemHasAtLeastOneFlagTwo
Parameters

Name

Type

Description

$flags

int

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

ItemHasAtLeastOneId

Used to represent the ItemHasIds filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Item

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):void
Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setItemIds($itemIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneId
Return type: ItemHasAtLeastOneId
Parameters

Name

Type

Description

$itemIds

int

public addItemId($itemId):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneId
Return type: ItemHasAtLeastOneId
Parameters

Name

Type

Description

$itemId

int

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

ItemIsType

Used to represent the isItemType filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Item

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemFilter
Return type: ItemFilter

Will return a ItemFilter if a item type is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public setItemType($itemType):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemIsType
Return type: ItemIsType
Parameters

Name

Type

Description

$itemType

string

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

ItemUpdatedAt

Used to represent the ItemUpdatedAtFilter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Item

Methods
public getKey():string
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemUpdatedAtFilter
Return type: ItemUpdatedAtFilter

Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public setFilterData($filterData):void
Parameters

Name

Type

Description

$filterData

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):void
Parameters

Name

Type

Description

$fromDate

Carbon

$toDate

Carbon

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Manufacturer

ItemHasAtLeastOneManufacturer

Used to represent the HasManufacturer filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Manufacturer

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemFilter
Return type: ItemFilter

Will return a VariationBaseFilter if at least one manufacturer id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setManufacturerIds($manufacturerIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Manufacturer\ItemHasAtLeastOneManufacturer
Return type: ItemHasAtLeastOneManufacturer
Parameters

Name

Type

Description

$manufacturerIds

int

public addManufacturerId($manufacturerId):Plenty\Modules\Pim\Catalog\Variation\Filters\Manufacturer\ItemHasAtLeastOneManufacturer
Return type: ItemHasAtLeastOneManufacturer
Parameters

Name

Type

Description

$manufacturerId

int

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Markets

VariationIsVisibleForAtLeastOneMarket

Used to represent the VariationIsVisibleForAtLeastOneMarket filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Markets

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\MarketFilter
Return type: MarketFilter

Will return a MarketFilter if at least one market id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setMarketIds($marketIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Markets\VariationIsVisibleForAtLeastOneMarket
Return type: VariationIsVisibleForAtLeastOneMarket
Parameters

Name

Type

Description

$marketIds

float

public addMarketId($marketId):Plenty\Modules\Pim\Catalog\Variation\Filters\Markets\VariationIsVisibleForAtLeastOneMarket
Return type: VariationIsVisibleForAtLeastOneMarket
Parameters

Name

Type

Description

$marketId

float

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationIsVisibleForMarkets

Used to represent the VariationIsVisibleForAllMarkets filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Markets

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\MarketFilter
Return type: MarketFilter

Will return a MarketFilter if at least one market id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setMarketIds($marketIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Markets\VariationIsVisibleForMarkets
Return type: VariationIsVisibleForMarkets
Parameters

Name

Type

Description

$marketIds

float

public addMarketId($marketId):Plenty\Modules\Pim\Catalog\Variation\Filters\Markets\VariationIsVisibleForMarkets
Return type: VariationIsVisibleForMarkets
Parameters

Name

Type

Description

$marketId

float

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Price

SalesPriceUpdatedAt

Used to filter by variation salesPrice last update timestamp

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Price

Methods
public getKey():string
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationSalesPriceUpdatedAtFilter
Return type: VariationSalesPriceUpdatedAtFilter

Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public setFilterData($filterData):void
Parameters

Name

Type

Description

$filterData

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):void
Parameters

Name

Type

Description

$fromDate

Carbon

$toDate

Carbon

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Property

VariationHasAtLeastOnePropertySelection

Used to represent the VariationHasAtLeastOnePropertySelection filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Property

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\PropertyFilter
Return type: PropertyFilter

Will return a VariationPropertyFilter if at least property selection id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setPropertySelectionIds($propertySelectionIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Property\VariationHasAtLeastOnePropertySelection
Return type: VariationHasAtLeastOnePropertySelection
Parameters

Name

Type

Description

$propertySelectionIds

int

public addPropertySelectionId($propertySelectionId):Plenty\Modules\Pim\Catalog\Variation\Filters\Property\VariationHasAtLeastOnePropertySelection
Return type: VariationHasAtLeastOnePropertySelection
Parameters

Name

Type

Description

$propertySelectionId

int

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationHasPropertySelections

Used to represent the VariationHasEachPropertySelection filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Property

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\PropertyFilter
Return type: PropertyFilter

Will return a VariationPropertyFilter if at least property selection id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setPropertySelectionIds($propertySelectionIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Property\VariationHasPropertySelections
Return type: VariationHasPropertySelections
Parameters

Name

Type

Description

$propertySelectionIds

int

public addPropertySelectionId($propertySelectionId):Plenty\Modules\Pim\Catalog\Variation\Filters\Property\VariationHasPropertySelections
Return type: VariationHasPropertySelections
Parameters

Name

Type

Description

$propertySelectionId

int

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Sku

VariationHasSku

Used to represent the VariationHasSku filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Sku

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\SkuFilter
Return type: SkuFilter

Will return a SkuFilter if at least accountId, marketId or status are provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setReferrer($referrer):Plenty\Modules\Pim\Catalog\Variation\Filters\Sku\VariationHasSku
Return type: VariationHasSku
Parameters

Name

Type

Description

$referrer

float

public setAccountId($accountId):Plenty\Modules\Pim\Catalog\Variation\Filters\Sku\VariationHasSku
Return type: VariationHasSku
Parameters

Name

Type

Description

$accountId

int

public setStatus($status):Plenty\Modules\Pim\Catalog\Variation\Filters\Sku\VariationHasSku
Return type: VariationHasSku
Parameters

Name

Type

Description

$status

string

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Stock

StockUpdatedAt

Used to filter by variation stock last update timestamp

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Stock

Methods
public getKey():string
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationStockUpdatedAtFilter
Return type: VariationStockUpdatedAtFilter

Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public setFilterData($filterData):void
Parameters

Name

Type

Description

$filterData

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):void
Parameters

Name

Type

Description

$fromDate

Carbon

$toDate

Carbon

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Tag

VariationHasAtLeastOneTag

Used to represent the ItemHasAtLeastOneTag filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Tag

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\TagFilter
Return type: TagFilter

Will return a TagFilter if at least one tag id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setTagIds($tagIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationHasAtLeastOneTag
Return type: VariationHasAtLeastOneTag
Parameters

Name

Type

Description

$tagIds

int

public addTagId($tagId):Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationHasAtLeastOneTag
Return type: VariationHasAtLeastOneTag
Parameters

Name

Type

Description

$tagId

int

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationHasTags

Used to represent the ItemHasTags filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Tag

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\TagFilter
Return type: TagFilter

Will return a TagFilter if at least one tag id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setTagIds($tagIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationHasTags
Return type: VariationHasTags
Parameters

Name

Type

Description

$tagIds

int

public addTagId($tagId):Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationHasTags
Return type: VariationHasTags
Parameters

Name

Type

Description

$tagId

int

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Variation

VariationCreatedAt

Used to represent the VariationCreatedAtFilter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Variation

Methods
public getKey():string
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationCreatedAtFilter
Return type: VariationCreatedAtFilter

Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public setFilterData($filterData):void
Parameters

Name

Type

Description

$filterData

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):void
Parameters

Name

Type

Description

$fromDate

Carbon

$toDate

Carbon

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationHasChildren

Used to represent the hasChildren filters in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Variation

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilter
Return type: VariationBaseFilter

Will return a VariationBaseFilter if shouldBeMain is defined. Otherwise null will be returned

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setShouldHaveChildren($shouldHaveChildren):Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationHasChildren
Return type: VariationHasChildren
Parameters

Name

Type

Description

$shouldHaveChildren

bool

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationIsActive

Used to represent the VariationIsActive filter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Variation

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilter
Return type: VariationBaseFilter

Will return a VariationBaseFilter if shouldBeActive is defined. Otherwise null will be returned

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setShouldBeActive($shouldBeActive):Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationIsActive
Return type: VariationIsActive
Parameters

Name

Type

Description

$shouldBeActive

bool

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationIsMain

Used to represent the isMain and isChild filters in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Variation

Methods
public getKey():string
public setFilterData($filterData):void

This method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilter
Return type: VariationBaseFilter

Will return a VariationBaseFilter if shouldBeMain is defined. Otherwise null will be returned

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setShouldBeMain($shouldBeMain):Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationIsMain
Return type: VariationIsMain
Parameters

Name

Type

Description

$shouldBeMain

bool

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationUpdatedAt

Used to represent the VariationUpdatedAtFilter in both the catalog export and UI.

Namespace

Plenty\Modules\Pim\Catalog\Variation\Filters\Variation

Methods
public getKey():string
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationLastUpdatedAtFilter
Return type: VariationLastUpdatedAtFilter

Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

public setFilterData($filterData):void
Parameters

Name

Type

Description

$filterData

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):void
Parameters

Name

Type

Description

$fromDate

Carbon

$toDate

Carbon

public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilder
Return type: FilterBuilder

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Contracts

Attribute

AttributeNameRepositoryContract

The contract for the pim attribute name repository

Namespace

Plenty\Modules\Pim\Contracts\Attribute

Methods
Return type: Collection

Search for attribute names

Parameters

Name

Type

Description

$with

array

$page

int

$perPage

int

public update($data):Illuminate\Support\Collection
Return type: Collection

Updates a list of attribute names

Parameters

Name

Type

Description

$data

array

public create($data):Illuminate\Support\Collection
Return type: Collection

Creates a list of attribute names

Parameters

Name

Type

Description

$data

array

public delete($data):Illuminate\Support\Collection
Return type: Collection

Deletes a list of attribute names

Parameters

Name

Type

Description

$data

array

public getCount():int

Gets the total count of attribute names

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.

AttributeRepositoryContract

The contract for the pim attribute repository

Namespace

Plenty\Modules\Pim\Contracts\Attribute

Methods
Return type: Collection

Searches for attributes

Parameters

Name

Type

Description

$with

array

$page

int

$perPage

int

public update($data):Illuminate\Support\Collection
Return type: Collection

Updates a list of attributes

Parameters

Name

Type

Description

$data

array

public create($data):Illuminate\Support\Collection
Return type: Collection

Creates a list of attributes

Parameters

Name

Type

Description

$data

array

public delete($data):Illuminate\Support\Collection
Return type: Collection

Deletes a list of attributes

Parameters

Name

Type

Description

$data

array

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

Get one attribute by ID

Parameters

Name

Type

Description

$id

int

$with

array

public getCount():int

Gets the total count of attributes

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.

AttributeValueNameRepositoryContract

The contract for the attribute value name repository

Namespace

Plenty\Modules\Pim\Contracts\Attribute

Methods
Return type: Collection

Search attribute value names

Parameters

Name

Type

Description

$with

array

$page

int

$perPage

int

public update($data):Illuminate\Support\Collection
Return type: Collection

Updates a list of attribute value names

Parameters

Name

Type

Description

$data

array

public create($data):Illuminate\Support\Collection
Return type: Collection

Creates a list of attribute value names

Parameters

Name

Type

Description

$data

array

public delete($data):Illuminate\Support\Collection
Return type: Collection

Deletes a list of attribute value names

Parameters

Name

Type

Description

$data

array

public getCount():int

Gets the total count of attribute value names

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.

AttributeValueRepositoryContract

The contract for the pim attribute value repository

Namespace

Plenty\Modules\Pim\Contracts\Attribute

Methods
Return type: Collection

Searches for attribute values

Parameters

Name

Type

Description

$with

array

$page

int

$perPage

int

public update($data):Illuminate\Support\Collection
Return type: Collection

Updates a list of attribute values

Parameters

Name

Type

Description

$data

array

public create($data):Illuminate\Support\Collection
Return type: Collection

Creates a list of attribute values

Parameters

Name

Type

Description

$data

array

public delete($data):Illuminate\Support\Collection
Return type: Collection

Deletes a list of attribute values

Parameters

Name

Type

Description

$data

array

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

Get one attribute value by ID

Parameters

Name

Type

Description

$id

int

$with

array

public getCount():int

Gets the total count of attribute values

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.

Barcode

BarcodeRepositoryContract

The contract for the pim barcode repository

Namespace

Plenty\Modules\Pim\Contracts\Barcode

Methods
Return type: Collection

Searches for barcodes

Parameters

Name

Type

Description

$with

array

$page

int

$perPage

int

public update($data):Illuminate\Support\Collection
Return type: Collection

Updates a list of barcodes

Parameters

Name

Type

Description

$data

array

public create($data):Illuminate\Support\Collection
Return type: Collection

Creates a list of barcodes

Parameters

Name

Type

Description

$data

array

public delete($data):Illuminate\Support\Collection
Return type: Collection

Deletes a list of barcodes

Parameters

Name

Type

Description

$data

array

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

Get one attribute by ID

Parameters

Name

Type

Description

$id

int

$with

array

public getCount():int

Gets the total count of barcodes

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.

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

The contract for the pim category repository

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.

GTIN

GTINRepositoryContract

The contract for the gtin repository

Namespace

Plenty\Modules\Pim\Contracts\GTIN

Methods
public get($next = false):Plenty\Modules\Pim\Models\GTIN\GtinConfig
Return type: GtinConfig

Gets GTIN 13 barcodes from plenty_text

Parameters

Name

Type

Description

$next

bool

Default false. If true generates a new GTIN

Manufacturer

ManufacturerRepositoryContract

The contract for the pim manufacturer repository

Namespace

Plenty\Modules\Pim\Contracts\Manufacturer

Methods
Return type: Collection

Search for manufacturer

Parameters

Name

Type

Description

$with

array

$page

int

$perPage

int

public create($data):Illuminate\Support\Collection
Return type: Collection

Create a list of manufacturer

Parameters

Name

Type

Description

$data

array

public update($data):Illuminate\Support\Collection
Return type: Collection

Update a list of manufacturer

Parameters

Name

Type

Description

$data

array

public delete($data):Illuminate\Support\Collection
Return type: Collection

Delete a list of manufacturer

Parameters

Name

Type

Description

$data

array

public getById($id):Plenty\Modules\Item\Manufacturer\Models\Manufacturer
Return type: Manufacturer

Get one manufacturer

Parameters

Name

Type

Description

$id

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.

SalesPrice

SalesPriceRepositoryContract

The contract for the pim sales price repository

Namespace

Plenty\Modules\Pim\Contracts\SalesPrice

Methods
Return type: Collection

Searches for sales prices

Parameters

Name

Type

Description

$with

array

$page

int

$perPage

int

public create($data):Illuminate\Support\Collection
Return type: Collection

Creates a list of sales prices

Parameters

Name

Type

Description

$data

array

public update($data):Illuminate\Support\Collection
Return type: Collection

Updates a list of sales prices

Parameters

Name

Type

Description

$data

array

public delete($data):Illuminate\Support\Collection
Return type: Collection

Deletes a list of sales prices

Parameters

Name

Type

Description

$data

array

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

Gets one sales price by ID

Parameters

Name

Type

Description

$id

int

$with

array

public getCount():int

Gets the total count of sales prices

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.

GTIN

GtinConfig

the gtin config model

Namespace

Plenty\Modules\Pim\Models\GTIN

Properties
Name Type Description

current

string

hasNext

string

last

string

Methods
public toArray()

Returns this model as an array.

Item

AmazonProductType

The amazon product type model.

Namespace

Plenty\Modules\Pim\Models\Item

Properties
Name Type Description

id

int

The unique ID of the amazon product type

genre

string

The genre of the amazon product type

type

string

The type of the amazon product type

genreDescription

string

The description of the amazon product genre

typeDescription

string

The description of the amazon product type

Methods
public toArray()

Returns this model as an array.

DocumentService

Models

WriteResponse

The write response model of the vdi.

Namespace

Plenty\Modules\Pim\DocumentService\Models

Methods
public toArray()

Returns this model as an array.

WriteableAttribute

The writeable attribute interface for the vdi models

Namespace

Plenty\Modules\Pim\DocumentService\Models

Methods
public getVariationId():void
public setVariationId($variationId):Plenty\Modules\Pim\DocumentService\Models\WriteableAttribute
Return type: WriteableAttribute

Set the variation ID of the part

Parameters

Name

Type

Description

$variationId

int

public getKey():string
public getValidator($operation):string
Parameters

Name

Type

Description

$operation

string

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\AmazonFilter
Return type: AmazonFilter

Restricts the result to have any of the specified flatFiles.

Parameters

Name

Type

Description

$flatFiles

array

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

Restricts the result to have any of the specified productTypes.

Parameters

Name

Type

Description

$productTypes

array

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

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\AttributeFilter
Return type: AttributeFilter

Restricts the result to have the specified attributeId.

Parameters

Name

Type

Description

$attributeId

int

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

Restricts the result to have any of the specified attributeId.

Parameters

Name

Type

Description

$attributeIds

array

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

Restricts the result to has all of the specified attributeId.

Parameters

Name

Type

Description

$attributeIds

array

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

Restricts the result to have the specified attributeValueId.

Parameters

Name

Type

Description

$attributeValueId

int

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

Restricts the result to have any of the specified attributeValueId.

Parameters

Name

Type

Description

$attributeValueIds

array

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

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\BarcodeFilter
Return type: BarcodeFilter

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\BarcodeFilter
Return type: BarcodeFilter

Restricts the result to have a specified id.

Parameters

Name

Type

Description

$id

int

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

Restricts the result to have no barcodes

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

Restricts the result to have at least one barcode

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\CategoryFilter
Return type: CategoryFilter

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\CategoryFilter
Return type: CategoryFilter

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\CategoryFilter
Return type: CategoryFilter

Restricts the result to have the categoryId.

Parameters

Name

Type

Description

$categoryId

int

$depth

string

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

Restricts the result to have a category.

Parameters

Name

Type

Description

$bool

bool

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

Restricts the result to not match the specified IDs.

Parameters

Name

Type

Description

$categoryIds

array

$depth

string

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\CharacteristicFilter
Return type: CharacteristicFilter

Restricts the result to have any of the characteristicIds.

Parameters

Name

Type

Description

$ids

array

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

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\ClientFilter
Return type: ClientFilter

Restricts the result to have the clientId.

Parameters

Name

Type

Description

$clientId

int

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

Restricts the result to have any of the clientIds.

Parameters

Name

Type

Description

$clientIds

array

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

Restricts the result to have all of the clientIds.

Parameters

Name

Type

Description

$clientIds

array

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

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

Parameters

Name

Type

Description

$values

array

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

Restricts the result to not match the specified IDs.

Parameters

Name

Type

Description

$clientIds

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\CrossSellingFilter
Return type: CrossSellingFilter

Restricts the result to have the relation

Parameters

Name

Type

Description

$relation

string

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

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\FacetFilter
Return type: FacetFilter

Restricts the result to have any of the facetIds.

Parameters

Name

Type

Description

$facetIds

array

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

Restricts the result to have all facetIds.

Parameters

Name

Type

Description

$facetIds

array

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

Restricts the result to have the facetIds.

Parameters

Name

Type

Description

$facetIds

int

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

Restricts the result to have the facetValueId.

Parameters

Name

Type

Description

$facetValueId

int

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

Restricts the result to have any of the facetValueIds.

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

Restricts the result to have any of the facetValueIds.

Parameters

Name

Type

Description

$valueIds

array

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

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\FeedbackRangeFilter
Return type: FeedbackRangeFilter

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\ItemFilter
Return type: ItemFilter

Restricts the result to have the item id.

Parameters

Name

Type

Description

$id

int

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

Restricts the result to have all the item ids.

Parameters

Name

Type

Description

$ids

array

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

Restricts the result to have an image.

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

Restricts the result to have the specified flag 1.

Parameters

Name

Type

Description

$flagId

int

public hasAnyFlag1($flags):Plenty\Modules\Pim\SearchService\Filter\ItemFilter
Return type: ItemFilter

Restricts the result to have any of the specified flags.

Parameters

Name

Type

Description

$flags

array

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

Restricts the result to have the specified flag 2.

Parameters

Name

Type

Description

$flagId

int

public hasAnyFlag2($flags):Plenty\Modules\Pim\SearchService\Filter\ItemFilter
Return type: ItemFilter

Restricts the result to have any of the specified flags.

Parameters

Name

Type

Description

$flags

array

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

Restricts the result to have the manufacturer id.

Parameters

Name

Type

Description

$manufacturerId

int

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

Restricts the result to have any of the manufacturer ids.

Parameters

Name

Type

Description

$manufacturerIds

array

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

Restricts the result to have an manufacturer.

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

Restricts the result to have the specified item type.

Parameters

Name

Type

Description

$itemType

string

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

Restricts the result to not have the specified item type.

Parameters

Name

Type

Description

$itemType

string

public hasAnyRevenueAccount($revenueAccounts):Plenty\Modules\Pim\SearchService\Filter\ItemFilter
Return type: ItemFilter
Parameters

Name

Type

Description

$revenueAccounts

array

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\MarketFilter
Return type: MarketFilter

Restricts the result to have the market id.

Parameters

Name

Type

Description

$marketId

float

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

Restricts the result to have any of the market ids.

Parameters

Name

Type

Description

$marketIds

array

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

Restricts the result to not have any of the market ids.

Parameters

Name

Type

Description

$marketIds

array

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

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\PriceFilter
Return type: PriceFilter

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\PropertyFilter
Return type: PropertyFilter

Restricts the result to have the property selection id.

Parameters

Name

Type

Description

$id

int

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

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\PropertyFilter
Return type: PropertyFilter

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\SalesPriceFilter
Return type: SalesPriceFilter

Restricts the result to have any of the price ids.

Parameters

Name

Type

Description

$priceIds

array

public hasPriceIds($priceIds):Plenty\Modules\Pim\SearchService\Filter\SalesPriceFilter
Return type: SalesPriceFilter
Parameters

Name

Type

Description

$priceIds

array

public hasNotPriceIds($priceIds):Plenty\Modules\Pim\SearchService\Filter\SalesPriceFilter
Return type: SalesPriceFilter

Restricts the result to not match the specified IDs.

Parameters

Name

Type

Description

$priceIds

array

public hasLowestPrice($bool = true):void
Parameters

Name

Type

Description

$bool

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\SkuFilter
Return type: SkuFilter

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\SkuFilter
Return type: SkuFilter

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\SkuFilter
Return type: SkuFilter

Restricts the result to have a sku with the status.

Parameters

Name

Type

Description

$status

string

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

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

StockFilter

Includes filters for stock

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public netStock($netStock, $operator = "eq"):Plenty\Modules\Pim\SearchService\Filter\StockFilter
Return type: StockFilter

Restricts the result to meet the specified net stock value depending on the operator

Parameters

Name

Type

Description

$netStock

float

$operator

string

public physicalStock($physicalStock, $operator = "eq"):Plenty\Modules\Pim\SearchService\Filter\StockFilter
Return type: StockFilter

Restricts the result to meet the specified physical stock value depending on the operator

Parameters

Name

Type

Description

$physicalStock

float

$operator

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\SupplierFilter
Return type: SupplierFilter
Parameters

Name

Type

Description

$term

string

$precision

string

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

Restricts the result to have the supplier id.

Parameters

Name

Type

Description

$supplierId

int

public hasAnySupplier($supplierIds):Plenty\Modules\Pim\SearchService\Filter\SupplierFilter
Return type: SupplierFilter

Restricts the result to have any of the tag ids.

Parameters

Name

Type

Description

$supplierIds

array

public hasAllSuppliers($supplierIds):Plenty\Modules\Pim\SearchService\Filter\SupplierFilter
Return type: SupplierFilter

Restricts the result to have all of the tag ids.

Parameters

Name

Type

Description

$supplierIds

array

public hasNotSupplierIds($supplierIds):Plenty\Modules\Pim\SearchService\Filter\SupplierFilter
Return type: SupplierFilter

Restricts the result to not match the specified IDs.

Parameters

Name

Type

Description

$supplierIds

array

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\TagFilter
Return type: TagFilter

Restricts the result to have the tag id.

Parameters

Name

Type

Description

$tagId

int

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

Restricts the result to have any of the tag ids.

Parameters

Name

Type

Description

$tagIds

array

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

Restricts the result to have all of the tag ids.

Parameters

Name

Type

Description

$tagIds

array

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

Restricts the result to not match the specified 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\TextFilter
Return type: TextFilter

Restricts the result to have any name.

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

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\TextFilter
Return type: TextFilter
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\TextFilter
Return type: TextFilter
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\TextFilter
Return type: TextFilter
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\TextFilter
Return type: TextFilter
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\VariationBaseFilter
Return type: VariationBaseFilter

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\VariationBaseFilter
Return type: VariationBaseFilter

Restricts the result to have active variations only.

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

Restricts the result to have inactive variations only.

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

Restricts the result to have the variation id.

Parameters

Name

Type

Description

$id

int

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

Restricts the result to have any of the variation ids.

Parameters

Name

Type

Description

$ids

array

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

Restricts the result to have the item id.

Parameters

Name

Type

Description

$itemId

int

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

Restricts the result to have the any price calculation id

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

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\VariationBaseFilter
Return type: VariationBaseFilter

Restricts the result to have the any of the item ids

Parameters

Name

Type

Description

$itemIds

array

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

Restricts the result to have no child's

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

Restricts the result to have child's only

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

Restricts the result whether is salable or not.

Parameters

Name

Type

Description

$bool

bool

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

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\VariationBaseFilter
Return type: VariationBaseFilter

This filter is not implemented. Deprecated.

Parameters

Name

Type

Description

$language

string

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

Restricts the result to have an image.

Parameters

Name

Type

Description

$bool

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

Restricts the result to have an item image.

Parameters

Name

Type

Description

$bool

bool

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

Restricts the result to have the manufacturer.

Parameters

Name

Type

Description

$manufacturerId

int

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

Restricts the result to have the supplier.

Parameters

Name

Type

Description

$supplierId

int

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

Restricts the result to have any of the availabilities.

Parameters

Name

Type

Description

$availabilities

array

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

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\VariationBaseFilter
Return type: VariationBaseFilter

Restricts the result to have child variations or not.

Parameters

Name

Type

Description

$bool

bool

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

Restricts the result to have the customs tariff number.

Parameters

Name

Type

Description

$customsTariffNumber

string

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

Restricts the result to have no customs tariff number.

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

Restricts the result to have a customs tariff number.

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

Restricts the result to not match the specified referrer IDs.

Parameters

Name

Type

Description

$ids

array

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

Restricts the result to not match the specified IDs.

Parameters

Name

Type

Description

$ids

array

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

Restricts the result to not match the specified item IDs.

Parameters

Name

Type

Description

$itemIds

array

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\VariationBundleFilter
Return type: VariationBundleFilter

Restricts the result to have the bundle type.

Parameters

Name

Type

Description

$bundleType

string

public hasBundleTypes($bundleTypes):Plenty\Modules\Pim\SearchService\Filter\VariationBundleFilter
Return type: VariationBundleFilter

Restricts the result to have the any of the bundle types.

Parameters

Name

Type

Description

$bundleTypes

array

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

Restricts the result to have the no bundle type.

public hasBundleComponentVariationId($componentVariationId):Plenty\Modules\Pim\SearchService\Filter\VariationBundleFilter
Return type: VariationBundleFilter

Restricts the result to have the bundle component variation id.

Parameters

Name

Type

Description

$componentVariationId

int

public hasNotBundleType($bundleType):Plenty\Modules\Pim\SearchService\Filter\VariationBundleFilter
Return type: VariationBundleFilter

Restricts the result to not match the specified bundle type.

Parameters

Name

Type

Description

$bundleType

string

public toArray():array
public setMinimumShouldMatch($minimumShouldMatch):void
Parameters

Name

Type

Description

$minimumShouldMatch

int

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

VariationRelatedLastUpdatedAtFilter

Used to filter by variation related last updated 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

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

WarehouseFilter

Includes filters for warehouse

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods
public isInWarehouse($warehouseId):Plenty\Modules\Pim\SearchService\Filter\WarehouseFilter
Return type: WarehouseFilter

Restricts the result to have the warehouse ID.

Parameters

Name

Type

Description

$warehouseId

int

public hasNotWarehouseIds($warehouseIds):Plenty\Modules\Pim\SearchService\Filter\WarehouseFilter
Return type: WarehouseFilter

Restricts the result to not match the specified IDs.

Parameters

Name

Type

Description

$warehouseIds

array

public hasWarehouseIds($warehouseIds):Plenty\Modules\Pim\SearchService\Filter\WarehouseFilter
Return type: WarehouseFilter

Restricts the result to have the any of the warehouse IDs.

Parameters

Name

Type

Description

$warehouseIds

array

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\BaseProcessor
Return type: BaseProcessor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessor
Return type: BaseProcessor
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\BaseProcessor
Return type: BaseProcessor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessor
Return type: BaseProcessor
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\BaseProcessor
Return type: BaseProcessor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessor
Return type: BaseProcessor
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\BaseProcessor
Return type: BaseProcessor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessor
Return type: BaseProcessor
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\BaseProcessor
Return type: BaseProcessor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessor
Return type: BaseProcessor
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\BaseProcessor
Return type: BaseProcessor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessor
Return type: BaseProcessor
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\BaseProcessor
Return type: BaseProcessor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessor
Return type: BaseProcessor
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\BaseProcessor
Return type: BaseProcessor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessor
Return type: BaseProcessor
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\BaseProcessor
Return type: BaseProcessor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessor
Return type: BaseProcessor
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\BaseProcessor
Return type: BaseProcessor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessor
Return type: BaseProcessor
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\BaseProcessor
Return type: BaseProcessor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessor
Return type: BaseProcessor
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\AttributeInterface
Return type: AttributeInterface

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

public createOrUpdate($entities):Plenty\Modules\Pim\VariationDataInterface\Operations\CreateOrUpdateOperation
Return type: CreateOrUpdateOperation

Get an operation to create or update data.

Parameters

Name

Type

Description

$entities

public replace($entities):Plenty\Modules\Pim\VariationDataInterface\Operations\ReplaceOperation
Return type: ReplaceOperation

Get an operation to replace data.

Parameters

Name

Type

Description

$entities

public delete($entities):Plenty\Modules\Pim\VariationDataInterface\Operations\DeleteOperation
Return type: DeleteOperation

Get a operation to delete data.

Parameters

Name

Type

Description

$entities

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.

inheritance

Inheritance

The inheritance 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\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext
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 getLimit():void
public setGetAllFound($getAll, $limit = null):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

set whether the result should return all found entities without pagination or not

Parameters

Name

Type

Description

$getAll

bool

$limit

int

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\VariationDataInterfaceContext
Return type: VariationDataInterfaceContext

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.

Operations

CreateOrUpdateOperation

The create or update operation for the vdi.

Namespace

Plenty\Modules\Pim\VariationDataInterface\Operations

Methods
public add($variations):Plenty\Modules\Pim\VariationDataInterface\Operations\BaseOperation
Return type: BaseOperation
Parameters

Name

Type

Description

$variations

public save():Plenty\Modules\Pim\DocumentService\Models\WriteResponse
Return type: WriteResponse

DeleteOperation

The delete operation for the vdi.

Namespace

Plenty\Modules\Pim\VariationDataInterface\Operations

Methods
public add($variations):Plenty\Modules\Pim\VariationDataInterface\Operations\BaseOperation
Return type: BaseOperation
Parameters

Name

Type

Description

$variations

public save():Plenty\Modules\Pim\DocumentService\Models\WriteResponse
Return type: WriteResponse

ReplaceOperation

The replace operation for the vdi.

Namespace

Plenty\Modules\Pim\VariationDataInterface\Operations

Methods
public add($variations):Plenty\Modules\Pim\VariationDataInterface\Operations\BaseOperation
Return type: BaseOperation
Parameters

Name

Type

Description

$variations

public save():Plenty\Modules\Pim\DocumentService\Models\WriteResponse
Return type: WriteResponse

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

VariationInheritanceAttribute

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

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

variationId

int

The unique ID of the variation.

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

variationId

int

The unique ID of the variation.

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.

variationId

int

The unique ID of the variation.

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

variationId

int

The unique ID of the variation.

isMain

bool

mainVariationId

int

itemId

int

position

int

isActive

bool

number

string

model

string

externalId

string

availability

int

availabilityId

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

itemType

string

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

variationId

int

The unique ID of the variation.

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

variationId

int

The unique ID of the variation.

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

variationId

int

The unique ID of the variation.

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

createdAt

Carbon

variationId

int

The unique ID of the variation.

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

variationId

int

The unique ID of the variation.

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

variationId

int

The unique ID of the variation.

imageId

int

The unique ID of the image

Methods
public toArray()

Returns this model as an array.

Inheritance

contains the inheritance informations of a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties