Plentymarkets interface documentation
Variation
Filters
DefaultVariationFilterBuilderContainer
Default variation filter builder container. Contains all available filter builders.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters
Methods
public removeFilterBuilder($key):voidName |
Type |
Description |
|
public addFilterBuilder($filterBuilder):voidName |
Type |
Description |
|
public getFilterBuilders():arraypublic removeFilterBuilders($key):voidName |
Type |
Description |
|
public removeAllFilterBuilders():voidFilterBuilder
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\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):voidReturns the filter that will be given to the export
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn 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\VariationHasAtLeastOneAvailabilityReturn type: VariationHasAtLeastOneAvailability
public variationHasAtLeastOneBundleType():Plenty\Modules\Pim\Catalog\Variation\Filters\BundleType\VariationHasAtLeastOneBundleTypeReturn type: VariationHasAtLeastOneBundleType
public variationIsInAtLeastOneCategory():Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInAtLeastOneCategoryReturn type: VariationIsInAtLeastOneCategory
public variationIsInCategories():Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInCategoriesReturn type: VariationIsInCategories
public variationHasAtLeastOneClient():Plenty\Modules\Pim\Catalog\Variation\Filters\Client\VariationHasAtLeastOneClientReturn type: VariationHasAtLeastOneClient
public variationHasClients():Plenty\Modules\Pim\Catalog\Variation\Filters\Client\VariationHasClientsReturn type: VariationHasClients
public variationHasImage():Plenty\Modules\Pim\Catalog\Variation\Filters\Image\VariationHasImageReturn type: VariationHasImage
public variationHasLinkedImages():Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationHasLinkedImagesReturn type: VariationHasLinkedImages
public itemHasImage():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasImageReturn type: ItemHasImage
public priceValue():Plenty\Modules\Pim\Catalog\Variation\Filters\Price\PriceValueReturn type: PriceValue
public variationCurrencies():Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationCurrenciesReturn type: VariationCurrencies
public salesPrice():Plenty\Modules\Pim\Catalog\Variation\Filters\SalesPrice\VariationHasSalesPriceReturn type: VariationHasSalesPrice
public itemBelongsToAtLeastOneAmazonFlatFile():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemBelongsToAtLeastOneAmazonFlatFileReturn type: ItemBelongsToAtLeastOneAmazonFlatFile
public itemBelongsToAtLeastOneAmazonProductType():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemBelongsToAtLeastOneAmazonProductTypeReturn type: ItemBelongsToAtLeastOneAmazonProductType
public itemCreatedAt():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemCreatedAtReturn type: ItemCreatedAt
public itemHasAtLeastOneFlagOne():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneFlagOneReturn type: ItemHasAtLeastOneFlagOne
public itemHasAtLeastOneFlagTwo():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneFlagTwoReturn type: ItemHasAtLeastOneFlagTwo
public itemHasAtLeastOneId():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneIdReturn type: ItemHasAtLeastOneId
public itemIsType():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemIsTypeReturn type: ItemIsType
public itemUpdatedAt():Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemUpdatedAtReturn type: ItemUpdatedAt
public itemHasAtLeastOneManufacturer():Plenty\Modules\Pim\Catalog\Variation\Filters\Manufacturer\ItemHasAtLeastOneManufacturerReturn type: ItemHasAtLeastOneManufacturer
public itemWithoutManufacturer():Plenty\Modules\Pim\Catalog\Variation\Filters\Manufacturer\ItemWithoutManufacturerReturn type: ItemWithoutManufacturer
public variationIsVisibleForAtLeastOneMarket():Plenty\Modules\Pim\Catalog\Variation\Filters\Markets\VariationIsVisibleForAtLeastOneMarketReturn type: VariationIsVisibleForAtLeastOneMarket
public variationIsVisibleForMarkets():Plenty\Modules\Pim\Catalog\Variation\Filters\Markets\VariationIsVisibleForMarketsReturn type: VariationIsVisibleForMarkets
public variationHasAtLeastOnePropertySelection():Plenty\Modules\Pim\Catalog\Variation\Filters\Property\VariationHasAtLeastOnePropertySelectionReturn type: VariationHasAtLeastOnePropertySelection
public variationHasPropertySelections():Plenty\Modules\Pim\Catalog\Variation\Filters\Property\VariationHasPropertySelectionsReturn type: VariationHasPropertySelections
public variationHasSku():Plenty\Modules\Pim\Catalog\Variation\Filters\Sku\VariationHasSkuReturn type: VariationHasSku
public variationHasAtLeastOneTag():Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationHasAtLeastOneTagReturn type: VariationHasAtLeastOneTag
Return type: VariationHasTags
Return type: VariationWithoutTags
public variationCreatedAt():Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationCreatedAtReturn type: VariationCreatedAt
public variationHasChildren():voidpublic variationIds():voidpublic variationIsActive():Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationIsActiveReturn type: VariationIsActive
public variationIsMain():Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationIsMainReturn type: VariationIsMain
public variationUpdatedAt():Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationUpdatedAtReturn type: VariationUpdatedAt
Return type: VariationRelatedUpdatedAt
public salesPriceUpdatedAt():Plenty\Modules\Pim\Catalog\Variation\Filters\Price\SalesPriceUpdatedAtReturn type: SalesPriceUpdatedAt
public stockUpdatedAt():Plenty\Modules\Pim\Catalog\Variation\Filters\Stock\StockUpdatedAtReturn type: StockUpdatedAt
public stockNet():Plenty\Modules\Pim\Catalog\Variation\Filters\Stock\StockNetReturn type: StockNet
public stockPhysical():Plenty\Modules\Pim\Catalog\Variation\Filters\Stock\StockPhysicalReturn type: StockPhysical
public hasStockInWarehouse():Plenty\Modules\Pim\Catalog\Variation\Filters\Stock\StockNetReturn type: StockNet
public hasNoStockInWarehouse():Plenty\Modules\Pim\Catalog\Variation\Filters\Stock\StockNetReturn type: StockNet
public hasAtLeastOneBarcode():Plenty\Modules\Pim\Catalog\Variation\Filters\Barcode\HasAtLeastOneBarcodeReturn type: HasAtLeastOneBarcode
public hasBarcode():Plenty\Modules\Pim\Catalog\Variation\Filters\Barcode\HasBarcodeReturn type: HasBarcode
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():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Will return a VariationBaseFilter if at least one availability is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setAvailabilities($availabilities):Plenty\Modules\Pim\Catalog\Variation\Filters\Availability\VariationHasAtLeastOneAvailabilityReturn type: VariationHasAtLeastOneAvailability
Name |
Type |
Description |
|
public addAvailability($availabilitiy):Plenty\Modules\Pim\Catalog\Variation\Filters\Availability\VariationHasAtLeastOneAvailabilityReturn type: VariationHasAtLeastOneAvailability
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderBarcode
HasAtLeastOneBarcode
Used to represent the HasAtLeastOneBarcode filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Barcode
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\BarcodeFilterReturn type: BarcodeFilter
Will return a BarcodeFilter if at least one barcode id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setBarcodeIds($barcodeIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Barcode\HasAtLeastOneBarcodeReturn type: HasAtLeastOneBarcode
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderHasBarcode
Used to represent the hasBarcode filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Barcode
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\BarcodeFilterReturn type: BarcodeFilter
Will return a Hasbarcode if a item type is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setHasBarcode($hasBarcode):Plenty\Modules\Pim\Catalog\Variation\Filters\Barcode\HasBarcodeReturn type: HasBarcode
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderBundleType
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():stringpublic setFilterData($filterData):voidName |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBundleFilterReturn type: VariationBundleFilter
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setBundleTypes($bundleTypes):Plenty\Modules\Pim\Catalog\Variation\Filters\BundleType\VariationHasAtLeastOneBundleTypeReturn type: VariationHasAtLeastOneBundleType
Name |
Type |
Description |
|
public addBundleType($bundleType):Plenty\Modules\Pim\Catalog\Variation\Filters\BundleType\VariationHasAtLeastOneBundleTypeReturn type: VariationHasAtLeastOneBundleType
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderCategory
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():stringpublic setFilterData($filterData):voidName |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\CategoryFilterReturn type: CategoryFilter
Will return a CategoryFilter if a category id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setShouldBeInACategory($shouldBeInACategory):Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInACategoryReturn type: VariationIsInACategory
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationIsInAtLeastOneCategory
Used to represent the isInAtLeastOneCategory filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Category
Methods
public getKey():stringpublic setFilterData($filterData):voidName |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\CategoryFilterReturn type: CategoryFilter
Will return a CategoryFilter if a category id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setCategoryIds($categoryIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInAtLeastOneCategoryReturn type: VariationIsInAtLeastOneCategory
Name |
Type |
Description |
|
public addCategoryId($categoryId):Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInAtLeastOneCategoryReturn type: VariationIsInAtLeastOneCategory
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationIsInCategories
Used to represent the isInEachCategory filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Category
Methods
public getKey():stringpublic setFilterData($filterData):voidName |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\CategoryFilterReturn type: CategoryFilter
Will return a CategoryFilter if a category id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setCategoryIds($categoryIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInCategoriesReturn type: VariationIsInCategories
Name |
Type |
Description |
|
public addCategoryId($categoryId):Plenty\Modules\Pim\Catalog\Variation\Filters\Category\VariationIsInCategoriesReturn type: VariationIsInCategories
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderClient
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():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ClientFilterReturn type: ClientFilter
Will return a ClientFilter if at least one client id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setClientIds($clientIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Client\VariationHasAtLeastOneClientReturn type: VariationHasAtLeastOneClient
Name |
Type |
Description |
|
public addClientId($clientId):Plenty\Modules\Pim\Catalog\Variation\Filters\Client\VariationHasAtLeastOneClientReturn type: VariationHasAtLeastOneClient
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationHasClients
Used to represent the isVisibleForAllClients filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Client
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ClientFilterReturn type: ClientFilter
Will return a ClientFilter if at least one client id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setClientIds($clientIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Client\VariationHasClientsReturn type: VariationHasClients
Name |
Type |
Description |
|
public addClientId($clientId):Plenty\Modules\Pim\Catalog\Variation\Filters\Client\VariationHasClientsReturn type: VariationHasClients
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderImage
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():stringpublic setFilterData($filterData):voidName |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Will return a VariationBaseFilter if shouldHaveImage is set. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setShouldHaveImage($shouldHaveImage):Plenty\Modules\Pim\Catalog\Variation\Filters\Image\VariationHasImageReturn type: VariationHasImage
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderItem
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():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\AmazonFilterReturn type: AmazonFilter
Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setAmazonFlatFiles($flatFiles):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemBelongsToAtLeastOneAmazonFlatFileReturn type: ItemBelongsToAtLeastOneAmazonFlatFile
Name |
Type |
Description |
|
public addAmazonFlatFile($flatFile):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemBelongsToAtLeastOneAmazonFlatFileReturn type: ItemBelongsToAtLeastOneAmazonFlatFile
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderItemBelongsToAtLeastOneAmazonProductType
Used to represent the ItemBelongsToAmazonFlatFile filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Item
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\AmazonFilterReturn type: AmazonFilter
Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setAmazonProductTypes($productTypes):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemBelongsToAtLeastOneAmazonProductTypeReturn type: ItemBelongsToAtLeastOneAmazonProductType
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderItemCreatedAt
Used to represent the ItemCreatedAtFilter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Item
Methods
public getKey():stringpublic getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemCreatedAtFilterReturn type: ItemCreatedAtFilter
Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public setFilterData($filterData):voidName |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):voidName |
Type |
Description |
|
||
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderItemHasAtLeastOneFlagOne
Used to represent the ItemHasFlagOne filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Item
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Will return a ItemFilter if a flag is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setFlags($flags):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneFlagOneReturn type: ItemHasAtLeastOneFlagOne
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderItemHasAtLeastOneFlagTwo
Used to represent the ItemHasFlagTwo filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Item
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Will return a ItemFilter if a flag is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setFlags($flags):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneFlagTwoReturn type: ItemHasAtLeastOneFlagTwo
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderItemHasAtLeastOneId
Used to represent the ItemHasIds filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Item
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):voidName |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setItemIds($itemIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneIdReturn type: ItemHasAtLeastOneId
Name |
Type |
Description |
|
public addItemId($itemId):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasAtLeastOneIdReturn type: ItemHasAtLeastOneId
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderItemHasImage
Used to represent the itemHasImage filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Item
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Will return a ItemFilter if a item type is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setHasImage($shouldBeMain):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemHasImageReturn type: ItemHasImage
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderItemIsType
Used to represent the isItemType filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Item
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Will return a ItemFilter if a item type is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public setItemType($itemType):Plenty\Modules\Pim\Catalog\Variation\Filters\Item\ItemIsTypeReturn type: ItemIsType
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderItemUpdatedAt
Used to represent the ItemUpdatedAtFilter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Item
Methods
public getKey():stringpublic getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemUpdatedAtFilterReturn type: ItemUpdatedAtFilter
Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public setFilterData($filterData):voidName |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):voidName |
Type |
Description |
|
||
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderManufacturer
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():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Will return a VariationBaseFilter if at least one manufacturer id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setManufacturerIds($manufacturerIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Manufacturer\ItemHasAtLeastOneManufacturerReturn type: ItemHasAtLeastOneManufacturer
Name |
Type |
Description |
|
public addManufacturerId($manufacturerId):Plenty\Modules\Pim\Catalog\Variation\Filters\Manufacturer\ItemHasAtLeastOneManufacturerReturn type: ItemHasAtLeastOneManufacturer
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderItemWithoutManufacturer
Used to represent the HasManufacturer filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Manufacturer
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Will return a VariationBaseFilter if at least one manufacturer id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setShouldBeActive($shouldBeActive):Plenty\Modules\Pim\Catalog\Variation\Filters\Manufacturer\ItemWithoutManufacturerReturn type: ItemWithoutManufacturer
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderMarkets
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():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\MarketFilterReturn type: MarketFilter
Will return a MarketFilter if at least one market id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setMarketIds($marketIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Markets\VariationIsVisibleForAtLeastOneMarketReturn type: VariationIsVisibleForAtLeastOneMarket
Name |
Type |
Description |
|
public addMarketId($marketId):Plenty\Modules\Pim\Catalog\Variation\Filters\Markets\VariationIsVisibleForAtLeastOneMarketReturn type: VariationIsVisibleForAtLeastOneMarket
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationIsVisibleForMarkets
Used to represent the VariationIsVisibleForAllMarkets filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Markets
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\MarketFilterReturn type: MarketFilter
Will return a MarketFilter if at least one market id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setMarketIds($marketIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Markets\VariationIsVisibleForMarketsReturn type: VariationIsVisibleForMarkets
Name |
Type |
Description |
|
public addMarketId($marketId):Plenty\Modules\Pim\Catalog\Variation\Filters\Markets\VariationIsVisibleForMarketsReturn type: VariationIsVisibleForMarkets
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderPrice
PriceValue
Used to filter by sales price
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Price
Methods
public getKey():stringpublic getFilter($settings = []):voidReturns the filter that will be given to the export
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setFilterData($filterData):voidName |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderSalesPriceUpdatedAt
Used to filter by variation salesPrice last update timestamp
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Price
Methods
public getKey():stringpublic getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationSalesPriceUpdatedAtFilterReturn type: VariationSalesPriceUpdatedAtFilter
Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public setFilterData($filterData):voidName |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):voidName |
Type |
Description |
|
||
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderProperty
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():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\PropertyFilterReturn type: PropertyFilter
Will return a VariationPropertyFilter if at least property selection id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setPropertySelectionIds($propertySelectionIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Property\VariationHasAtLeastOnePropertySelectionReturn type: VariationHasAtLeastOnePropertySelection
Name |
Type |
Description |
|
public addPropertySelectionId($propertySelectionId):Plenty\Modules\Pim\Catalog\Variation\Filters\Property\VariationHasAtLeastOnePropertySelectionReturn type: VariationHasAtLeastOnePropertySelection
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationHasPropertySelections
Used to represent the VariationHasEachPropertySelection filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Property
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\PropertyFilterReturn type: PropertyFilter
Will return a VariationPropertyFilter if at least property selection id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setPropertySelectionIds($propertySelectionIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Property\VariationHasPropertySelectionsReturn type: VariationHasPropertySelections
Name |
Type |
Description |
|
public addPropertySelectionId($propertySelectionId):Plenty\Modules\Pim\Catalog\Variation\Filters\Property\VariationHasPropertySelectionsReturn type: VariationHasPropertySelections
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderSalesPrice
VariationHasSalesPrice
Used to represent the VariationHasSalesPrice filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\SalesPrice
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\SalesPriceFilterReturn type: SalesPriceFilter
Will return a TagFilter if at least one tag id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setSalesPricesIds($salesPricesIds):Plenty\Modules\Pim\Catalog\Variation\Filters\SalesPrice\VariationHasSalesPriceReturn type: VariationHasSalesPrice
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderSku
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():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\SkuFilterReturn type: SkuFilter
Will return a SkuFilter if at least accountId, marketId or status are provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setReferrer($referrer):Plenty\Modules\Pim\Catalog\Variation\Filters\Sku\VariationHasSkuReturn type: VariationHasSku
Name |
Type |
Description |
|
public setAccountId($accountId):Plenty\Modules\Pim\Catalog\Variation\Filters\Sku\VariationHasSkuReturn type: VariationHasSku
Name |
Type |
Description |
|
public setStatus($status):Plenty\Modules\Pim\Catalog\Variation\Filters\Sku\VariationHasSkuReturn type: VariationHasSku
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderStock
HasNoStockInWarehouse
Used to filter by stock in warehouse
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Stock
Methods
public getKey():stringpublic getFilter($settings = []):voidReturns the filter that will be given to the export
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setFilterData($filterData):voidName |
Type |
Description |
|
public setWarehouseIds($warehouseIds):voidName |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderHasStockInWarehouse
Used to filter by stock in warehouse
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Stock
Methods
public getKey():stringpublic getFilter($settings = []):voidReturns the filter that will be given to the export
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setFilterData($filterData):voidName |
Type |
Description |
|
public setWarehouseIds($warehouseIds):voidName |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderStockNet
Used to filter by variation stock net
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Stock
Methods
public getKey():stringpublic getFilter($settings = []):voidReturns the filter that will be given to the export
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setFilterData($filterData):voidName |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderStockPhysical
Used to filter by variation stock physical
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Stock
Methods
public getKey():stringpublic getFilter($settings = []):voidReturns the filter that will be given to the export
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setFilterData($filterData):voidName |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderStockUpdatedAt
Used to filter by variation stock last update timestamp
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Stock
Methods
public getKey():stringpublic getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationStockUpdatedAtFilterReturn type: VariationStockUpdatedAtFilter
Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public setFilterData($filterData):voidName |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):voidName |
Type |
Description |
|
||
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderTag
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():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\TagFilterReturn type: TagFilter
Will return a TagFilter if at least one tag id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setTagIds($tagIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationHasAtLeastOneTagReturn type: VariationHasAtLeastOneTag
Name |
Type |
Description |
|
public addTagId($tagId):Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationHasAtLeastOneTagReturn type: VariationHasAtLeastOneTag
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationHasTags
Used to represent the ItemHasTags filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Tag
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\TagFilterReturn type: TagFilter
Will return a TagFilter if at least one tag id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setTagIds($tagIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationHasTagsReturn type: VariationHasTags
Name |
Type |
Description |
|
public addTagId($tagId):Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationHasTagsReturn type: VariationHasTags
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationWithoutTags
Used to represent the ItemWithoutTags filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Tag
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\TagFilterReturn type: TagFilter
Will return a TagFilter if at least one tag id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setTagIds($tagIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationWithoutTagsReturn type: VariationWithoutTags
Name |
Type |
Description |
|
public addTagId($tagId):Plenty\Modules\Pim\Catalog\Variation\Filters\Tag\VariationWithoutTagsReturn type: VariationWithoutTags
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariation
VariationCreatedAt
Used to represent the VariationCreatedAtFilter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Variation
Methods
public getKey():stringpublic getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationCreatedAtFilterReturn type: VariationCreatedAtFilter
Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public setFilterData($filterData):voidName |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):voidName |
Type |
Description |
|
||
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationCurrencies
Used to represent the VariationCurrencies filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Variation
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\SalesPriceFilterReturn type: SalesPriceFilter
Will return a VariationBaseFilter if shouldBeActive is defined. Otherwise null will be returned
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setCurrenciesIds($currenciesIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationCurrenciesReturn type: VariationCurrencies
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationHasChildren
Used to represent the hasChildren filters in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Variation
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Will return a VariationBaseFilter if shouldBeMain is defined. Otherwise null will be returned
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setShouldHaveChildren($shouldHaveChildren):Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationHasChildrenReturn type: VariationHasChildren
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationHasLinkedImages
Used variations wtih linked images.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Variation
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Will return a VariationBaseFilter if shouldBeActive is defined. Otherwise null will be returned
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setShouldBeActive($shouldBeActive):Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationHasLinkedImagesReturn type: VariationHasLinkedImages
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationIds
Used to represent the VariationIsActive filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Variation
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Will return a VariationBaseFilter if shouldBeActive is defined. Otherwise null will be returned
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setVariationIds($variationIds):Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationIdsReturn type: VariationIds
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationIsActive
Used to represent the VariationIsActive filter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Variation
Methods
public getKey():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Will return a VariationBaseFilter if shouldBeActive is defined. Otherwise null will be returned
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setShouldBeActive($shouldBeActive):Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationIsActiveReturn type: VariationIsActive
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationIsMain
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():stringpublic setFilterData($filterData):voidThis 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.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Will return a VariationBaseFilter if shouldBeMain is defined. Otherwise null will be returned
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setShouldBeMain($shouldBeMain):Plenty\Modules\Pim\Catalog\Variation\Filters\Variation\VariationIsMainReturn type: VariationIsMain
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationRelatedUpdatedAt
Used to represent the VariationRelatedUpdatedAtFilter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Variation
Methods
public getKey():stringpublic getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationRelatedLastUpdatedAtFilterReturn type: VariationRelatedLastUpdatedAtFilter
Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public setFilterData($filterData):voidName |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):voidName |
Type |
Description |
|
||
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderVariationUpdatedAt
Used to represent the VariationUpdatedAtFilter in both the catalog export and UI.
Namespace
Plenty\Modules\Pim\Catalog\Variation\Filters\Variation
Methods
public getKey():stringpublic getFilter($settings = []):Plenty\Modules\Pim\SearchService\Filter\VariationLastUpdatedAtFilterReturn type: VariationLastUpdatedAtFilter
Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public setFilterData($filterData):voidName |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setTimeWindow($fromDate, $toDate = null):voidName |
Type |
Description |
|
||
|
public setRequired($required):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderReturn type: FilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Pim\Catalog\Variation\Filters\FilterBuilderContracts
Attribute
AttributeNameRepositoryContract
The contract for the pim attribute name repository
Namespace
Plenty\Modules\Pim\Contracts\Attribute
Methods
public search($with = [], $page = 1, $perPage = 50):Illuminate\Support\CollectionReturn type: Collection
Search for attribute names
Name |
Type |
Description |
|
||
|
||
|
public update($data):Illuminate\Support\CollectionReturn type: Collection
Updates a list of attribute names
Name |
Type |
Description |
|
public create($data):Illuminate\Support\CollectionReturn type: Collection
Creates a list of attribute names
Name |
Type |
Description |
|
public delete($data):Illuminate\Support\CollectionReturn type: Collection
Deletes a list of attribute names
Name |
Type |
Description |
|
public getCount():intGets the total count of attribute names
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
AttributeRepositoryContract
The contract for the pim attribute repository
Namespace
Plenty\Modules\Pim\Contracts\Attribute
Methods
public search($with = [], $page = 1, $perPage = 50):Illuminate\Support\CollectionReturn type: Collection
Searches for attributes
Name |
Type |
Description |
|
||
|
||
|
public update($data):Illuminate\Support\CollectionReturn type: Collection
Updates a list of attributes
Name |
Type |
Description |
|
public create($data):Illuminate\Support\CollectionReturn type: Collection
Creates a list of attributes
Name |
Type |
Description |
|
public delete($data):Illuminate\Support\CollectionReturn type: Collection
Deletes a list of attributes
Name |
Type |
Description |
|
public getById($id, $with = []):Plenty\Modules\Item\Attribute\Models\AttributeReturn type: Attribute
Get one attribute by ID
Name |
Type |
Description |
|
||
|
public getCount():intGets the total count of attributes
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
AttributeValueNameRepositoryContract
The contract for the attribute value name repository
Namespace
Plenty\Modules\Pim\Contracts\Attribute
Methods
public search($with = [], $page = 1, $perPage = 50):Illuminate\Support\CollectionReturn type: Collection
Search attribute value names
Name |
Type |
Description |
|
||
|
||
|
public update($data):Illuminate\Support\CollectionReturn type: Collection
Updates a list of attribute value names
Name |
Type |
Description |
|
public create($data):Illuminate\Support\CollectionReturn type: Collection
Creates a list of attribute value names
Name |
Type |
Description |
|
public delete($data):Illuminate\Support\CollectionReturn type: Collection
Deletes a list of attribute value names
Name |
Type |
Description |
|
public getCount():intGets the total count of attribute value names
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
AttributeValueRepositoryContract
The contract for the pim attribute value repository
Namespace
Plenty\Modules\Pim\Contracts\Attribute
Methods
public search($with = [], $page = 1, $perPage = 50):Illuminate\Support\CollectionReturn type: Collection
Searches for attribute values
Name |
Type |
Description |
|
||
|
||
|
public update($data):Illuminate\Support\CollectionReturn type: Collection
Updates a list of attribute values
Name |
Type |
Description |
|
public create($data):Illuminate\Support\CollectionReturn type: Collection
Creates a list of attribute values
Name |
Type |
Description |
|
public delete($data):Illuminate\Support\CollectionReturn type: Collection
Deletes a list of attribute values
Name |
Type |
Description |
|
public getById($id, $with = []):Plenty\Modules\Item\Attribute\Models\AttributeValueReturn type: AttributeValue
Get one attribute value by ID
Name |
Type |
Description |
|
||
|
public getCount():intGets the total count of attribute values
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Barcode
BarcodeRepositoryContract
The contract for the pim barcode repository
Namespace
Plenty\Modules\Pim\Contracts\Barcode
Methods
public search($with = [], $page = 1, $perPage = 50):Illuminate\Support\CollectionReturn type: Collection
Searches for barcodes
Name |
Type |
Description |
|
||
|
||
|
public getById($id, $with = []):Plenty\Modules\Item\Barcode\Models\BarcodeReturn type: Barcode
Get one attribute by ID
Name |
Type |
Description |
|
||
|
public update($data):Illuminate\Support\CollectionReturn type: Collection
Updates a list of barcodes
Name |
Type |
Description |
|
public create($data):Illuminate\Support\CollectionReturn type: Collection
Creates a list of barcodes
Name |
Type |
Description |
|
public delete($data):Illuminate\Support\CollectionReturn type: Collection
Deletes a list of barcodes
Name |
Type |
Description |
|
public getCount():intGets the total count of barcodes
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Category
CategoryDetailRepositoryContract
To be written…
Namespace
Plenty\Modules\Pim\Contracts\Category
Methods
public search($with = [], $page = 1, $perPage = 50):Illuminate\Support\CollectionReturn type: Collection
Search category details
Name |
Type |
Description |
|
||
|
||
|
public getCount():intpublic clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
CategoryRepositoryContract
The contract for the pim category repository
Namespace
Plenty\Modules\Pim\Contracts\Category
Methods
public search($with = [], $page = 1, $perPage = 50, $sorting = []):Illuminate\Support\CollectionReturn type: Collection
Search for categories
Name |
Type |
Description |
|
||
|
||
|
||
|
public getById($id, $with = []):Plenty\Modules\Category\Models\CategoryReturn type: Category
Get one category by ID
Name |
Type |
Description |
|
||
|
public getCount():intpublic clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears 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\GtinConfigReturn type: GtinConfig
Gets GTIN 13 barcodes from plenty_text
Name |
Type |
Description |
|
Default false. If true generates a new GTIN |
Manufacturer
ManufacturerRepositoryContract
The contract for the pim manufacturer repository
Namespace
Plenty\Modules\Pim\Contracts\Manufacturer
Methods
public search($with = [], $page = 1, $perPage = 50):Illuminate\Support\CollectionReturn type: Collection
Search for manufacturer
Name |
Type |
Description |
|
||
|
||
|
public create($data):Illuminate\Support\CollectionReturn type: Collection
Create a list of manufacturer
Name |
Type |
Description |
|
public update($data):Illuminate\Support\CollectionReturn type: Collection
Update a list of manufacturer
Name |
Type |
Description |
|
public delete($data):Illuminate\Support\CollectionReturn type: Collection
Delete a list of manufacturer
Name |
Type |
Description |
|
public getById($id):Plenty\Modules\Item\Manufacturer\Models\ManufacturerReturn type: Manufacturer
Get one manufacturer
Name |
Type |
Description |
|
public getCount():intpublic clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
SalesPrice
SalesPriceRepositoryContract
The contract for the pim sales price repository
Namespace
Plenty\Modules\Pim\Contracts\SalesPrice
Methods
public search($with = [], $page = 1, $perPage = 50, $sorting = []):Illuminate\Support\CollectionReturn type: Collection
Searches for sales prices
Name |
Type |
Description |
|
||
|
||
|
||
|
public create($data):Illuminate\Support\CollectionReturn type: Collection
Creates a list of sales prices
Name |
Type |
Description |
|
public update($data):Illuminate\Support\CollectionReturn type: Collection
Updates a list of sales prices
Name |
Type |
Description |
|
public delete($data):Illuminate\Support\CollectionReturn type: Collection
Deletes a list of sales prices
Name |
Type |
Description |
|
public getById($id, $with = []):Plenty\Modules\Item\SalesPrice\Models\SalesPriceReturn type: SalesPrice
Gets one sales price by ID
Name |
Type |
Description |
|
||
|
public getCount():intGets the total count of sales prices
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
Variation
PropertySelectionValue
The Property selection values of the variation
Namespace
Plenty\Modules\Pim\DocumentService\Models\Variation
| Name | Type | Description |
|---|---|---|
id |
The id of the relation selection value |
|
selectionId |
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
| Name | Type | Description |
|---|---|---|
id |
The id of the relation value |
|
lang |
The lang of the relation value |
|
value |
The value of the relation value |
|
description |
The description of the relation value |
Methods
public toArray()Returns this model as an array.
Item
AmazonProductType
The amazon product type model.
Namespace
Plenty\Modules\Pim\Models\Item
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the amazon product type |
|
genre |
The genre of the amazon product type |
|
type |
The type of the amazon product type |
|
genreDescription |
The description of the amazon product genre |
|
typeDescription |
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():voidpublic setVariationId($variationId):Plenty\Modules\Pim\DocumentService\Models\WriteableAttributeReturn type: WriteableAttribute
Set the variation ID of the part
Name |
Type |
Description |
|
public getUniqueKeyValue():stringpublic getKey():stringpublic getValidator($operation):stringName |
Type |
Description |
|
public hasChanged($model):boolName |
Type |
Description |
|
SearchService
Aggregations
AttributeValueAggregation
Aggregate data by attributeValue ids
Namespace
Plenty\Modules\Pim\SearchService\Aggregations
Methods
public getName():stringGet the name of the aggregation
public getField():stringGet the field of the aggregation
public getAggregation():arraypublic setInclude($string):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidCategoryAllTermsAggregation
Aggregate data by all category ids
Namespace
Plenty\Modules\Pim\SearchService\Aggregations
Methods
public getName():stringGet the name of the aggregation
public getField():stringGet the field of the aggregation
public getAggregation():arraypublic setInclude($string):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidCategoryPathTermsAggregation
Aggregate data by all category paths
Namespace
Plenty\Modules\Pim\SearchService\Aggregations
Methods
public getName():stringGet the name of the aggregation
public getField():stringGet the field of the aggregation
public getAggregation():arraypublic setInclude($string):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidItemCardinalityAggregation
Get the count of found items
Namespace
Plenty\Modules\Pim\SearchService\Aggregations
Methods
public getName():stringGet the name of the aggregation
public getField():stringGet the field of the aggregation
public getAggregation():arraypublic toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidItemIdTermsAggregation
Aggregate data by item ids
Namespace
Plenty\Modules\Pim\SearchService\Aggregations
Methods
public getName():stringGet the name of the aggregation
public getField():stringGet the field of the aggregation
public getAggregation():arraypublic setInclude($string):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidSalableFilterAggregation
Filter Aggregated Data if variation is salable
Namespace
Plenty\Modules\Pim\SearchService\Aggregations
Methods
public getName():stringGet the name of the aggregation
public getAggregation():arraypublic addFilter($filter):voidName |
Type |
Description |
|
public setIndex($index):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidUnitCombinationAggregation
Aggregate data by unit combination ids
Namespace
Plenty\Modules\Pim\SearchService\Aggregations
Methods
public getName():stringGet the name of the aggregation
public getField():stringGet the field of the aggregation
public getAggregation():arraypublic setInclude($string):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidFilter
AmazonFilter
Includes filters for amazon
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasAnyFlatFile($flatFiles):Plenty\Modules\Pim\SearchService\Filter\AmazonFilterReturn type: AmazonFilter
Restricts the result to have any of the specified flatFiles.
Name |
Type |
Description |
|
public hasAnyProductType($productTypes):Plenty\Modules\Pim\SearchService\Filter\AmazonFilterReturn type: AmazonFilter
Restricts the result to have any of the specified productTypes.
Name |
Type |
Description |
|
public hasAnyProductTypeId($productTypeIds):Plenty\Modules\Pim\SearchService\Filter\AmazonFilterReturn type: AmazonFilter
Restricts the result to have any of the specified typeIds.
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
AttributeFilter
Includes filters for attributes
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasAttribute($attributeId):Plenty\Modules\Pim\SearchService\Filter\AttributeFilterReturn type: AttributeFilter
Restricts the result to have the specified attributeId.
Name |
Type |
Description |
|
public hasAnyAttribute($attributeIds):Plenty\Modules\Pim\SearchService\Filter\AttributeFilterReturn type: AttributeFilter
Restricts the result to have any of the specified attributeId.
Name |
Type |
Description |
|
public hasAllAttributes($attributeIds):Plenty\Modules\Pim\SearchService\Filter\AttributeFilterReturn type: AttributeFilter
Restricts the result to has all of the specified attributeId.
Name |
Type |
Description |
|
public hasAttributeValue($attributeValueId):Plenty\Modules\Pim\SearchService\Filter\AttributeFilterReturn type: AttributeFilter
Restricts the result to have the specified attributeValueId.
Name |
Type |
Description |
|
public hasAnyAttributeValue($attributeValueIds):Plenty\Modules\Pim\SearchService\Filter\AttributeFilterReturn type: AttributeFilter
Restricts the result to have any of the specified attributeValueId.
Name |
Type |
Description |
|
public hasAllAttributeValues($attributeValueIds):Plenty\Modules\Pim\SearchService\Filter\AttributeFilterReturn type: AttributeFilter
Restricts the result to have all of the specified attributeValueId.
Name |
Type |
Description |
|
public hasNoAttributeValue():voidRestricts the result to have no attribute value.
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
BarcodeFilter
Includes filters for barcodes
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasCode($code, $precision):Plenty\Modules\Pim\SearchService\Filter\BarcodeFilterReturn type: BarcodeFilter
Restricts the result to have a specified code.
Name |
Type |
Description |
|
||
|
public hasType($type):voidRestricts the result to have a specified type. Not implemented.
Name |
Type |
Description |
|
public hasId($id):Plenty\Modules\Pim\SearchService\Filter\BarcodeFilterReturn type: BarcodeFilter
Restricts the result to have a specified id.
Name |
Type |
Description |
|
public hasNoBarcode():Plenty\Modules\Pim\SearchService\Filter\BarcodeFilterReturn type: BarcodeFilter
Restricts the result to have no barcodes
public hasBarcode():Plenty\Modules\Pim\SearchService\Filter\BarcodeFilterReturn type: BarcodeFilter
Restricts the result to have at least one barcode
public hasAnyBarcode($barcodeIds):Plenty\Modules\Pim\SearchService\Filter\BarcodeFilterReturn type: BarcodeFilter
Restricts the result to have any of the barcode ids.
Name |
Type |
Description |
|
public withoutBarcode($barcodeId):Plenty\Modules\Pim\SearchService\Filter\BarcodeFilterReturn type: BarcodeFilter
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
CategoryFilter
Includes filters for categories
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public isInAtLeastOneCategory($categoryIds, $depth = self::DEPTH_ANY):Plenty\Modules\Pim\SearchService\Filter\CategoryFilterReturn type: CategoryFilter
Restricts the result to have any of the categoryIds.
Name |
Type |
Description |
|
||
|
public static getPathByDepth($depth):stringGet the path by depth.
Name |
Type |
Description |
|
public isInEachCategory($categoryIds, $depth = self::DEPTH_ANY):Plenty\Modules\Pim\SearchService\Filter\CategoryFilterReturn type: CategoryFilter
Restricts the result to have all of the categoryIds.
Name |
Type |
Description |
|
||
|
public isInCategory($categoryId, $depth = self::DEPTH_ANY):Plenty\Modules\Pim\SearchService\Filter\CategoryFilterReturn type: CategoryFilter
Restricts the result to have the categoryId.
Name |
Type |
Description |
|
||
|
public isInACategory($bool = true):Plenty\Modules\Pim\SearchService\Filter\CategoryFilterReturn type: CategoryFilter
Restricts the result to have a category.
Name |
Type |
Description |
|
public hasNotCategoryIds($categoryIds, $depth = self::DEPTH_ANY):Plenty\Modules\Pim\SearchService\Filter\CategoryFilterReturn type: CategoryFilter
Restricts the result to not match the specified IDs.
Name |
Type |
Description |
|
||
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
CharacteristicFilter
Includes filters for characteristics
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasAtLeastOneProperty($ids):Plenty\Modules\Pim\SearchService\Filter\CharacteristicFilterReturn type: CharacteristicFilter
Restricts the result to have any of the characteristicIds.
Name |
Type |
Description |
|
public hasEachProperty($ids):Plenty\Modules\Pim\SearchService\Filter\CharacteristicFilterReturn type: CharacteristicFilter
Restricts the result to have all of the characteristicIds.
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
ClientFilter
Includes filters for clients
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public isVisibleForClient($clientId):Plenty\Modules\Pim\SearchService\Filter\ClientFilterReturn type: ClientFilter
Restricts the result to have the clientId.
Name |
Type |
Description |
|
public isVisibleForAtLeastOneClient($clientIds):Plenty\Modules\Pim\SearchService\Filter\ClientFilterReturn type: ClientFilter
Restricts the result to have any of the clientIds.
Name |
Type |
Description |
|
public isVisibleForAllClients($clientIds):Plenty\Modules\Pim\SearchService\Filter\ClientFilterReturn type: ClientFilter
Restricts the result to have all of the clientIds.
Name |
Type |
Description |
|
public hasAutomaticClientVisibility($values):Plenty\Modules\Pim\SearchService\Filter\ClientFilterReturn type: ClientFilter
Restricts the result to have any of the automaticClientVisibilities. (-1, 0, 1, 2)
Name |
Type |
Description |
|
public hasNotClientIds($clientIds):Plenty\Modules\Pim\SearchService\Filter\ClientFilterReturn type: ClientFilter
Restricts the result to not match the specified IDs.
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
CrossSellingFilter
Includes filters for cross selling
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getPath():stringget the nested path of the filter
public hasItemId($itemId):voidRestricts the result to have the itemId linked
Name |
Type |
Description |
|
public hasRelation($relation):Plenty\Modules\Pim\SearchService\Filter\CrossSellingFilterReturn type: CrossSellingFilter
Restricts the result to have the relation
Name |
Type |
Description |
|
public hasAnyRelation($relations):Plenty\Modules\Pim\SearchService\Filter\CrossSellingFilterReturn type: CrossSellingFilter
Restricts the result to have any relation
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
DocumentUpdatedAtFilter
Used to filter by elastic search document last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
FacetFilter
Includes filters for facets
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasAtLeastOneFacet($facetIds):Plenty\Modules\Pim\SearchService\Filter\FacetFilterReturn type: FacetFilter
Restricts the result to have any of the facetIds.
Name |
Type |
Description |
|
public hasEachFacet($facetIds):Plenty\Modules\Pim\SearchService\Filter\FacetFilterReturn type: FacetFilter
Restricts the result to have all facetIds.
Name |
Type |
Description |
|
public hasFacet($facetIds):Plenty\Modules\Pim\SearchService\Filter\FacetFilterReturn type: FacetFilter
Restricts the result to have the facetIds.
Name |
Type |
Description |
|
public hasFacetValue($facetValueId):Plenty\Modules\Pim\SearchService\Filter\FacetFilterReturn type: FacetFilter
Restricts the result to have the facetValueId.
Name |
Type |
Description |
|
public hasAFacet():Plenty\Modules\Pim\SearchService\Filter\FacetFilterReturn type: FacetFilter
Restricts the result to have any of the facetValueIds.
public hasAtLeastOneFacetValue($valueIds):Plenty\Modules\Pim\SearchService\Filter\FacetFilterReturn type: FacetFilter
Restricts the result to have any of the facetValueIds.
Name |
Type |
Description |
|
public hasEachFacetValue($valueIds):Plenty\Modules\Pim\SearchService\Filter\FacetFilterReturn type: FacetFilter
Restricts the result to have all the facetValueIds.
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
FeedbackRangeFilter
Includes filters for feedback
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasFeedbackGreaterThan($value):Plenty\Modules\Pim\SearchService\Filter\FeedbackRangeFilterReturn type: FeedbackRangeFilter
Restricts the result to have feedback greater than or equal the value.
Name |
Type |
Description |
|
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
ItemCreatedAtFilter
Used to filter by item created at timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
ItemFilter
Includes filters for the item
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasId($id):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to have the item id.
Name |
Type |
Description |
|
public hasIds($ids):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to have all the item ids.
Name |
Type |
Description |
|
public hasAnImage():Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to have an image that is not linked to any variation.
public doesntHaveAnImage():Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to have an image that is not linked to any variation.
public hasAnyImage():Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the results to have an image on item
public hasFlag1($flagId):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to have the specified flag 1.
Name |
Type |
Description |
|
public hasAnyFlag1($flags):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to have any of the specified flags.
Name |
Type |
Description |
|
public hasFlag2($flagId):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to have the specified flag 2.
Name |
Type |
Description |
|
public hasAnyFlag2($flags):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to have any of the specified flags.
Name |
Type |
Description |
|
public hasListing():Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
public hasNoListing():Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
public hasManufacturer($manufacturerId):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to have the manufacturer id.
Name |
Type |
Description |
|
public hasManufacturers($manufacturerIds):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to have any of the manufacturer ids.
Name |
Type |
Description |
|
public hasAManufacturer():Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to have an manufacturer.
public withoutManufacturer():voidpublic isItemType($itemType):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to have the specified item type.
Name |
Type |
Description |
|
public isNotItemType($itemType):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Restricts the result to not have the specified item type.
Name |
Type |
Description |
|
public hasAnyRevenueAccount($revenueAccounts):Plenty\Modules\Pim\SearchService\Filter\ItemFilterReturn type: ItemFilter
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
ItemLastUpdatedAtFilter
Used to filter by item last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
ItemRangeFilter
used to filter the range between item ids
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
ItemUpdatedAtFilter
Used to filter by item created at timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringpublic getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
MarketFilter
Includes filters for markets
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public isVisibleForMarket($marketId):Plenty\Modules\Pim\SearchService\Filter\MarketFilterReturn type: MarketFilter
Restricts the result to have the market id.
Name |
Type |
Description |
|
public isVisibleForAtLeastOneMarket($marketIds):Plenty\Modules\Pim\SearchService\Filter\MarketFilterReturn type: MarketFilter
Restricts the result to have any of the market ids.
Name |
Type |
Description |
|
public isNotAvailableForAtLeastOneMarket($marketIds):Plenty\Modules\Pim\SearchService\Filter\MarketFilterReturn type: MarketFilter
Restricts the result to not have any of the market ids.
Name |
Type |
Description |
|
public isVisibleForAllMarkets($marketIds):Plenty\Modules\Pim\SearchService\Filter\MarketFilterReturn type: MarketFilter
Restricts the result to have all the market ids.
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
PriceFilter
Includes filters for prices
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getPath():stringGet the path of the filter
public between($min = null, $max = null):voidRestricts the result to have a price between the specified min and max value.
Name |
Type |
Description |
|
||
|
public betweenByPriceId($priceIds = [], $min = null, $max = null):Plenty\Modules\Pim\SearchService\Filter\PriceFilterReturn 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.
Name |
Type |
Description |
|
||
|
||
|
public priceValue($priceValue, $priceType, $operator = "eq"):Plenty\Modules\Pim\SearchService\Filter\PriceFilterReturn type: PriceFilter
Name |
Type |
Description |
|
||
|
||
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
PropertyFilter
Includes filters for Properties
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasPropertySelection($id):Plenty\Modules\Pim\SearchService\Filter\PropertyFilterReturn type: PropertyFilter
Restricts the result to have the property selection id.
Name |
Type |
Description |
|
public hasAtLeastOnePropertySelection($ids):Plenty\Modules\Pim\SearchService\Filter\PropertyFilterReturn type: PropertyFilter
Restricts the result to have any of the property selection ids.
Name |
Type |
Description |
|
public hasEachPropertySelection($ids):Plenty\Modules\Pim\SearchService\Filter\PropertyFilterReturn type: PropertyFilter
Restricts the result to have all of the property selection ids.
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
SalesPriceFilter
Includes filters for salesPrices
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasAtLeastOnePrice($priceIds):Plenty\Modules\Pim\SearchService\Filter\SalesPriceFilterReturn type: SalesPriceFilter
Restricts the result to have any of the price ids.
Name |
Type |
Description |
|
public hasPriceIds($priceIds):Plenty\Modules\Pim\SearchService\Filter\SalesPriceFilterReturn type: SalesPriceFilter
Name |
Type |
Description |
|
public hasNotPriceIds($priceIds):Plenty\Modules\Pim\SearchService\Filter\SalesPriceFilterReturn type: SalesPriceFilter
Restricts the result to not match the specified IDs.
Name |
Type |
Description |
|
public hasLowestPrice($bool = true):voidName |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
SkuFilter
Includes filters for skus
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getPath():stringGet the path of the filter.
public hasMarketId($marketId):Plenty\Modules\Pim\SearchService\Filter\SkuFilterReturn type: SkuFilter
Restricts the result to have a sku with the market referrer id.
Name |
Type |
Description |
|
public hasAccountId($accountId):Plenty\Modules\Pim\SearchService\Filter\SkuFilterReturn type: SkuFilter
Restricts the result to have a sku with the account id.
Name |
Type |
Description |
|
public hasStatus($status):Plenty\Modules\Pim\SearchService\Filter\SkuFilterReturn type: SkuFilter
Restricts the result to have a sku with the status.
Name |
Type |
Description |
|
public hasSku($sku):Plenty\Modules\Pim\SearchService\Filter\SkuFilterReturn type: SkuFilter
Restricts the result to have a specified sku.
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
StockFilter
Includes filters for stock
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public netStock($netStock, $operator = "eq"):Plenty\Modules\Pim\SearchService\Filter\StockFilterReturn type: StockFilter
Restricts the result to meet the specified net stock value depending on the operator
Name |
Type |
Description |
|
||
|
public physicalStock($physicalStock, $operator = "eq"):Plenty\Modules\Pim\SearchService\Filter\StockFilterReturn type: StockFilter
Restricts the result to meet the specified physical stock value depending on the operator
Name |
Type |
Description |
|
||
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
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\SupplierFilterReturn type: SupplierFilter
Name |
Type |
Description |
|
||
|
public hasSupplier($supplierId):Plenty\Modules\Pim\SearchService\Filter\SupplierFilterReturn type: SupplierFilter
Restricts the result to have the supplier id.
Name |
Type |
Description |
|
public hasAnySupplier($supplierIds):Plenty\Modules\Pim\SearchService\Filter\SupplierFilterReturn type: SupplierFilter
Restricts the result to have any of the tag ids.
Name |
Type |
Description |
|
public hasAllSuppliers($supplierIds):Plenty\Modules\Pim\SearchService\Filter\SupplierFilterReturn type: SupplierFilter
Restricts the result to have all of the tag ids.
Name |
Type |
Description |
|
public hasNotSupplierIds($supplierIds):Plenty\Modules\Pim\SearchService\Filter\SupplierFilterReturn type: SupplierFilter
Restricts the result to not match the specified IDs.
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
TagFilter
Includes filters for tags
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasTag($tagId):Plenty\Modules\Pim\SearchService\Filter\TagFilterReturn type: TagFilter
Restricts the result to have the tag id.
Name |
Type |
Description |
|
public hasAnyTag($tagIds):Plenty\Modules\Pim\SearchService\Filter\TagFilterReturn type: TagFilter
Restricts the result to have any of the tag ids.
Name |
Type |
Description |
|
Return type: TagFilter
Restricts the result to have all of the tag ids.
Name |
Type |
Description |
|
public hasNotTagIds($tagIds):Plenty\Modules\Pim\SearchService\Filter\TagFilterReturn type: TagFilter
Restricts the result to not match the specified IDs.
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
TextFilter
Includes filters for texts
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasAnyName():Plenty\Modules\Pim\SearchService\Filter\TextFilterReturn type: TextFilter
Restricts the result to have any name.
public hasNameInLanguage($lang = "de", $filter = self::FILTER_ANY_NAME):Plenty\Modules\Pim\SearchService\Filter\TextFilterReturn type: TextFilter
Restricts the result to have specific or any name in language: Possible filter are hasAnyNameInLanguage, hasName1InLanguage, hasName2InLanguage, hasName3InLanguage.
Name |
Type |
Description |
|
||
|
public matchAnyName($lang, $term, $precision = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SEARCH_TYPE_EXACT):Plenty\Modules\Pim\SearchService\Filter\TextFilterReturn type: TextFilter
Name |
Type |
Description |
|
||
|
||
|
public matchName1($lang, $term, $precision = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SEARCH_TYPE_EXACT):Plenty\Modules\Pim\SearchService\Filter\TextFilterReturn type: TextFilter
Name |
Type |
Description |
|
||
|
||
|
public matchName2($lang, $term, $precision = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SEARCH_TYPE_EXACT):Plenty\Modules\Pim\SearchService\Filter\TextFilterReturn type: TextFilter
Name |
Type |
Description |
|
||
|
||
|
public matchName3($lang, $term, $precision = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SEARCH_TYPE_EXACT):Plenty\Modules\Pim\SearchService\Filter\TextFilterReturn type: TextFilter
Name |
Type |
Description |
|
||
|
||
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
public static isLanguageSupported($lang):boolName |
Type |
Description |
|
public static isLanguageActivated($lang):boolName |
Type |
Description |
|
public static getM10lByLanguage($lang, $fallback = "en"):stringName |
Type |
Description |
|
||
|
public static getLanguageByM10l($lang, $fallback = "english"):stringName |
Type |
Description |
|
||
|
VariationAvailabilityUpdatedAtFilter
Used to filter by variation availability last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationBarcodeUpdatedAtFilter
Used to filter by variation barcode last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationBaseFilter
Includes filters for the base variation
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasNumber($number, $precision):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the number. Possible precisions are: exact, fuzzy and autocomplete
Name |
Type |
Description |
|
||
|
public hasModel($model, $precision):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the model. Possible precisions are: exact, fuzzy and autocomplete
Name |
Type |
Description |
|
||
|
public hasAnyNumber($numbers):voidRestricts the result to have any of the numbers.
Name |
Type |
Description |
|
public hasMainVariationId($mainVariationId):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the main variation id.
Name |
Type |
Description |
|
public hasMainVariationIds($mainVariationIds):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have any of the main variation ids.
Name |
Type |
Description |
|
public isActive():Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have active variations only.
public isInactive():Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have inactive variations only.
public hasId($id):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the variation id.
Name |
Type |
Description |
|
public hasIds($ids):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have any of the variation ids.
Name |
Type |
Description |
|
public hasItemId($itemId):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the item id.
Name |
Type |
Description |
|
public hasAnyPriceCalculationId():Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the any price calculation id
public hasPriceCalculationIds($ids):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the any of the price calculation ids
Name |
Type |
Description |
|
public hasPriceCalculationUuid($uuid):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the price calculation uuid
Name |
Type |
Description |
|
public hasAnyPriceCalculationUuid($uuids):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the any of the price calculation uuid
Name |
Type |
Description |
|
public hasItemIds($itemIds):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the any of the item ids
Name |
Type |
Description |
|
public isMain():Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have no child's
public isChild():Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have child's only
public isSalable($bool = true):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result whether is salable or not.
Name |
Type |
Description |
|
Return type: VariationBaseFilter
Restricts the result whether is hidden in category list or not.
Name |
Type |
Description |
|
public hasADescriptionInLanguage($language):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
This filter is not implemented. Deprecated.
Name |
Type |
Description |
|
public hasAnImageOrItemHasAnImage($bool = true):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have an image.
Name |
Type |
Description |
|
public hasLinkedImages():voidpublic hasAnImage($bool = true):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have an item image.
Name |
Type |
Description |
|
public hasVariationImage($bool = true):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have an item image.
Name |
Type |
Description |
|
public hasManufacturer($manufacturerId):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the manufacturer.
Name |
Type |
Description |
|
public hasSupplier($supplierId):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the supplier.
Name |
Type |
Description |
|
public hasAtLeastOneAvailability($availabilities):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have any of the availabilities.
Name |
Type |
Description |
|
public hasActiveChildren($bool = true):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have active child variations or not.
Name |
Type |
Description |
|
public hasChildren($bool = true):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have child variations or not.
Name |
Type |
Description |
|
public hasCustomsTariffNumber($customsTariffNumber):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have the customs tariff number.
Name |
Type |
Description |
|
public customsTariffNumberNotExists():Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have no customs tariff number.
public customsTariffNumberExists():Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to have a customs tariff number.
public hasNotReferrerIds($ids):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to not match the specified referrer IDs.
Name |
Type |
Description |
|
public hasNotIds($ids):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to not match the specified IDs.
Name |
Type |
Description |
|
public hasNotItemIds($itemIds):Plenty\Modules\Pim\SearchService\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Restricts the result to not match the specified item IDs.
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationBundleFilter
Includes filters for bundles
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public hasBundleType($bundleType):Plenty\Modules\Pim\SearchService\Filter\VariationBundleFilterReturn type: VariationBundleFilter
Restricts the result to have the bundle type.
Name |
Type |
Description |
|
public hasBundleTypes($bundleTypes):Plenty\Modules\Pim\SearchService\Filter\VariationBundleFilterReturn type: VariationBundleFilter
Restricts the result to have the any of the bundle types.
Name |
Type |
Description |
|
public hasNoBundleType():Plenty\Modules\Pim\SearchService\Filter\VariationBundleFilterReturn type: VariationBundleFilter
Restricts the result to have the no bundle type.
public isNotBundle():Plenty\Modules\Pim\SearchService\Filter\VariationBundleFilterReturn type: VariationBundleFilter
Restricts the result to have the no bundle type.
public hasBundleComponentVariationId($componentVariationId):Plenty\Modules\Pim\SearchService\Filter\VariationBundleFilterReturn type: VariationBundleFilter
Restricts the result to have the bundle component variation id.
Name |
Type |
Description |
|
public hasNotBundleType($bundleType):Plenty\Modules\Pim\SearchService\Filter\VariationBundleFilterReturn type: VariationBundleFilter
Restricts the result to not match the specified bundle type.
Name |
Type |
Description |
|
public toArray():arraypublic setMinimumShouldMatch($minimumShouldMatch):voidName |
Type |
Description |
|
public addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationCategoryUpdatedAtFilter
Used to filter by variation category last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationClientUpdatedAtFilter
Used to filter by variation client last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationCreatedAtFilter
Used to filter by variation created at timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationLastUpdatedAtFilter
Used to filter by variation last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationMarketUpdatedAtFilter
Used to filter by variation market last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationPropertyUpdatedAtFilter
Used to filter by variation property last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationRelatedLastUpdatedAtFilter
Used to filter by variation related last updated at timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationSalesPriceUpdatedAtFilter
Used to filter by variation saleyPrice last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationSkuUpdatedAtFilter
Used to filter by variation saleyPrice last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationStockNetFilter
Used to filter by variation stock net
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationStockPhysicalFilter
Used to filter by variation stock physical
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationStockUpdatedAtFilter
Used to filter by variation stock last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationSupplierUpdatedAtFilter
Used to filter by variation supplier last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationTagUpdatedAtFilter
Used to filter by variation tag last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationWarehouseUpdatedAtFilter
Used to filter by variation warehouse last update timestamp
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public getTimestamp():stringGet the timestamp of the filter
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
WarehouseFilter
Includes filters for warehouse
Namespace
Plenty\Modules\Pim\SearchService\Filter
Methods
public isInWarehouse($warehouseId):Plenty\Modules\Pim\SearchService\Filter\WarehouseFilterReturn type: WarehouseFilter
Restricts the result to have the warehouse ID.
Name |
Type |
Description |
|
public hasNotWarehouseIds($warehouseIds):Plenty\Modules\Pim\SearchService\Filter\WarehouseFilterReturn type: WarehouseFilter
Restricts the result to not match the specified IDs.
Name |
Type |
Description |
|
public hasWarehouseIds($warehouseIds):Plenty\Modules\Pim\SearchService\Filter\WarehouseFilterReturn type: WarehouseFilter
Restricts the result to have the any of the warehouse IDs.
Name |
Type |
Description |
|
public hasPhysicalStockInWarehouseIds($warehouseIds, $operator = "gt"):Plenty\Modules\Pim\SearchService\Filter\WarehouseFilterReturn type: WarehouseFilter
Name |
Type |
Description |
|
||
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
Query
ManagedSearchQuery
Used to search for variations by a specified term.
Namespace
Plenty\Modules\Pim\SearchService\Query
Methods
public setLang($lang):voidSets the language to search in.
Name |
Type |
Description |
|
public toArray():arrayReturns the search query as array.
public setOperator($operator):voidSet the operator for the terms in the search query. Possible values: or, and
Name |
Type |
Description |
|
public setFuzzy($fuzzy):voidSet whether this is a fuzzy search or not.
Name |
Type |
Description |
|
public addFilterField($field, $boost):voidAdd a filter field to search in.
Name |
Type |
Description |
|
||
|
public addMultilingualField($field, $language, $boost):voidAdd a multilingual field to search in.
Name |
Type |
Description |
|
||
|
||
|
public addOtherAnalyzedField($field, $boost):voidAdd a other analyzed field to search in.
Name |
Type |
Description |
|
||
|
public addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
public static isLanguageSupported($lang):boolName |
Type |
Description |
|
public static isLanguageActivated($lang):boolName |
Type |
Description |
|
public static getM10lByLanguage($lang, $fallback = "en"):stringName |
Type |
Description |
|
||
|
public static getLanguageByM10l($lang, $fallback = "english"):stringName |
Type |
Description |
|
||
|
SearchQuery
Used to search for variations by a specified term.
Namespace
Plenty\Modules\Pim\SearchService\Query
Methods
public setOperator($operator):voidSet the operator for the terms in the search query. Possible values: or, and
Name |
Type |
Description |
|
public setFuzzy($fuzzy):voidSet whether this is a fuzzy search or not.
Name |
Type |
Description |
|
public addFilterField($field, $boost):voidAdd a filter field to search in.
Name |
Type |
Description |
|
||
|
public addMultilingualField($field, $language, $boost):voidAdd a multilingual field to search in.
Name |
Type |
Description |
|
||
|
||
|
public addOtherAnalyzedField($field, $boost):voidAdd a other analyzed field to search in.
Name |
Type |
Description |
|
||
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
public static isLanguageSupported($lang):boolName |
Type |
Description |
|
public static isLanguageActivated($lang):boolName |
Type |
Description |
|
public static getM10lByLanguage($lang, $fallback = "en"):stringName |
Type |
Description |
|
||
|
public static getLanguageByM10l($lang, $fallback = "english"):stringName |
Type |
Description |
|
||
|
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():stringGet the name of the aggregation
public getAggregation():arrayGet the aggregation as array
public toArray():arrayReturns the aggregation as array
public process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidFeedback
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():stringGet the name of the aggregation
public getField():stringGet the field of the aggregation
public getRanges():arrayGet the ranges of the aggregation
public getAggregation():voidpublic toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidPrice
ItemMinPriceAggregation
Get min price by price id for found variations
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Price
Methods
public getName():stringGet the name of the aggregation
public getAggregation():arrayGet the aggregation as array
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidPriceRangeAggregation
Get price range for found variations
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Price
Methods
public getName():stringGet the name of the aggregation
public setPriceIds($ids):voidSet the price ids which should be aggregated
Name |
Type |
Description |
|
public process($data):arrayProcess the provided data
Name |
Type |
Description |
|
public getAggregation():arrayGet the aggregation as array
public toArray():arraypublic addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidProcessors
AttributeValueAggregationProcessor
Processor for AttributeValueAggregation
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Processors
Methods
public process($data):arrayProcesses the data provided by the aggregation
Name |
Type |
Description |
|
public getName():stringGet the name of the aggregation
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
CategoryAllTermsAggregationProcessor
Processor for CategoryAllTermsAggregation
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Processors
Methods
public process($data):arrayProcesses the data provided by the aggregation
Name |
Type |
Description |
|
public getName():stringGet the name of the aggregation
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
CategoryPathTermsAggregationProcessor
Processor for CategoryAllTermsAggregation
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Processors
Methods
public process($data):arrayProcesses the data provided by the aggregation
Name |
Type |
Description |
|
public getName():stringGet the name of the aggregation
public setFullPath($fullPath):Plenty\Modules\Pim\SearchService\Aggregations\Processors\CategoryPathTermsAggregationProcessorReturn type: CategoryPathTermsAggregationProcessor
Set if the full path should be used, or only the last element
Name |
Type |
Description |
|
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
FacetAggregationProcessor
Processor for MultiAggregation
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Processors
Methods
public process($data):arrayProcesses the data provided by the aggregation
Name |
Type |
Description |
|
public getName():stringGet the name of the aggregation
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
FeedbackRangeAggregationProcessor
Processor for FeedbackRangeAggregation
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Processors
Methods
public process($data):arrayProcesses the data provided by the aggregation
Name |
Type |
Description |
|
public getName():stringGet the name of the aggregation
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
ItemCardinalityAggregationProcessor
Processor for ItemCardinalityAggregation
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Processors
Methods
public process($data):arrayProcesses the data provided by the aggregation
Name |
Type |
Description |
|
public getDependencies():arrayGet dependencies of the aggregation
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
ItemIdTermsAggregationProcessor
Processor for ItemIdTermsAggregation
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Processors
Methods
public process($data):arrayProcesses the data provided by the aggregation
Name |
Type |
Description |
|
public getName():stringGet the name of the aggregation
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
ItemMinPriceAggregationProcessor
Processor for ItemMinPriceAggregation
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Processors
Methods
public process($data):arrayProcesses the data provided by the aggregation
Name |
Type |
Description |
|
public getName():stringGet the name of the aggregation
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
SalableFilterAggregationProcessor
Processor for SalableFilterAggregation
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Processors
Methods
public process($data):arrayProcesses the data provided by the aggregation
Name |
Type |
Description |
|
public getName():stringGet the name of the aggregation
public addSubProcessor($processor):voidAdd a sub processor to this processor
Name |
Type |
Description |
|
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
SearchSuggestionsTermsAggregationProcessor
Processor for SearchSuggestionsTermsAggregation
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Processors
Methods
public process($data):arrayProcesses the data provided by the aggregation
Name |
Type |
Description |
|
public getName():stringGet the name of the aggregation
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
UnitCombinationAggregationProcessor
Processor for UnitCombinationAggregation
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\Processors
Methods
public process($data):arrayProcesses the data provided by the aggregation
Name |
Type |
Description |
|
public getName():stringGet the name of the aggregation
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
SearchSuggestions
SearchSuggestionsTermsAggregation
Get suggestions for found variations, use setInclude to filter them.
Namespace
Plenty\Modules\Pim\SearchService\Aggregations\SearchSuggestions
Methods
public getName():stringGet the name of the aggregation
public getField():stringGet the field of the aggregation
public getAggregation():arraypublic setInclude($string):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidpublic static isLanguageSupported($lang):boolName |
Type |
Description |
|
public static isLanguageActivated($lang):boolName |
Type |
Description |
|
public static getM10lByLanguage($lang, $fallback = "en"):stringName |
Type |
Description |
|
||
|
public static getLanguageByM10l($lang, $fallback = "english"):stringName |
Type |
Description |
|
||
|
VariationDataInterface
Contracts
AttributeInterface
The interface of all variation attributes
Namespace
Plenty\Modules\Pim\VariationDataInterface\Contracts
Methods
public getName():stringGet the name of the attribute
public static getVariationAttribute():stringGet the related key on the variation model.
public addLazyLoadParts($lazyLoadParts):Plenty\Modules\Pim\VariationDataInterface\Contracts\AttributeInterfaceReturn type: AttributeInterface
Get all parts which should be lazy loaded.
Name |
Type |
Description |
|
public getLazyLoadParts():arrayGet all parts which should be lazy loaded.
public addFilters($filters):Plenty\Modules\Pim\VariationDataInterface\Contracts\Plenty\Modules\Pim\VariationDataInterface\Contracts\AttributeInterfaceReturn type: AttributeInterface
Add filters to the attribute.
Name |
Type |
Description |
|
public getFilters():arrayGet all filters applied to the attribute.
VariationDataInterfaceContract
Use this interface to load performant article data
Namespace
Plenty\Modules\Pim\VariationDataInterface\Contracts
Methods
public getResult($context):Plenty\Modules\Pim\VariationDataInterface\Contracts\VariationDataInterfaceResultInterfaceReturn type: VariationDataInterfaceResultInterface
Get the result, using the context.
Name |
Type |
Description |
|
public getMultipleResults($contextList):arrayGet the multiple results, using multiple contexts
Name |
Type |
Description |
|
public createOrUpdate($entities):Plenty\Modules\Pim\VariationDataInterface\Operations\CreateOrUpdateOperationReturn type: CreateOrUpdateOperation
Get an operation to create or update data.
Name |
Type |
Description |
|
public replace($entities):Plenty\Modules\Pim\VariationDataInterface\Operations\ReplaceOperationReturn type: ReplaceOperation
Get an operation to replace data.
Name |
Type |
Description |
|
public delete($entities):Plenty\Modules\Pim\VariationDataInterface\Operations\DeleteOperationReturn type: DeleteOperation
Get a operation to delete data.
Name |
Type |
Description |
|
VariationDataInterfaceResultInterface
The Result of the variation data interface
Namespace
Plenty\Modules\Pim\VariationDataInterface\Contracts
Methods
public getContext():Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Get the context which is uses for this result .
public total():intGet the total found variations.
public get():voidGet all found variations as Traversable.
public getAdditionalData():arrayGet 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
| Name | Type | Description |
|---|---|---|
id |
The id of the variation. |
|
additionalSkus |
The additional skus of the variation. |
|
attributeValues |
The attribute values of the variation. |
|
base |
The base data of the variation. |
|
barcodes |
The barcodes of the variation. |
|
bundleComponents |
The bundle components of the variation. |
|
categories |
The categories of the variation. |
|
clients |
The clients of the variation. |
|
defaultCategories |
The default categories of the variation. |
|
images |
The images of the variation. |
|
markets |
The markets of the variation. |
|
marketIdentNumbers |
The market ident numbers of the variation. |
|
salesPrices |
The sales prices of the variation. |
|
skus |
The skus of the variation. |
|
supplier |
The supplier of the variation. |
|
timestamps |
The timestamps of the variation. |
|
warehouses |
The warehouses of the variation. |
|
unit |
The unit of the variation. |
|
tags |
The tags of the variation. |
|
comments |
The comments of the variation. |
|
properties |
The properties of the variation. |
|
inheritance |
The inheritance of the variation. |
|
elasticSearchSource |
Methods
public toArray()Returns this model as an array.
VariationDataInterfaceContext
The Conext to define what you get frome the VDI
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model
Methods
public addFilter($filter):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Add filter to restrict the result.
Name |
Type |
Description |
|
public setFilter($filter):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Name |
Type |
Description |
|
public addAggregation($aggregation):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Add aggregation to aggregate the result.
Name |
Type |
Description |
|
public addSuggestion($suggestion):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Add suggestion to get suggestions in the result.
Name |
Type |
Description |
|
public addQuery($filter):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Add query to restrict the result. Queries affecting the score.
Name |
Type |
Description |
|
public getFilter():Illuminate\Support\CollectionReturn type: Collection
Get filters which are added to the context.
public getIds():voidGet ids which are added to the context.
public setIds($ids):voidSet ids. All other restrictions are ignored.
Name |
Type |
Description |
|
public getAggregations():voidGet aggregations which are added to the result.
public getSuggestions():voidGet suggestions which are added to the result.
public getQuery():voidGet queries which are added to the result.
public getParts():voidGet parts which are added to the result.
public addPart($part):voidAdd part to the result. A part specifies what is returned in the result.
Name |
Type |
Description |
|
public setParts($parts):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Set parts. A part specifies what is returned in the result.
Name |
Type |
Description |
|
public getPlentyIds():voidGet plenty ids. No further functionality added yet
public setPlentyIds($plentyIds):voidSet plenty ids. No further functionality added yet
Name |
Type |
Description |
|
public getLanguages():voidGet languages. No further functionality added yet
public setLanguages($languages):voidSet languages. No further functionality added yet
Name |
Type |
Description |
|
public getPage():intGet the wanted page value.
public setPage($page = 1, $perPage = 50):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Set the page and Items per page.
Name |
Type |
Description |
|
||
|
public getPerPage():intGet the wanted per page value.
public isGetAllFound():boolreturns whether get all found or not
public getLimit():voidpublic setGetAllFound($getAll, $limit = null):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
set whether the result should return all found entities without pagination or not
Name |
Type |
Description |
|
||
|
public getBatchSize():intGet the wanted batch size.
public setBatchSize($batchSize):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Set the batch size of result batch.
Name |
Type |
Description |
|
public getContextId():stringGet the current context id.
public getGroupBy():Plenty\Modules\Pim\VariationDataInterface\Model\Context\GroupByReturn type: GroupBy
Get the wanted group by or null if non is set.
public setGroupBy($groupBy):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Set a group by for the result.
Name |
Type |
Description |
|
public getDecoratedReturnType():stringGet the decorated return type.
public getSorting():Plenty\Modules\Cloud\ElasticSearch\Lib\Sorting\SortingInterfaceReturn type: SortingInterface
Get the sorting the result should be sorted by.
public setSorting($sorting):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
SeSett the sorting the result should be sorted by.
Name |
Type |
Description |
|
public getScoreModifier():Plenty\Modules\Cloud\ElasticSearch\Lib\Query\Type\ScoreModifier\ScoreModifierInterfaceReturn type: ScoreModifierInterface
Get a score modifier. Score modifier are manipulation the score of the result hits.
public setScoreModifier($scoreModifier):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Set a score modifier. Score modifier are manipulation the score of the result hits.
Name |
Type |
Description |
|
public getAdditionalSource():Plenty\Modules\Cloud\ElasticSearch\Lib\Source\IndependentSourceReturn type: IndependentSource
Get the additional source which should be added to the result.
public setAdditionalSource($additionalSource):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Set the additional source which should be added to the result.
Name |
Type |
Description |
|
public hasAdditionalSource():boolReturns whether the context has an additional source or not
public getUseInMemoryCache():boolReturns whether the in memory cache should be used or not
public setUseInMemoryCache($useInMemoryCache):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Set whether the in memory cache should be used or not. It is recommended to use this cache (Default)
Name |
Type |
Description |
|
public getUseSearchCache():boolReturn whether the search cache should be used or not
public setUseSearchCache($useSearchCache):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Set whether the search cache should be used or not. It is recommended to use this cache (Default)
Name |
Type |
Description |
|
public isHasAdditionalSource():boolReturns whether the context has an additional source or not
public setHasAdditionalSource($hasAdditionalSource):voidSet whether the context has an additional source or not. This is normally determined automatically
Name |
Type |
Description |
|
public isTrackTotalHits():boolReturns whether the total hits should be tracked or not
public setTrackTotalHits($trackTotalHits):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Set whether the total hits should be tracked or not
Name |
Type |
Description |
|
public getSearchAfterKey():stringGet the search after key.
public setSearchAfterKey($searchAfterKey):Plenty\Modules\Pim\VariationDataInterface\Model\VariationDataInterfaceContextReturn type: VariationDataInterfaceContext
Set the search after key. Set null for the first page.
Name |
Type |
Description |
|
public isSearchAfter():boolReturns 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 setDirectRefresh($directRefresh):Plenty\Modules\Pim\VariationDataInterface\Operations\BaseOperationReturn type: BaseOperation
Updated variations will be direct refreshed in the elasticsearch index. !!! ONLY USE IN AGREEMENT WITH PIM TEAM !!!
Name |
Type |
Description |
|
public add($variations):Plenty\Modules\Pim\VariationDataInterface\Operations\BaseOperationReturn type: BaseOperation
Name |
Type |
Description |
|
public save():Plenty\Modules\Pim\DocumentService\Models\WriteResponseReturn type: WriteResponse
DeleteOperation
The delete operation for the vdi.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Operations
Methods
public setDirectRefresh($directRefresh):Plenty\Modules\Pim\VariationDataInterface\Operations\BaseOperationReturn type: BaseOperation
Updated variations will be direct refreshed in the elasticsearch index. !!! ONLY USE IN AGREEMENT WITH PIM TEAM !!!
Name |
Type |
Description |
|
public add($variations):Plenty\Modules\Pim\VariationDataInterface\Operations\BaseOperationReturn type: BaseOperation
Name |
Type |
Description |
|
public save():Plenty\Modules\Pim\DocumentService\Models\WriteResponseReturn type: WriteResponse
ReplaceOperation
The replace operation for the vdi.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Operations
Methods
public setDirectRefresh($directRefresh):Plenty\Modules\Pim\VariationDataInterface\Operations\BaseOperationReturn type: BaseOperation
Updated variations will be direct refreshed in the elasticsearch index. !!! ONLY USE IN AGREEMENT WITH PIM TEAM !!!
Name |
Type |
Description |
|
public add($variations):Plenty\Modules\Pim\VariationDataInterface\Operations\BaseOperationReturn type: BaseOperation
Name |
Type |
Description |
|
public save():Plenty\Modules\Pim\DocumentService\Models\WriteResponseReturn type: WriteResponse
Model
Attributes
VariationAdditionalSkuAttribute
The additional sku part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationAttributeValueAttribute
The attribute part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationBarcodeAttribute
The barcode part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationBaseAttribute
The base part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationBundleComponentAttribute
The bundle component part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationBundleComponentNamesAttribute
The bundle component part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationCategoryAttribute
The category part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationClientAttribute
The client part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationCommentAttribute
The comment part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationDefaultCategoryAttribute
The default category part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationImageAttribute
The image part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationInheritanceAttribute
The market part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationMarketAttribute
The market part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationMarketIdentNumberAttribute
The market ident number part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationPropertyAttribute
The property part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationSalesPriceAttribute
The sales price part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationSkuAttribute
The sku part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationSupplierAttribute
The supplier part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationTagAttribute
The tag part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationTimestampAttribute
The timestamp part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationUnitAttribute
The unit part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidVariationWarehouseAttribute
The warehouse part of the variation
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\Attributes
Methods
public static getVariationAttribute():stringGet the related key on the variation model.
public getName():stringpublic addLazyLoadParts($lazyLoadParts):voidName |
Type |
Description |
|
public getLazyLoadParts():voidpublic addFilters($filters):voidName |
Type |
Description |
|
public getFilters():voidContext
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():stringGet the field the result should be grouped by.
DecoratedAttributes
AdditionalSku
Contains information about an additonal sku, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation. |
|
id |
The unique ID of the additional sku |
|
marketId |
The ID of the market |
|
marketAccountId |
The ID of the market account |
|
sku |
The additional sku for this variation. |
|
updatedAt |
The time the linked additional sku was last updated |
Methods
public toArray()Returns this model as an array.
AttributeValue
Contains information about an attribute value, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
with |
||
variationId |
The unique ID of the variation. |
|
attributeId |
The unique ID of the attribute |
|
attributeValueSetId |
The unique ID of the attribute |
|
valueId |
The unique ID of the attribute value |
Methods
public toArray()Returns this model as an array.
Barcode
Contains information about a barcode, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
with |
||
code |
The code of the variation’s barcode. The combination of code and barcode ID must be unique. |
|
barcodeId |
The unique ID of the barcode linked to the variation. The combination of code and barcode ID must be unique. |
|
variationId |
The unique ID of the variation. |
|
createdAt |
The creation date of the barcode. |
Methods
public toArray()Returns this model as an array.
Base
Contains the basic information of a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
with |
||
variationId |
The unique ID of the variation. |
|
isMain |
||
mainVariationId |
||
itemId |
||
position |
||
isActive |
||
number |
||
model |
||
externalId |
||
availability |
||
availabilityId |
||
estimatedAvailableAt |
||
purchasePrice |
||
movingAveragePrice |
||
priceCalculationId |
||
priceCalculationUUID |
||
picking |
||
stockLimitation |
||
isVisibleIfNetStockIsPositive |
||
isInvisibleIfNetStockIsNotPositive |
||
isAvailableIfNetStockIsPositive |
||
isUnavailableIfNetStockIsNotPositive |
||
isVisibleInListIfNetStockIsPositive |
||
isInvisibleInListIfNetStockIsNotPositive |
||
mainWarehouseId |
||
maximumOrderQuantity |
||
minimumOrderQuantity |
||
intervalOrderQuantity |
||
availableUntil |
||
releasedAt |
||
name |
||
weightG |
||
weightNetG |
||
widthMM |
||
lengthMM |
||
heightMM |
||
extraShippingCharge1 |
||
extraShippingCharge2 |
||
unitsContained |
||
palletTypeId |
||
packingUnits |
||
packingUnitsTypeId |
||
transportationCosts |
||
storageCosts |
||
customs |
||
operatingCosts |
||
vatId |
||
bundleType |
||
automaticClientVisibility |
||
automaticListVisibility |
||
isHiddenInCategoryList |
||
defaultShippingCosts |
||
mayShowUnitPrice |
||
parentVariationId |
||
parentVariationQuantity |
||
singleItemCount |
||
hasCalculatedBundleWeight |
||
hasCalculatedBundleNetWeight |
||
hasCalculatedBundlePurchasePrice |
||
hasCalculatedBundleMovingAveragePrice |
||
customsTariffNumber |
||
campaignId |
||
createdAt |
||
updatedAt |
||
relatedUpdatedAt |
||
availabilityUpdatedAt |
||
categoriesInherited |
||
referrerInherited |
||
clientsInherited |
||
salesPricesInherited |
||
supplierInherited |
||
warehousesInherited |
||
propertiesInherited |
||
tagsInherited |
||
itemType |
Methods
public toArray()Returns this model as an array.
BundleComponent
Contains information about a barcode, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation. |
|
id |
The unique ID of the variation bundle component |
|
componentVariationId |
The unique ID of the variation added as bundle component |
|
componentQuantity |
The quantity of the variation to be added as bundle component |
|
createdAt |
The time the linked bundle component was created |
|
updatedAt |
The time the linked bundle component was last updated |
Methods
public toArray()Returns this model as an array.
Category
Contains information about a category, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
with |
||
variationId |
The unique ID of the variation. |
|
categoryId |
The unique ID of the category |
|
position |
The position of the category |
|
isNeckermannPrimary |
Flag that indicates if the category is the primary category for the market Neckermann for this variation. |
|
createdAt |
The time the linked category was created |
|
updatedAt |
The time the linked category was last updated |
Methods
public toArray()Returns this model as an array.
Client
Contains information about a client, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation. |
|
plentyId |
The unique ID of the client (store) |
|
createdAt |
The time the linked price was created |
Methods
public toArray()Returns this model as an array.
Comment
Contains information about a comment, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
id |
||
userId |
The unique ID of the user |
|
text |
||
isVisibleForContact |
||
createdAt |
||
variationId |
The unique ID of the variation. |
Methods
public toArray()Returns this model as an array.
DefaultCategory
Contains information about a default category, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
with |
||
variationId |
The unique ID of the variation. |
|
branchId |
The unique ID of the category branch |
|
plentyId |
The unique plenty ID of the client (store) |
|
manually |
Methods
public toArray()Returns this model as an array.
Image
Contains information about an image, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
with |
||
variationId |
The unique ID of the variation. |
|
imageId |
The unique ID of the image. |
Methods
public toArray()Returns this model as an array.
Inheritance
Contains the inheritance information of a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation. |
|
categories |
||
referrer |
||
clients |
||
salesPrices |
||
supplier |
||
warehouses |
||
properties |
||
tags |
||
customs |
||
estimatedAvailableAt |
||
externalId |
||
position |
||
extraShippingCharge1 |
||
extraShippingCharge2 |
||
intervalOrderQuantity |
||
maximumOrderQuantity |
||
minimumOrderQuantity |
||
model |
||
packingUnits |
||
picking |
||
purchasePrice |
||
storageCosts |
||
transportationCosts |
||
unitCombinationId |
||
unitsContained |
||
vatId |
||
weightG |
||
weightNetG |
||
availability |
||
stockLimitation |
||
isVisibleIfNetStockIsPositive |
||
isInvisibleIfNetStockIsNotPositive |
||
isAvailableIfNetStockIsPositive |
||
isUnavailableIfNetStockIsNotPositive |
||
isVisibleInListIfNetStockIsPositive |
||
isInvisibleInListIfNetStockIsNotPositive |
||
mainWarehouseId |
||
releasedAt |
||
name |
||
widthMM |
||
lengthMM |
||
heightMM |
||
palletTypeId |
||
packingUnitTypeId |
||
operatingCosts |
||
isHiddenInCategoryList |
||
availableUntil |
||
mayShowUnitPrice |
||
customsTariffNumber |
Methods
public toArray()Returns this model as an array.
Market
Contains information about an market, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation. |
|
marketId |
The unique ID of the market. |
|
createdAt |
The creation date of the market. |
Methods
public toArray()Returns this model as an array.
MarketIdentNumber
Contains informations about a market ident number, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation. |
|
id |
The unique id of the market ident number (ASIN/ePID/MOIN) |
|
countryId |
The country code of the market ident number (ASIN/ePID/MOIN) |
|
type |
The type of market ident number (ASIN/ePID/MOIN) |
|
position |
The position of the market ident number (ASIN/ePID/MOIN) |
|
value |
The value of the market ident number (ASIN/ePID/MOIN) |
Methods
public toArray()Returns this model as an array.
Property
Contains information about a property, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
with |
||
variationId |
The unique ID of the variation. |
|
id |
The unique ID of the property relation |
|
propertyId |
The unique ID of the property |
|
groupId |
The unique ID of the property group of the property |
|
markup |
The markup of the property relation |
|
value |
The value of the property relation |
|
rawValue |
The raw value of the property relation (read only) |
|
values |
The values of this relation |
|
selectionValues |
The selection values of this relation |
|
createdAt |
The creation date of the property relation |
|
updatedAt |
The last update date of the property relation |
Methods
public toArray()Returns this model as an array.
SalesPrice
Contains information about a sales price, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
with |
||
variationId |
The unique ID of the variation. |
|
salesPriceId |
The unique ID of the sales price |
|
price |
The price of the variation saved for this sales price |
|
lowestPrice |
The lowest price of the variation saved for this sales price |
|
lowestPriceCalculation |
Is the lowest price calculation active for this sales price |
|
updatedAt |
The time the linked price was last updated |
|
createdAt |
The time the linked price was created |
Methods
public toArray()Returns this model as an array.
Sku
Contains information about a sku, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation. |
|
id |
The ID of the sku |
|
marketId |
The ID of the market |
|
accountId |
The ID of the market account |
|
initialSku |
The initial SKU of the variation. The initial SKU cannot be modified even if the variation SKU is changed. However, it is possible to reset the variation SKU to the initial SKU. |
|
sku |
The SKU of the variation. The SKU is adjustable but may not exist twice for the combination of market Id and account Id. |
|
parentSku |
The Parent SKU of the variation. The Parent SKU is adjustable. The same Parent SKU value should be used on variations of same article. |
|
isActive |
Flag that indicates if the item is ready for export (currently not in use). |
|
exportedAt |
The time the variation was last exported (YYYY-MM-DD HH:MM:SS). |
|
stockUpdatedAt |
||
deletedAt |
The time the variation was deleted (YYYY-MM-DD HH:MM:SS). |
|
status |
The status of the variation after the export. Possible entries are INACTIVE, ERROR, SENT and ACTIVE. |
|
additionalInformation |
The field that contains additional information. |
|
updatedAt |
The time the linked sku was last updated |
|
createdAt |
The time the linked sku was created |
Methods
public toArray()Returns this model as an array.
Supplier
contains informations about a supplier, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
with |
||
variationId |
The unique ID of the variation. |
|
id |
The unique ID of the link between variation and supplier. |
|
supplierId |
The unique ID of the supplier. |
|
purchasePrice |
The price at which the variation was purchased from this supplier. |
|
minimumPurchase |
The minimum quantity of the variation that has to be ordered from the supplier. This value is also used as a quantity suggestion when creating reorders. |
|
itemNumber |
The external item number assigned to the variation by this supplier. |
|
lastPriceQuery |
The date of the last price query to this supplier. This helps to plan price negotiations. |
|
deliveryTimeInDays |
The delivery time in days for the variation saved for this supplier. |
|
discount |
The discount in percent the supplier grants for the variation. |
|
isDiscountable |
Flag that indicates if the supplier’s discount for this variation is active. |
|
packagingUnit |
The packaging unit of the supplier if it differs from the packaging unit settings in plentymarkets. |
|
currencyPurchasePrice |
The price at which the variation was purchased from this supplier in the currency of the supplier. |
|
itemDescription |
The supplier item description. |
|
updatedAt |
The time the supplier was last updated |
Methods
public toArray()Returns this model as an array.
Tag
Contains information about a tag, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
with |
||
variationId |
The unique ID of the variation. |
|
tagId |
The unique ID of the tag |
|
createdAt |
The time the tag was created |
|
updatedAt |
The time the tag was last updated |
Methods
public toArray()Returns this model as an array.
Timestamp
Contains informations the timestamps of a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
availability |
The time the availability of the variation was last modified. |
|
additionalSku |
The time any additional sku of the variation was last modified. |
|
barcode |
The time any barcode of the variation was last modified. |
|
base |
The time any field of the variation was last modified. |
|
bundleComponent |
The time any bundle component of the variation was last modified. |
|
category |
The time any category of the variation was last modified. |
|
client |
The time any client of the variation was last modified. |
|
defaultCategory |
The time any default category of the variation was last modified. |
|
image |
The time any image of the variation was last modified. |
|
market |
The time any market of the variation was last modified. |
|
marketIdentNumber |
The time any market ident number of the variation was last modified. |
|
related |
The time any relation of the variation was last modified. |
|
salesPrice |
The time any sales price of the variation was last modified. |
|
sku |
The time any sku of the variation was last modified. |
|
supplier |
The time any supplier of the variation was last modified. |
|
warehouse |
The time any warehouse of the variation was last modified. |
|
property |
The time any property of the variation was last modified. |
|
comment |
The time any comment of the variation was last added. |
|
tag |
The time any tag of the variation was last modified. |
|
createdAt |
The time any warehouse of the variation was last modified. |
Methods
public toArray()Returns this model as an array.
Unit
Contains information about the unit of the variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
with |
||
variationId |
The unique ID of the variation. |
|
unitId |
The unique ID of the unit |
|
content |
The content |
|
unitCombinationId |
The unit combinationId |
Methods
public toArray()Returns this model as an array.
Warehouse
Contains information about a warehouse, belongs to a variation.
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes
| Name | Type | Description |
|---|---|---|
with |
||
variationId |
The unique ID of the variation. |
|
warehouseId |
The unique ID of the warehouse |
|
warehouseZoneId |
The unique ID of the warehouse zone |
|
storageLocationType |
The storage location type of the warehouse |
|
reorderLevel |
The reorder level for the variation in this warehouse |
|
maximumStock |
The maximum stock for the variation in this warehouse |
|
stockTurnoverInDays |
The stock turnover in days for the variation in this warehouse |
|
storageLocation |
The storage location of the variation in this warehouse |
|
stockBuffer |
The stock buffer for the variation in this warehouse |
|
isBatch |
Is for warehouse and variation stock batch active |
|
isBestBeforeDate |
Is for warehouse and variation stock best before date active |
|
updatedAt |
The time the warehouse relation was last updated |
|
createdAt |
The time the warehouse relation was created |
Methods
public toArray()Returns this model as an array.
Decorators
AttributeValue
Barcode
Base
With
contains lazy loaded base data
Namespace
Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Base
| Name | Type | Description |
|---|---|---|
item |
||
characteristics |
||
crossSelling |
||
crossSellingFor |
||
texts |
||
feedback |
||
availability |
||
shippingProfiles |
||
images |
||
stock |
||
stockStorageLocations |
||
serialNumbers |
||
setConfig |
||
itemEbayTitle |
Methods
public toArray()Returns this model as an array.