ItemFilterBuilder

Namespace

IO\Builder\Item

Properties
Type	Name	Description
`array`	`$filter`

Methods

public build():array

Return the generated filters to pass to ItemDataLayerRepository::search

public hasProperty($propertyId):ItemFilterBuilder

Filter items by propertyId

**Parameters**
Type	Name	Description
`array`	`$propertyId`

public hasAmazonTypeProductGenre($productGenre):ItemFilterBuilder

Filter items by amazon product genre

**Parameters**
Type	Name	Description
`string`	`$productGenre`	The amazon genre

public hasAttribute($attributeIDs):ItemFilterBuilder

Deny items not having defined attributes

**Parameters**
Type	Name	Description
`array`	`$attributeIDs`	allowed attribute IDs

public notHasAttribute($attributeIDs):ItemFilterBuilder

Deny items having one of the defined attributes

**Parameters**
Type	Name	Description
`array`	`$attributeIDs`	The attribute IDs to Deny

public hasAgeRestriction($):ItemFilterBuilder

Filter items by age restriction

**Parameters**
Type	Name	Description
`array`	`$`	List of allowed age restrictions

public hasAmazonProductType($productTypes = []):ItemFilterBuilder

Filter items by amazon product type. Do not pass any type to filter items having any amazon product type.

**Parameters**
Type	Name	Description
`array`	`$productTypes`	The amazon product types to filter

public notHasAmazonProductType():ItemFilterBuilder

Deny items having any amazon product type

public hasBarcode():ItemFilterBuilder

Filter items having a barcode

public notHasBarcode():ItemFilterBuilder

Filter items having no barcode

public hasCrossItemId($itemIDs, $dynamic, $relationship):ItemFilterBuilder

Filter items by cross selling items

**Parameters**
Type	Name	Description
`array`	`$itemIDs`	The linked item IDs
`bool`	`$dynamic`	Filter dynamic entries → true
false or all entries → null	`array`	`$relationship`

public hasId($itemIDs):ItemFilterBuilder

Filter item by IDs

**Parameters**
Type	Name	Description
`array`	`$itemIDs`	The item IDs to filter

public hasImage():ItemFilterBuilder

Filter items having an image

public notHasImage():ItemFilterBuilder

Filter items not having any image

public hasMarkinOne($markingOneIDs):ItemFilterBuilder

Filter items by flag 1

**Parameters**
Type	Name	Description
`array`	`$markingOneIDs`	IDs of the markings to filter

public hasMarginTwo($markingTwoIDs):ItemFilterBuilder

Filter items by flag 2

**Parameters**
Type	Name	Description
`array`	`$markingTwoIDs`	IDs of the markings to filter

public hasProducer($producerIDs = []):ItemFilterBuilder

Filter items by manufacturers. Do not pass the manufacturer ID to filter items not having a manufacturer.

**Parameters**
Type	Name	Description
`array`	`$producerIDs`	The producers to filter

public notHasProducer():ItemFilterBuilder

Filter items not having a manufacturer

public isBundle():ItemFilterBuilder

Filter bundle items having components

public notIsBundle():ItemFilterBuilder

Deny bundle items

public isBundleItem():ItemFilterBuilder

Filter bundle components

public isColli():ItemFilterBuilder

Filter items with type 'ColliItem'

public isProductionItem():ItemFilterBuilder

Filter items with type 'ProductionItem'

public isSpecialOrderItem():ItemFilterBuilder

Filter items with type 'DeliveryItem'

public isStockedItem():ItemFilterBuilder

Filter items with type 'StockedItem'

public isType($typeIDs):ItemFilterBuilder

Filter items by type

**Parameters**
Type	Name	Description
`array`	`$typeIDs`	the type IDs

public isStoreSpecial($shopActions):ItemFilterBuilder

Filter items by store special

**Parameters**
Type	Name	Description
`array`	`$shopActions`	IDs of allowed shop actions

public mayBeShippedWithAmazonFBA():ItemFilterBuilder

Filter items which can be shipped via Amazon FBA

public notMayBeShippedWithAmazonFBA()

Filter items which cannot be shipped via Amazon FBA

public wasUpdatedBetween($from, $to):ItemFilterBuilder

Filter items by last changes on item data

**Parameters**
Type	Name	Description
`string`	`$from`	The start datetime of the period in unix format
`string`	`$to`	The end datetime of the period in unix format

public descriptionContains($search, $browse):ItemFilterBuilder

Filter itmes containing search string in description

**Parameters**
Type	Name	Description
`string`	`$search`	string to search in item description
`bool`	`$browse`	use extended search index

public hasDescription($lang):ItemFilterBuilder

Filter items having a description in a specific language

**Parameters**
Type	Name	Description
`Language`	`$lang`	the language to use

public notHasDescription($lang):ItemFilterBuilder

Filter items not having a description in a specific language

**Parameters**
Type	Name	Description
`Language`	`$lang`	the language to use

public hasListing($auctionType):ItemFilterBuilder

Filter items linked to a specific listing

**Parameters**
Type	Name	Description
`string`	`$auctionType`	Type of listing

public notHasListing($auctionType):ItemFilterBuilder

Filter items not linked to a listing

**Parameters**
Type	Name	Description
`string`	`$auctionType`	Tyoe of listing

public variationHasAttributes():ItemFilterBuilder

Filter variations with attributes

public variationNotHasAttributes():ItemFilterBuilder

Filter variations not having an attribute

public variationHasAttributeValue($attributes):ItemFilterBuilder

Filter variations linked to specific attribute values

**Parameters**
Type	Name	Description
`array`	`$attributes`	A Map of attributes: attributeID ⇒ attributeValue

public variationhasAttributeValueSets($attributeValueSetIDs):ItemFilterBuilder

Filter variations by attribute value sets

**Parameters**
Type	Name	Description
`array`	`$attributeValueSetIDs`	IDs of attribute value sets

public variationHasAvailability($availabilityIDs):ItemFilterBuilder

Filter variations by availability

**Parameters**
Type	Name	Description
`array`	`$availabilityIDs`	The availability IDs

public variationHasBarcode($barcode)

**Parameters**
Type	Name	Description
``	`$barcode`

public variationHasCustomNumber()

public variationHasExternalId($externalId):ItemFilterBuilder

Filter variations by external variation ID.

**Parameters**
Type	Name	Description
`string`	`$externalId`	The external ID to filter.

public variationHasId($variationIDs):ItemFilterBuilder

Filter variations by variation ID

**Parameters**
Type	Name	Description
`array`	`$variationIDs`	The variation IDs

public variationHasMainWarehouse($warehouseIDs):ItemFilterBuilder

Filter variations by default warehouse ID

**Parameters**
Type	Name	Description
`array`	`$warehouseIDs`	The warehouse IDs

public variationHasSKU($itemId, $priceId, $attributeValueSetId):ItemFilterBuilder

Filter variations by SKU

**Parameters**
Type	Name	Description
`string`	`$itemId`	The Item ID of the SKU
`string`	`$priceId`	The price ID of the SKU
`string`	`$attributeValueSetId`	The attribute value set id of the SKU

public variationHasStockLimitation($stockLimitation):ItemFilterBuilder

Filter variations by stock limitations

**Parameters**
Type	Name	Description
`array`	`$stockLimitation`	Allowed stock limitations: 0 → No stock limitation 1 → limit net stock 2 → allow oversold

public hasUnitCombinationId($unitCombinationId):ItemFilterBuilder

Filter variations by unit combination

**Parameters**
Type	Name	Description
`int`	`$unitCombinationId`	The unit combination id

public variationIsActive():ItemFilterBuilder

Filter active variations

public variationNotIsActive():ItemFilterBuilder

Filter inactive variations

public variationIsPrimary():ItemFilterBuilder

Exclude child variations

public variationIsChild():ItemFilterBuilder

Exclude the primary variation

public onlyBasicVariations():ItemFilterBuilder

If an item has variations with attributes, exclude variations without attributes.

public variationWasAvailableUntilBetween($from, $to):ItemFilterBuilder

Filter variation by date 'available until'

**Parameters**
Type	Name	Description
`string`	`$from`	The start datetime of the period in unix format
`string`	`$to`	The end datetime of the period in unix format

public variationWasCreatedBetween($from, $to):ItemFilterBuilder

Filter variation by creation date

**Parameters**
Type	Name	Description
`string`	`$from`	The start datetime of the period in unix format
`string`	`$to`	The end datetime of the period in unix format

public variationWasUpdatedBetween($from, $to):ItemFilterBuilder

Filter variation by date of last changes on variation information, e.g. availability

**Parameters**
Type	Name	Description
`string`	`$from`	The start datetime of the period in unix format
`string`	`$to`	The end datetime of the period in unix format

public variationWasRelatedUpdatedBetween($from, $to):ItemFilterBuilder

Filter variation by date of last changes on related data, e.g. category, bundle etc.

**Parameters**
Type	Name	Description
`string`	`$from`	The start datetime of the period in unix format
`string`	`$to`	The end datetime of the period in unix format

public variationWasReleasedBetween($from, $to):ItemFilterBuilder

Filter variations by release date

**Parameters**
Type	Name	Description
`string`	`$from`	The start datetime of the period in unix format
`string`	`$to`	The end datetime of the period in unix format

public variationHasWeight($weightG):ItemFilterBuilder

Filter variations by gross weight

**Parameters**
Type	Name	Description
`int`	`$weightG`	Weight in gramm

public variationHasWeighNet($weightG):ItemFilterBuilder

Filter variations by net weight

**Parameters**
Type	Name	Description
`int`	`$weightG`	Weight in gramm

public variationHasCategory($categoryID):ItemFilterBuilder

Filter variations linked to a specific category. Do not pass any category to filter variations linked to any categories.

**Parameters**
Type	Name	Description
`int`	`$categoryID`	The category ID

public variationNotHasCategory():ItemFilterBuilder

Filter variations not linked to a category

public variationHasCategoryBranch($lvl1, $, $, $, $, $):ItemFilterBuilder

Filter variations linked to a specific category level

**Parameters**
Type	Name	Description
`int`	`$lvl1`	Category ID at first layer
`int`	`$`	?lvl2 Category ID at second layer
`int`	`$`	?lvl3 Category ID at third layer
`int`	`$`	?lvl4 Category ID at 4th layer
`int`	`$`	?lvl5 Category ID at 5th layer
`int`	`$`	?lvl6 Category ID at 6th layer

public variationMarketHasAdditionalInformation($additionalInformation, $marketplaceId):ItemFilterBuilder

Filter variations by additional content for specific markets

**Parameters**
Type	Name	Description
`string`	`$additionalInformation`
`float`	`$marketplaceId`	Referred marketplace id

public variationMarketWasFirstExportedBetween($from, $to, $marketplaceId):ItemFilterBuilder

Filter variations by date of first export to specific markets

**Parameters**
Type	Name	Description
`string`	`$from`	The start datetime of the period in unix format
`string`	`$to`	The end datetime of the period in unix format
`float`	`$marketplaceId`	Referred marketplace id

public variationMarketWasLastExportedBetween($from, $to, $marketplaceId):ItemFilterBuilder

Filter variations by date of last export to specific markets

**Parameters**
Type	Name	Description
`string`	`$from`	The start datetime of the period in unix format
`string`	`$to`	The end datetime of the period in unix format
`float`	`$marketplaceId`	Referred marketplace idv

public variationHasShippingProfile($shippingProfileIDs):ItemFilterBuilder

Filter variations by specific shipping profiles

**Parameters**
Type	Name	Description
`array`	`$shippingProfileIDs`	List of shipping profile IDs to filter.

public variationNotHasShippingProfile($shippingProfileIDs):ItemFilterBuilder

Filter variations without specific shipping profiles

**Parameters**
Type	Name	Description
`array`	`$shippingProfileIDs`	List of shipping profile IDs to deny.

public variationStockHasWarehouse($warehouseIDs):ItemFilterBuilder

Filter variations by warehouse

**Parameters**
Type	Name	Description
`mixed`	`$warehouseIDs`	"primary", "virtual" or the warehouse id

public variationStockIsSalable():ItemFilterBuilder

Filter variations which are for sale because of stock

public variationStockHasNet($warehouseId, $stockConditionOperand, $stockConditionOperator):ItemFilterBuilder

Filter variations by net stock

**Parameters**
Type	Name	Description
`mixed`	`$warehouseId`	"primary, "virtual" or the warehouse id
`float`	`$stockConditionOperand`	stock value to filters
`string`	`$stockConditionOperator`	the operator to compare stock value

public variationStockHasNetNegative($warehouseId):ItemFilterBuilder

Filter variations with negative net stock

**Parameters**
Type	Name	Description
`mixed`	`$warehouseId`	"primary", "virtual" or warehouse id

public variationStockHasNetPositive($warehouseId):ItemFilterBuilder

Filter variations with positive net stock

**Parameters**
Type	Name	Description
`mixed`	`$warehouseId`	"primary", "virtual" or warehouse id

public variationStockHasNetEqualZero($warehouseId):ItemFilterBuilder

Filter variations with net stock value of 0

**Parameters**
Type	Name	Description
`mixed`	`$warehouseId`	"primary", "virtual" or warehouse id

public variationStockHasPhysical($warehouseId, $stockConditionOperand, $stockConditionOperator):ItemFilterBuilder

Filter variations with phyiscal stock

**Parameters**
Type	Name	Description
`mixed`	`$warehouseId`	"primary", "virtual" or warehouse id
`float`	`$stockConditionOperand`	stock value to filters
`string`	`$stockConditionOperator`	the operator to compare stock value

public variationStockHasPhysicalNegative($warehouseId):ItemFilterBuilder

Filter variations with negative physical stock

**Parameters**
Type	Name	Description
`mixed`	`$warehouseId`	"primary", "virtual" or warehouse id

public variationStockHasPhysicalPositive($warehouseId):ItemFilterBuilder

Filter variations with positive physical stock

**Parameters**
Type	Name	Description
`mixed`	`$warehouseId`	"primary", "virtual" or warehouse id

public variationStockHasPhysicalEqualZero($warehouseId):ItemFilterBuilder

Filter variations with physical stock value of 0

**Parameters**
Type	Name	Description
`mixed`	`$warehouseId`	"primary", "virtual" or warehouse id

public variationStockHasReorderLevel($warehouseId, $stockConditionOperand, $stockConditionOperator):ItemFilterBuilder

Filter variations by reorder level

**Parameters**
Type	Name	Description
`mixed`	`$warehouseId`	"primary", "virtual" or warehouse id
`float`	`$stockConditionOperand`	stock value to filters
`string`	`$stockConditionOperator`	the operator to compare stock value

public variationStockIsReorderLevelReached($warehouseId):ItemFilterBuilder

Filter variations fallen below reorder level

**Parameters**
Type	Name	Description
`mixed`	`$warehouseId`	"primary", "virtual" or warehouse id

public variationStockWasUpdatedBetween($from, $to):ItemFilterBuilder

Filter variations by date of last changes to stock

**Parameters**
Type	Name	Description
`string`	`$from`	The start datetime of the period in unix format
`string`	`$to`	The end datetime of the period in unix format

public variationHasSupplier($supplierIDs):ItemFilterBuilder

Filter variations by specific supplier

**Parameters**
Type	Name	Description
`array`	`$supplierIDs`	Supplier IDs to filter.

public variationNotHasSupplier($supplierIDs):ItemFilterBuilder

Filter variations not having a specific supplier

**Parameters**
Type	Name	Description
`array`	`$supplierIDs`	Supplier IDs to deny.

public variationHasSupplierNumber($supplierNumber):ItemFilterBuilder

Filter variations by supplier number

**Parameters**
Type	Name	Description
`int`	`$supplierNumber`	the supplier number

public variationIsVisibleForMarketplace($mandatoryAllMarketplace, $mandatoryOneMarketplace):ItemFilterBuilder

Filter items which are visible for specific markets

**Parameters**
Type	Name	Description
`array`	`$mandatoryAllMarketplace`	All listed marketplaces have to be linked with filtered item.
`array`	`$mandatoryOneMarketplace`	At least one marketplace have to be linked with filtered item.

public variationNotIsVisibleForMarketplace($mandatoryAllMarketplace, $mandatoryOneMarketplace):ItemFilterBuilder

Filter items which are not visible for specific markets

**Parameters**
Type	Name	Description
`array`	`$mandatoryAllMarketplace`	All listed marketplaces have to be linked with filtered item.
`array`	`$mandatoryOneMarketplace`	At least one marketplace have to be linked with filtered item.

public variationIsVisibleForPlentyId($mandatoryAllPlentyId, $mandatoryOnePlentyId):ItemFilterBuilder

Filter items which are visible for specific client (store)

**Parameters**
Type	Name	Description
`array`	`$mandatoryAllPlentyId`	All listed shops have to be linked with filtered item.
`array`	`$mandatoryOnePlentyId`	At least one shop has to be linked with filtered item.

public variationNotIsVisibleForPlentyId($mandatoryAllPlentyId, $mandatoryOnePlentyId):ItemFilterBuilder

Filter items which are not visible for specific client (store)

**Parameters**
Type	Name	Description
`array`	`$mandatoryAllPlentyId`	All listed shops have to be linked with filtered item.
`array`	`$mandatoryOnePlentyId`	At least one shop has to be linked with filtered item.

public variationHasRetailPrice()

ItemFilterBuilder

Namespace

Methods

Is this page helpful?

Is this page helpful?