Attribute

$data

public show(int $id, array $with = []):AttributeEbayCorrelation

Gets an ebay attribute correlation. The ID of the attribute correlation must be specified.

Parameters

int	$id	The ID of the ebay attribute correlation
array	$with

public update(int $id, array $data):AttributeEbayCorrelation

Updates an ebay attribute correlation. The ID of the attribute correlation must be specified.

Parameters

int	$id	The ID of the ebay attribute correlation
array	$data

public delete(int $id):DeleteResponse

Deletes an ebay attribute correlation. The ID of the attribute correlation must be specified.

Parameters

$id

The ID of the ebay attribute correlation

public get(int $id):AttributeEbayCorrelation

Gets an ebay attribute correlation. The ID of the attribute correlation must be specified.

Parameters

$id

The ID of the ebay attribute correlation

public search(int $perPage, int $page, array $filters):PaginatedResult

Lists ebay attribute correlations by filters.

Parameters

int	$perPage
int	$page
array	$filters

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

AttributeMapRepositoryContract

The contract for the attribute map repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods

public create(array $data):AttributeMap

Creates a new attribute map.

Parameters

$data

public find(int $attributeId, float $marketId):AttributeMap

Gets an attribute map. The ID of the attribute and the ID of the market must be specified.

Parameters

int	$attributeId
float	$marketId

public all(array $columns = [], int $perPage = 50, int $page = 1, array $filter = [], array $with = []):array

Lists all attribute maps.

Parameters

array	$columns
int	$perPage
int	$page
array	$filter
array	$with

public update(array $data, int $attributeId, float $marketId):AttributeMap

Updates an attribute map. The ID of the attribute and the ID of the market must be specified.

Parameters

array	$data
int	$attributeId
float	$marketId

public delete(int $attributeId, float $marketId):DeleteResponse

Deletes an attribute map. The ID of the attribute and the ID of the market must be specified.

Parameters

int	$attributeId
float	$marketId

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

AttributeNameRepositoryContract

The contract for the attribute name repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods

public create(array $data, int $attributeId):AttributeName

Creates an attribute name. The ID of the attribute must be specified.

Parameters

array	$data	The attribute name data as associative array
int	$attributeId	The ID of the attribute ID

public delete(int $attributeId, string $lang):DeleteResponse

Deletes an attribute name. The ID of the attribute and the language must be specified.

Parameters

int	$attributeId	The ID of the attribute
string	$lang	The lang of the attribute name

public update(array $data, int $attributeId, string $lang):AttributeName

Updates an attribute name. The ID of the attribute and the language must be specified.

Parameters

array	$data	The attribute name data as associative array
int	$attributeId	The ID of the attribute
string	$lang	The lang of the attribute name

public findOne(int $attributeId, string $lang):AttributeName

Gets an attribute name. The ID of the attribute and the language must be specified.

Parameters

int	$attributeId	The ID of the attribute
string	$lang	The lang of the attribute name

public findByAttributeId(int $attributeId):AttributeName

Lists attribute names. The ID of the attribute must be specified.

Parameters

$attributeId

The ID of the attribute

AttributeRepositoryContract

The contract for the attribute repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods

public create(array $data):Attribute

Creates new attribute

Parameters

$data

The attribute data as associative array

public show(int $id, array $with = []):Attribute

Gets an attribute. The ID of the attribute must be specified.

Parameters

int	$id	The ID of the attribute
array	$with	An array of the with params

public update(array $data, int $id):Attribute

Updates an attribute. The ID of the attribute must be specified.

Parameters

array	$data	The attribute data as associative array
int	$id	The ID of the attribute

public delete(int $id):DeleteResponse

Deletes an attribute. The ID of the attribute must be specified.

Parameters

$id

The ID of the attribute

public findById(int $id):Attribute

Gets an attribute. The ID of the attribute must be specified.

Parameters

$id

The ID of the attribute

public findByBackendName(string $backendName):Attribute

Gets an attribute. The backend name of the attribute must be specified.

Parameters

$backendName

public all(array $columns = [], int $perPage = 50, int $page = 1, array $filter = [], array $with = []):PaginatedResult

Lists all attributes.

Parameters

array	$columns	An array of the shown columns. All columns are returned by default.
int	$perPage	The attributes shown per page. Default value is 50.
int	$page	The shown page. Default value is 1.
array	$filter
array	$with

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

AttributeValueImageRepositoryContract

The contract for the attribute value image repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods

public getAttributeValueImage(int $itemId, int $imageId, int $valueId):AttributeValueImage

Get an attribute value image link

Parameters

int	$itemId	The unique ID of the item ID
int	$imageId	The unique ID of the image
int	$valueId	The unique ID of the attribute value

public create(array $data):AttributeValueImage

Create an attribute value image link

Parameters

$data

The attribute value image data as an associative array

public delete(int $itemId, int $imageId, int $valueId):DeleteResponse

Delete an attribute value image link

Parameters

int	$itemId	The ID of the item
int	$imageId	The ID of the image
int	$valueId	The ID of the attribute value

public update(array $data, int $itemId, int $imageId, int $valueId):AttributeValueImage

Updates an attribute value image link

Parameters

array	$data	The attribute value image data as an associative array
int	$itemId	The unique ID of the item
int	$imageId	The unique ID of the image
int	$valueId	The unique ID of the attribute value

public search():Collection

List attribute value image links

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

AttributeValueMapRepositoryContract

The contract for the attribute value map repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods

public create(array $data):AttributeValueMap

Creates a new attribute value map.

Parameters

$data

public find(int $attributeId, int $attributeValueId, float $marketId):AttributeValueMap

Gets an attribute value map. The ID of the attribute, the ID of the attribute value and the ID of the market must be specified.

Parameters

int	$attributeId
int	$attributeValueId
float	$marketId

public all(array $columns = [], int $perPage = 50, int $page = 1, array $filter = [], array $with = []):array

Lists all attribute value maps.

Parameters

array	$columns
int	$perPage
int	$page
array	$filter
array	$with

public update(array $data, int $attributeId, int $attributeValueId, float $marketId):AttributeValueMap

Updates an attribute value map. The ID of the attribute, the ID of the attribute value and the ID of the market must be specified.

Parameters

array	$data
int	$attributeId
int	$attributeValueId
float	$marketId

public delete(int $attributeId, int $attributeValueId, float $marketId):DeleteResponse

Deletes an attribute value map. The ID of the attribute, the ID of the attribute value and the ID of the market must be specified.

Parameters

int	$attributeId
int	$attributeValueId
float	$marketId

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

AttributeValueMarketNameRepositoryContract

The contract for the attribute value market name repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods

public create(array $data):AttributeValueMarketName

Creates an attribute value market name. The ID of the attribute value must be specified.

Parameters

$data

The attribute value market name data as associative array

public delete(int $valueId, string $lang, string $referenceType):DeleteResponse

Deletes an attribute value market name. The ID of the attribute value and the language must be specified.

Parameters

int	$valueId	The ID of the attribute value
string	$lang	The lang of the attribute value name
string	$referenceType	The referenceType of the attribute value name

public update(array $data, int $valueId, string $lang, string $referenceType):AttributeValueMarketName

Updates an attribute value market name. The ID of the attribute value and the language must be specified.

Parameters

array	$data	The attribute value market name data as associative array
int	$valueId	The ID of the attribute value
string	$lang	The lang of the attribute value market name
string	$referenceType	The referenceType of the attribute value name

public findOne(int $valueId, string $lang, string $referenceType):AttributeValueMarketName

Gets an attribute value market name. The ID of the attribute value and the language must be specified.

Parameters

int	$valueId	The ID of the attribute value
string	$lang	The lang of the attribute value name
string	$referenceType	The referenceType of the attribute value name

public findByAttributeId(int $valueId, string $lang):array

Lists attribute value market names. The ID of the attribute and the language must be specified.

Parameters

int	$valueId	The ID of the attribute
string	$lang	The lang of the attribute value name

public search(int $page, int $itemsPerPage):PaginatedResult

Search attribute value market names.

Parameters

int	$page
int	$itemsPerPage

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

AttributeValueNameRepositoryContract

The contract for the attribute value name repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods

public create(array $data, int $valueId):AttributeValueName

Creates an attribute value name. The ID of the attribute value must be specified.

Parameters

array	$data	The attribute value name data as associative array
int	$valueId	The ID of the attribute value

public delete(int $valueId, string $lang):DeleteResponse

Deletes an attribute value name. The ID of the attribute value and the language must be specified.

Parameters

int	$valueId	The ID of the attribute value
string	$lang	The lang of the attribute value name

public update(array $data, int $valueId, string $lang):AttributeValueName

Updates an attribute value name. The ID of the attribute value and the language must be specified.

Parameters

array	$data	The attribute value name data as associative array
int	$valueId	The ID of the attribute value
string	$lang	The lang of the attribute value name

public findOne(int $valueId, string $lang):AttributeValueName

Gets an attribute value name. The ID of the attribute value and the language must be specified.

Parameters

int	$valueId	The ID of the attribute value
string	$lang	The lang of the attribute value name

public findByValueId(int $valueId):AttributeValueName

Lists attribute value names. The ID of the attribute value must be specified.

Parameters

$valueId

The ID of the attribute value

AttributeValueRepositoryContract

The contract for the attribute value repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods

public create(array $data, int $attributeId):AttributeValue

Creates an attribute value. The ID of the attribute must be specified.

Parameters

array	$data	The attribute value data as associative array
int	$attributeId	The ID of the attribute

public update(array $data, int $attributeId, int $id):AttributeValue

Updates an attribute value. The ID of the attribute and the ID of the value must be specified.

Parameters

array	$data	The attribute value data as associative array
int	$attributeId	The ID of the attribute
int	$id	The ID of the value

public delete(int $attributeId, int $id):DeleteResponse

Deletes an attribute value. The ID of the attribute and the ID of the value must be specified.

Parameters

int	$attributeId	The ID of the attribute
int	$id	The ID of the value

public findByAttributeId(int $attributeId, int $page = 1, int $perPage = 50, array $columns = [], array $filter = [], array $with = []):array

Lists attribute values. The ID of the attribute must be specified.

Parameters

int	$attributeId	The ID of the attribute
int	$page	The shown page. Default value is 1.
int	$perPage	The amount of attribute values shown per page. Default value is 50
array	$columns	An array of the shown columns. All columns are returned by default.
array	$filter
array	$with

public findById(int $attributeId, int $id, array $with = []):AttributeValue

Gets a attribute value. The ID of the attribute and the ID of the value must be specified.

Parameters

int	$attributeId	The ID of the attribute
int	$id	The ID of the value
array	$with	An array of the with params

public findOne(int $valueId):AttributeValue

Gets a attribute value. The ID of the value must be specified.

Parameters

$valueId

public all(array $columns = [], int $perPage = 50):array

Lists all attribute values.

Parameters

array	$columns	An array of the shown columns. All columns are returned by default.
int	$perPage	The amount of attribute values shown per page. Default value is 50.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

AttributeValueSetRepositoryContract

The contract for the attribute value set repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods

public search(array $filters = []):Collection

List attribute value sets

Parameters

$filters

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Attribute

The Attribute model including AttributeName and AttributeValue

Namespace

Plenty\Modules\Item\Attribute\Models

Properties

Type	Name	Description
int	id	The unique ID of the attribute.
string	backendName	The back end name of the attribute. The name must be unique and must not contain commas, colons, semicolons or quotation marks. It is not visible in the plentymarkets front end.
int	position	The position of the attribute. Attributes are displayed in the attribute overview in ascending order by position.
bool	isSurchargePercental	Flag that indicates if the surcharge is percental.
bool	isLinkableToImage	Flag that indicates if an image can be linked to the attribute.
string	amazonAttribute	The attribute of the market Amazon that this attribute is liked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. Check documentation of the market for permitted values.
string	fruugoAttribute	The attribute of the market Fruugo that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market.
int	pixmaniaAttribute	The attribute of the market PIXmania that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. Check documentation of the market for permitted values.
string	ottoAttribute	The attribute of the market OTTO that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market.
string	googleShoppingAttribute	The attribute of the market Google Shopping that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market.
int	neckermannAtEpAttribute	The component of the market neckermann AT EP that this attribute is linked to. To list variations on this market, attributes must be linked to one of the components specified by the market. Check documentation of the market for permitted values.
string	typeOfSelectionInOnlineStore	How customers can select the attribute in the front end of a client. To allow attribute selection by check mark, attribute availability must be checked on the client side.
int	laRedouteAttribute	The attribute of the market La Redoute that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. Check documentation of the market for permitted values.
bool	isGroupable	Flag that indicates if the attribute can be grouped in item lists. If yes, variations with this attribute can be shown in the ItemViewCategoriesList template first. Other attributes are nested and can only be selected after this attribute has been selected.
array	attributeNames
array	values
array	maps

Methods

public toArray()

Returns this model as an array.

AttributeEbayCorrelation

The AttributeEbayCorrelation model

Namespace

Plenty\Modules\Item\Attribute\Models

Properties

Type	Name	Description
int	id	The unique ID of the ebay attribute correlation.
int	attributeId	The ID of the attribute.
int	ebaySiteId	The ID of the ebay site the attribute correlation is for.
int	ebayCategoryId	The ID of the ebay category of an ebay site the attribute correlation is for.
string	ebayAttributeName	The attribute of the market eBay that this attribute is linked to. Attributes can be linked to a ebay property or can have a separate correlation.
int	useForPictures	Flag that indicates if the ebay attribute correlation is used for pictures.

Methods

public toArray()

Returns this model as an array.

AttributeMap

The AttributeMap model

Namespace

Plenty\Modules\Item\Attribute\Models

Properties

Type	Name	Description
float	marketId	The unique ID of the market.
int	attributeId	The unique ID of the attribute.
string	name	The name of the attribute map. The name must be unique and must not contain commas, colons, semicolons or quotation marks. It is not visible in the plentymarkets front end.
string	marketInformation1	The information regarding the marketplace.
string	marketInformation2	The information regarding the marketplace.

Methods

public toArray()

Returns this model as an array.

AttributeName

The AttributeName model including Attribute

Namespace

Plenty\Modules\Item\Attribute\Models

Properties

Type	Name	Description
int	attributeId	The id of the attribute.
string	lang	The language of the attribute.
string	name	The name of the attribute. This attribute name is displayed in the online store.
Attribute	attribute

Methods

public toArray()

Returns this model as an array.

AttributeValue

The AttributeValue model including Attribute and AttributeValueName

Namespace

Plenty\Modules\Item\Attribute\Models

Properties

Type	Name	Description
int	id	The unique ID of the attribute value.
int	attributeId	The unique ID of the attribute associated with the attribute value.
string	backendName	The back end name of the attribute value. This name can only be assigned once per attribute. It is not visible in the plentymarkets front end.
int	position	The position of the attribute value. Attribute values are sorted in ascending order by position.
string	image	The name of the image associated with the attribute value; naming pattern is attr\_\{valueId\}.
string	comment	Optional comment on the attribute value. Comments are not visible in the plentymarkets front end.
string	amazonValue	The attribute value of the market Amazon that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the values specified by the market. Check documentation of the market for permitted values.
string	ottoValue	The attribute value of the market OTTO that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the attribute values specified by the market.
string	neckermannAtEpValue	The attribute value of the market Neckermann AT EP that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the attribute values specified by the market. Check documentation of the market for permitted values.
string	laRedouteValue	The attribute value of the market La Redoute that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the attribute values specified by the market. Check documentation of the market for permitted values.
string	tracdelightValue
int	percentageDistribution	The percentage for automatic stock distribution of attribute values. When reordering an item, the quantities of attribute values is automatically distributed among the total quantity.
Attribute	attribute
array	valueNames
array	valueMarketNames
array	valueMaps

Methods

public toArray()

Returns this model as an array.

AttributeValueImage

The AttributeValueImage model

Namespace

Plenty\Modules\Item\Attribute\Models

Properties

Type	Name	Description
int	imageId	The unique ID of the image
int	itemId	The unique ID of the item
int	attributeId	The unique ID of the attribute
int	valueId	The unique ID of the attribute value

Methods

public toArray()

Returns this model as an array.

AttributeValueMap

The AttributeValueMap model

Namespace

Plenty\Modules\Item\Attribute\Models

Properties

Type	Name	Description
float	marketId	The unique ID of the market.
int	attributeId	The unique ID of the attribute.
int	attributeValueId	The unique ID of the attribute value.
string	name	The name of the attribute value map. The name must be unique and must not contain commas, colons, semicolons or quotation marks. It is not visible in the plentymarkets front end.
string	marketInformation1	The information regarding the marketplace.
string	marketInformation2	The information regarding the marketplace.

Methods

public toArray()

Returns this model as an array.

AttributeValueMarketName

The AttributeValueMarketName model including AttributeValue

Namespace

Plenty\Modules\Item\Attribute\Models

Properties

Type	Name	Description
int	valueId	The unique ID of the attribute value.
string	lang	The language of the attribute value market.
string	name	The name of the attribute value market.
string	name2	The name2 of the attribute value market.
int	attributeId
string	referenceType
AttributeValue	attributeValue

Methods

public toArray()

Returns this model as an array.

AttributeValueName

The AttributeValueName model including AttributeValue

Namespace

Plenty\Modules\Item\Attribute\Models

Properties

Type	Name	Description
int	valueId	The unique ID of the attribute value.
string	lang	The language of the attribute value.
string	name	The name of the attribute value. This attribute value name is displayed in the online store.
AttributeValue	attributeValue

Methods

public toArray()

Returns this model as an array.

AttributeValueSet

The AttributeValueSet model

Namespace

Plenty\Modules\Item\Attribute\Models

Properties

Type	Name	Description
int	attributeValueSetId	The ID of the attribute value set
int	attributeId	The ID of the attribute
int	valueId	The ID of the attribute value
int	isLinkableToImage	Flag that indicates if an image can be linked to the attribute.
AttributeValue	attributeValue
Attribute	attribute

Methods

public toArray()

Returns this model as an array.

AttributeValueSetId

The AttributeValueSetId model

Namespace

Plenty\Modules\Item\Attribute\Models

Properties

Type	Name	Description
int	id	The ID of the attribute value set id
int	hash	a hash
string	amazon_variation_set
int	size

Methods

public toArray()

Returns this model as an array.

Availability

Contracts

AvailabilityRepositoryContract

Repository for item availability.

Namespace

Plenty\Modules\Item\Availability\Contracts

Methods

public findAvailability(int $id):Availability

Deprecated!

This method will not be supported in the future. Please refrain from using it as soon as possible.

Gets an item availability. The ID of the availability must be specified.

Parameters

$id

The ID of the item availability

public find(int $id):Availability

Gets an item availability. The ID of the availability must be specified.

Parameters

$id

The ID of the item availability

public update(array $data):Availability

Updates an item availability.

Parameters

$data

public all():array

Lists all item availabilities.

Models

Availability

The item availability model

Namespace

Plenty\Modules\Item\Availability\Models

Properties

Type	Name	Description
int	id	The ID of this availability
string	icon	The icon of this availability
int	averageDays	The average delivery time in days for this availability
array	names

Methods

public toArray()

Returns this model as an array.

AvailabilityName

The item availability name model

Namespace

Plenty\Modules\Item\Availability\Models

Properties

Type	Name	Description
int	availabilityId	The ID of the availability that the name belongs to
string	lang	The language code of the availability name
string	name	The name of the item availability in the specified language

Methods

public toArray()

Returns this model as an array.

Barcode

Contracts

BarcodeRepositoryContract

The contract for the barcode repository

Namespace

Plenty\Modules\Item\Barcode\Contracts

Methods

public showBarcode(int $barcodeId):Barcode

Gets a barcode. The ID of the barcode must be specified.

Parameters

$barcodeId

The ID of the barcode.

public createBarcode(array $data):Barcode

Creates a barcode.

Parameters

$data

The barcode data as associative array

public updateBarcode(array $data, int $barcodeId):Barcode

Updates a barcode. The ID of the barcode must be specified.

Parameters

array	$data	The barcode data as associative array
int	$barcodeId	The ID of the barcode.

public deleteBarcode(int $barcodeId):DeleteResponse

Deletes a barcode. The ID of the barcode must be specified.

Parameters

$barcodeId

The unique ID of the barcode

public findBarcodeById(int $barcodeId):Barcode

Gets a barcode. The ID of the barcode must be specified.

Parameters

$barcodeId

The unique ID of the barcode

public findBarcodesByType(string $barcodeType, int $perPage = 50):array

Lists barcodes. The type of the barcode must be specified.

Parameters

string	$barcodeType	The type of the barcode
int	$perPage	The number of barcodes shown per page. Default value is 50.

public allBarcodes(array $columns = [], int $perPage = 50, int $page = 1):PaginatedResult

Lists all barcodes.

Parameters

array	$columns	An array of the shown columns. All columns are returned by default.
int	$perPage	The number of barcodes shown per page. Default value is 50.
int	$page	The shown page. Default value is 1.

public createBarcodeReferrerRelation(array $data, int $barcodeId):BarcodeLinkReferrer

Creates new barcode referrer for specified referrer.

Parameters

array	$data	The barcode data as associative array
int	$barcodeId	The unique ID of the barcode

public deleteBarcodeReferrerRelation(float $referrer, int $barcodeId):DeleteResponse

Deletes barcode referrer with specified referrer.

Parameters

float	$referrer	The float value of the referrer
int	$barcodeId	The unique ID of the barcode

public findBarcodesByReferrerRelation(float $referrer, int $perPage = 50):array

Gets barcode referrer by specified referrer.

Parameters

float	$referrer	The float value of the referrer
int	$perPage	The number of barcodes shown per page. Default value is 50.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Barcode

The barcode model including barcode referrer

Namespace

Plenty\Modules\Item\Barcode\Models

Properties

Type	Name	Description
int	id	The unique ID of the barcode
string	name	The name of the barcode
string	type	The type of the barcode. Possible values: GTIN_8, GTIN_13, GTIN_14, GTIN_128, ISBN, QR, CODE_128, UPC
string	createdAt	The time the code was created.
array	referrers

Methods

public toArray()

Returns this model as an array.

BarcodeLinkReferrer

The barcode link referrer model including the barcode

Namespace

Plenty\Modules\Item\Barcode\Models

Properties

Type	Name	Description
int	barcodeId	The unique ID of the barcode
float	referrerId	The unique ID of the referrer. To activate all referrers, the value -1 must be specified. This value activates all referrers in the system by default, including any referrers added at a later stage.
string	createdAt	The time the barcode was created.
string	updatedAt	The time the barcode was last updated.
Barcode	barcode

Methods

public toArray()

Returns this model as an array.

DataLayer

Contracts

ItemDataLayerRepositoryContract

Deprecated! (since 2017-08-22)

Please use Plenty\Modules\Item\Variation\Contracts\VariationSearchRepositoryContract or Plenty\Modules\Item\Search\Contracts\VariationElasticSearchSearchRepositoryContract instead

Namespace

Plenty\Modules\Item\DataLayer\Contracts

Methods

public search(array $columns, array $filter = [], array $params = []):RecordList

Parameters

array	$columns
array	$filter
array	$params

public lookup(array $filter = [], array $params = [], bool $calculateNumberOfRows = false):ItemDataLayerResultLookup

Parameters

array	$filter
array	$params
bool	$calculateNumberOfRows

public searchWithPagination(array $columns, array $filter = [], array $params = []):PaginatedResult

Parameters

array	$columns
array	$filter
array	$params

Models

DataLayerModel

Namespace

Plenty\Modules\Item\DataLayer\Models

Methods

public toArray()

Returns this model as an array.

ItemBase

ItemDataLayer - ItemBase

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	abo
int	addCmsPage
int	amazonFba
int	amazonProductType
int	apiCondition
int	storeSpecial
float	bestofferAutoDeclinePrice
int	condition
int	crossSellingCharacter
string	customsTariffNumber
float	defaultShippingCost
int	directCrossArticle
int	ebayCategory
int	ebayCategory2
int	ebayPreset
int	ebayStoreCategory
int	ebayStoreCategory2
string	epid
string	fedas
int	markingOne
int	markingTwo
string	flashFile
int	flashHeight
int	flashWidth
string	free1
string	free2
string	free3
string	free4
string	free5
string	free6
int	free7
int	free8
int	free9
int	free10
int	free11
int	free12
int	free13
int	free14
int	free15
int	free16
int	free17
int	free18
int	free19
int	free20
int	ageRestriction
string	hasAttribute
int	id
int	inactive
string	createDate
int	isPacket
int	marketStockBuffer
int	noCoupon
int	producingCountryId
int	position
int	priceOnly4orderby
string	producer
int	producerId
int	rating
int	ratingCount
int	revenueAccount
int	scoActive
float	scoMinPrice
int	scoMinStockNet
int	serialNumber
string	shippingWithAmazonFba
int	sitemapPublished
string	storingPosition
string	lastUpdateTimestamp
int	type
int	votes
int	variationCount
int	tradoriaCategory

Methods

public toArray()

Returns this model as an array.

ItemCrossSelling

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	itemId
	crossItemId
	relationship
	dynamic

Methods

public toArray()

Returns this model as an array.

ItemDescription

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	itemId
string	characterCache
string	characterCacheXml
int	characterUpdate
string	description
int	id
string	keywords
string	lang
string	metaDescription
string	name1
string	name2
string	name3
string	shortDescription
string	technicalData
string	urlContent

Methods

public toArray()

Returns this model as an array.

ItemProperty

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	itemPropertyId
int	propertyId
	propertyValue
string	propertyValueType
bool	isOrderProperty
float	propertyOrderMarkup

Methods

public toArray()

Returns this model as an array.

ItemSetConfig

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	id
float	rebate

Methods

public toArray()

Returns this model as an array.

ItemShippingProfiles

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	id
string	name
string	backendName
array	tags

Methods

public toArray()

Returns this model as an array.

Record

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
ItemBase	itemBase
array	itemPropertyList
array	itemCrossSellingList
ItemDescription	itemDescription
array	itemShippingProfilesList
array	variationAttributeValueList
VariationBarcode	variationBarcode
array	variationBarcodeList
VariationBase	variationBase
array	variationBundleComponentList
array	variationCategoryList
array	variationImageList
array	variationLinkMarketplace
array	variationLinkWebstore
VariationMarketStatus	variationMarketStatus
VariationRetailPrice	variationRecommendedRetailPrice
array	variationRecommendedRetailPriceList
VariationRetailPrice	variationRetailPrice
array	variationRetailPriceList
VariationSetRetailPrice	variationSetRetailPrice
VariationStandardCategory	variationStandardCategory
VariationStock	variationStock
VariationStockBuffer	variationStockBuffer
array	variationStockList
array	variationSupplierList
VariationWarehouse	variationWarehouse
array	variationWarehouseList
VariationSpecialOfferRetailPrice	variationSpecialOfferRetailPrice
array	variationSpecialOfferRetailPriceList
ItemSetConfig	itemSetConfig

Methods

public toArray()

Returns this model as an array.

RecordList

Namespace

Plenty\Modules\Item\DataLayer\Models

Methods

public toArray()

Returns this model as an array.

VariationAttributeValue

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	attributeId
int	attributeValueId

Methods

public toArray()

Returns this model as an array.

VariationBarcode

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	code
string	createdTimestamp
int	barcodeId
string	barcodeType

Methods

public toArray()

Returns this model as an array.

VariationBase

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	active
int	attributeValueSetId
string	autoStockInvisible
string	bundleTyp
string	autoStockNoStockIcon
string	autoStockPositiveStockIcon
string	autoStockVisible
int	availability
string	averageOrderQuantity
string	content
int	unitCombinationId
string	createdTimestamp
string	customNumber
string	estimatedAvailability
string	externalId
float	extraShippingCharge1
float	extraShippingCharge2
int	heightMm
int	id
int	itemId
string	lastUpdateTimestamp
int	lengthMm
int	limitOrderByStockSelect
int	mainWarehouse
string	model
float	operatingCostsPercent
int	packingUnits
int	packingUnitType
int	parentVariationId
float	parentItemVariationQuantity
string	picking
float	customsPercent
int	position
int	priceCalculationId
string	primaryVariation
int	primaryVariationId
float	purchasePrice
float	storageCosts
float	transportationCosts
	unitId
int	unitLoadDevice
int	unitsContained
int	vatId
string	variationName
int	weightG
int	weightNetG
float	maximumOrderQuantity
float	minimumOrderQuantity
float	intervalOrderQuantity
string	availableUntil
int	releaseDate
int	widthMm
int	propertyVariationId

Methods

public toArray()

Returns this model as an array.

VariationBundleComponent

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	componentVariationId
float	componentQuantity
string	CreatedTimestamp
string	LastUpdateTimestamp

Methods

public toArray()

Returns this model as an array.

VariationCategory

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	categoryId
int	position
	neckermannPrimary

Methods

public toArray()

Returns this model as an array.

VariationImage

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	imageId
int	type
string	fileType
string	path
int	position
string	lastUpdateTimestamp
string	createTimestamp
string	cleanImageName
int	attributeValueId

Methods

public toArray()

Returns this model as an array.

VariationLinkMarketplace

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
string	created
float	marketplaceId

Methods

public toArray()

Returns this model as an array.

VariationLinkWebstore

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
string	created
int	plentyId

Methods

public toArray()

Returns this model as an array.

VariationMarketStatus

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	id
float	marketId
int	marketAccountId
	initialSku
	sku
	parentSku
int	active
	createdTimestamp
	lastExportTimestamp
	deletedTimestamp
	marketStatus
	additionalInformation

Methods

public toArray()

Returns this model as an array.

VariationRetailPrice

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	priceId
float	price
float	retailPriceNet
int	basePrice
float	basePriceNet
float	unitPrice
float	unitPriceNet
float	orderParamsMarkup
float	orderParamsMarkupNet
float	classRebatePercent
float	classRebate
float	classRebateNet
float	categoryRebatePercent
float	categoryRebate
float	categoryRebateNet
int	vatId
float	vatValue
string	currency
float	exchangeRatio

Methods

public toArray()

Returns this model as an array.

VariationSetRetailPrice

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	priceId
float	price
float	retailPriceNet
int	basePrice
float	basePriceNet
float	unitPrice
float	unitPriceNet
float	orderParamsMarkup
float	orderParamsMarkupNet
float	classRebatePercent
float	classRebate
float	classRebateNet
float	categoryRebatePercent
float	categoryRebate
float	categoryRebateNet
int	vatId
float	vatValue
string	currency
float	exchangeRatio

Methods

public toArray()

Returns this model as an array.

VariationSpecialOfferRetailPrice

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	retailPriceId
float	retailPrice
float	retailPriceNet
float	basePrice
float	basePriceNet
float	unitPrice
float	unitPriceNet
float	orderParamsMarkup
float	orderParamsMarkupNet
int	vatId
float	vatValue
	currency
float	exchangeRatio
	lastUpdateTimestamp

Methods

public toArray()

Returns this model as an array.

VariationStandardCategory

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	categoryId
int	plentyId
string	manually

Methods

public toArray()

Returns this model as an array.

VariationStock

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	warehouseId
	stockPhysical
	reservedStock
	reservedEbay
	reorderDelta
int	stockNet
	updateAmazon
	updatePixmania
	warehouseType
	reordered
	reservedBundle
	averagePurchasePrice
	warehousePriority
string	lastUpdateTimestamp
	lastCalculateTimestamp
	reservedOutOfStock
	reservedBasket

Methods

public toArray()

Returns this model as an array.

VariationStockBuffer

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	stockBuffer

Methods

public toArray()

Returns this model as an array.

VariationSupplier

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
string	createdTimestamp
	deliveryTimeInDays
float	discount
string	discountable
int	id
string	itemNumber
	itemVariationId
string	lastPriceQuery
string	lastUpdateTimestamp
int	minimumOrderValue
float	packagingUnit
float	purchasePrice
int	supplierId

Methods

public toArray()

Returns this model as an array.

VariationWarehouse

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties

Type	Name	Description
int	variationId
int	warehouseId
int	warehouseZoneId
string	storageLocationType
int	reorderLevel
int	maximumStock
int	stockBuffer
int	stockTurnoverInDays
int	storageLocationId
string	lastUpdateTimestamp
string	createdTimestamp

Methods

public toArray()

Returns this model as an array.

Services

ItemDataLayerResultLookup

ItemDataLayer Lookup

Namespace

Plenty\Modules\Item\DataLayer\Services

Methods

public getNumberOfRows():int

public getResult():array

DefaultShippingCost

Contracts

DefaultShippingCostRepositoryContract

The contract for the default shipping cost repository

Namespace

Plenty\Modules\Item\DefaultShippingCost\Contracts

Methods

public findShippingCost(int $itemId, float $referrerId, int $shippingDestinationId, int $paymentMethodId):float

Parameters

int	$itemId	The ID of the item
float	$referrerId	The ID of the referrer
int	$shippingDestinationId	The ID of the shipping destination
int	$paymentMethodId	The ID of the payment method

Models

DefaultShippingCost

The default shipping cost model

Namespace

Plenty\Modules\Item\DefaultShippingCost\Models

Properties

Type	Name	Description
int	id
int	itemId
int	profileId

Methods

public toArray()

Returns this model as an array.

Item

Contracts

ItemRepositoryContract

The contract for the attribute value repository

Namespace

Plenty\Modules\Item\Item\Contracts

Methods

public add(array $data):void

Creates an item.

Parameters

$data

The item data as an associative array

public show(int $itemId, array $columns = [], string $lang = "de", array $with = []):void

Get an item. The ID of the item must be specified.

Parameters

int	$itemId	The ID of the item
array	$columns	The array of the shown columns. All columns are returned by default.
string	$lang	The language of the item
array	$with	The relations to be loaded.

public search($columns = [], $lang = [], int $page = 1, int $itemsPerPage = 50, array $with = []):void

Parameters

	$columns	The array of the shown columns. All columns are returned by default.
	$lang	The language of the item
int	$page	The shown page. Default value is 1.
int	$itemsPerPage	The items shown per page. Default value is 50.
array	$with	The relations to be loaded.

public update(array $data, int $itemId):Item

Update a item. The ID of the item must be specified.

Parameters

array	$data
int	$itemId

public bulkUpdate(array $data):Collection

Update up to 50 items. The ID of the item must be specified.

Parameters

$data

public delete(int $itemId):DeleteResponse

Delete an item. The ID of the item must be specified.

Parameters

$itemId

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Item

The item model

Namespace

Plenty\Modules\Item\Item\Models

Properties

Type	Name	Description
int	id	The ID of the item. The ID must be unique.
int	position	The position of the item
string	itemType	The type of the item. Because Set items are managed using a separate route, this value is always Default.
int	stockType	The stock type of the item. Possible values: 0 = Stocked item (default) 1 = Production item 2 = Colli 3 = Special order item
int	storeSpecial	Option to present items more prominently in the online store. 1 = Special offer 2 = New items 3 = Top items
int	ownerId	The plentymarkets user that is assigned as owner of this item.
int	manufacturerId	The ID of the manufacturer of the item
int	producingCountryId	The ID of the country in which the item was manufactured.
int	mainVariationId	The ID of the main variation of the item. The ID must be unique.
int	revenueAccount	The revenue account the item is linked to. An individual revenue account can be saved for each item in plentymarkets. If this is not done, plentymarkets automatically determines a revenue account based on the VAT rate.
int	couponRestriction	Indicates if the item can be purchased using a promotional coupon. 0 = Permitted 1 = Not permitted 2 = Purchasable with coupon only
int	condition	The condition of the item. Possible values: 0 = New 1 = Used 2 = Boxed as new 3 = New with label 4 = Factory seconds
int	conditionApi	The condition of the item that is transferred to markets via API. 0 = New 1 = Used but as new 2 = Used but very good 3 = Used but good 4 = Used but acceptable 5 = Factory seconds
string	createdAt	Timestamp of the date and time the item was created.
string	updatedAt	Timestamp of the last date and time the item was updated.
bool	isSubscribable	Flag that indicates if the item can be ordered as a subscription item. If yes, the item can be ordered for delivery at regular intervals.
bool	isSerialNumber	Flag that indicates if serial numbers are to be assigned to variations of this item to uniquely identify every item sold. Serial numbers ensure traceability of an item in case of errors or problems.
bool	isShippingPackage	Flag that indicates if a shipping package is to be used for this item. If yes and the variation's dimensions are entered in the Settings tab of a variation, the correct shipping package is assigned automatically.
int	amazonFbaPlatform	Indicates the platform used for Fulfilment by Amazon (FBA). 0 = Do not use 1 = AMAZON EU (Europe) 2 = AMAZON FE (Far East) 3 = AMAZON NA (North America)
bool	isShippableByAmazon	Flag that indicates if the item can be shipped with Amazon Multi-Channel. Amazon Multi-Channel Fulfillment is a service for fulfilling orders from sales channels other than Amazon platforms using inventory stored in the Amazon fulfillment center.
int	amazonProductType	The Amazon product type of the item. List of IDs: https://www.plentymarkets.co.uk/manual/data-exchange/data-formats/item/
string	amazonFedas	The FEDAS product classification key of the item.
int	ebayPresetId	The eBay preset ID. This plentymarkets ID must be specified to save values for $ebayCategory, $ebayCategory2, $ebayStoreCategory and $ebayStoreCategory2.
int	ebayCategory	The eBay category 1 of the item. This category is used when a new listing is created.
int	ebayCategory2	The eBay category 2 of the item. This category is used when a new listing is created.
int	ebayStoreCategory	The ID of the eBay store category 1 of the item. This value is used for new listings.
int	ebayStoreCategory2	The ID of the eBay store category 2 of the item. This value is used for new listings.
int	rakutenCategoryId	The ID of the Rakuten category of this item.
int	flagOne	Flag 1 of the item. Flags can be used to organise and filter items. Each item can be assigned up to two flags. Possible values: 1 to 31, 0 = no flag
int	flagTwo	Flag 2 of the item. Flags can be used to organise and filter items. Each item can be assigned up to two flags. Possible values: 1 to 11, 0 = no flag
int	ageRestriction	The age customers must be to purchase the item. Items with an age rating of 18+ must be linked to a shipping profile for which the PostIdent option is activated. 0 = None available 3 = Released for ages 3 and up 6 = Ages 6 and up 9 = Ages 9 and up 12 = Ages 12 and up 14 = Ages 14 and up 16 = Ages 16 and up 18 = Ages 18 and up 50 = Not marked 88 = Not required 99 = Unknown
int	feedback	The feedback, i.e. rating, that this item received. Possible values are 1 to 5 or 1 to 10 depending on the maximum rating setting. An initial feedback can be saved for items. The saved value will then be displayed as the initial feedback. Every time new feedback is submitted, the average value will be recalculated automatically.
string	free1	The content of the free text field 1. This can be displayed in the online store or on eBay.
string	free2	The content of the free text field 2. This can be displayed in the online store or on eBay.
string	free3	The content of the free text field 3. This can be displayed in the online store or on eBay.
string	free4	The content of the free text field 4. This can be displayed in the online store or on eBay.
string	free5	The content of the free text field 5. This can be displayed in the online store or on eBay.
string	free6	The content of the free text field 6. This can be displayed in the online store or on eBay.
string	free7	The content of the free text field 7. This can be displayed in the online store or on eBay.
string	free8	The content of the free text field 8. This can be displayed in the online store or on eBay.
string	free9	The content of the free text field 9. This can be displayed in the online store or on eBay.
string	free10	The content of the free text field 10. This can be displayed in the online store or on eBay.
string	free11	The content of the free text field 11. This can be displayed in the online store or on eBay.
string	free12	The content of the free text field 12. This can be displayed in the online store or on eBay.
string	free13	The content of the free text field 13. This can be displayed in the online store or on eBay.
string	free14	The content of the free text field 14. This can be displayed in the online store or on eBay.
string	free15	The content of the free text field 15. This can be displayed in the online store or on eBay.
string	free16	The content of the free text field 16. This can be displayed in the online store or on eBay.
string	free17	The content of the free text field 17. This can be displayed in the online store or on eBay.
string	free18	The content of the free text field 18. This can be displayed in the online store or on eBay.
string	free19	The content of the free text field 19. This can be displayed in the online store or on eBay.
string	free20	The content of the free text field 20. This can be displayed in the online store or on eBay.
float	maximumOrderQuantity	The maximum order quantity of an item permitted per order. If a maximum order quantity is specified, no more than this quantity of any combination of the variations of the item can be ordered. Decimal values are possible to allow orders by weight or length. Default value is 0. If value is 0, the maximum order quantity is unlimited.
array	texts
array	ebayTitles
array	itemShippingProfiles
array	itemProperties
array	itemCrossSelling
array	variations	An array of the variations of the item.
array	itemImages	An array of the images of the item.
string	customsTariffNumber	Deprecated: The customs tariff number of the item; usually a 11 digit code number based on the Harmonised System

Methods

public toArray()

Returns this model as an array.

ItemEbayTitle

The item ebay title model

Namespace

Plenty\Modules\Item\Item\Models

Properties

Type	Name	Description
string	title	The title.
int	itemId	The unique ID of the item.
int	id	The unique ID of the ebay title.

Methods

public toArray()

Returns this model as an array.

ItemText

The item text model

Namespace

Plenty\Modules\Item\Item\Models

Properties

Type	Name	Description
string	lang	The language of the item text.
string	name1	Default name of the item displayed in the online store and used for markets. The maximum length is 240 characters. The item name is also used for structuring the item URL.
string	name2	Alternative item name that can be used e.g. for markets. The maximum length is 240 characters.
string	name3	Alternative item name that can be used e.g. for markets. The maximum length is 240 characters.
string	shortDescription	The preview text of the item. This short description text can be displayed as a teaser in item lists.
string	metaDescription	The meta description of the item. This description is analysed by search engines and displayed in search results. This text should be treated as an advertising text to maximise click-through from search engine result pages. Current recommended limit is 156 characters.
string	description	The detailed description of the item.
string	technicalData	Technical data of the item.
string	keywords	HTML meta keywords to tag the item for search engines. More than one keyword can be separated by commas.
string	urlPath	The item's URL path in the online store. By default, the URL path consists of the categories and the item name. The path is assigned automatically when the item is created and is displayed as part of the URL when the item is selected in the online store.

Methods

public toArray()

Returns this model as an array.

ItemCoupon

Hooks

CheckItemRestriction

Namespace

Plenty\Modules\Item\ItemCoupon\Hooks

Methods

public handle(BasketItemEvent
 $basketItemEvent):void

Parameters

BasketItemEvent

$basketItemEvent

ItemCrossSelling

Contracts

DynamicItemCrossSellingRepositoryContract

Repository for dynamic item cross-selling

Namespace

Plenty\Modules\Item\ItemCrossSelling\Contracts

Methods

public create(array $data):DynamicItemCrossSelling

Create a new dynamic cross-selling link

Parameters

$data

public show(int $itemId, int $crossItemId):DynamicItemCrossSelling

Get one dynamic cross-selling link of an item by item ID and cross-selling item ID

Parameters

int	$itemId	The unique ID of the item
int	$crossItemId	The unique ID of the linked cross-selling item

public delete(int $itemId, int $crossItemId):DeleteResponse

Delete a dynamic cross-selling link. The ID of the item and the ID of the cross-selling item must be specified. An exception is thrown if at least one relation exists.

Parameters

int	$itemId	The unique ID of the item
int	$crossItemId	The unique ID of the linked cross-selling item

public findByItemId(int $itemId):array

List dynamic cross-selling links by item ID

Parameters

$itemId

The unique ID of the item

public findAllByItemId(int $itemId):array

List all dynamic cross-selling links where the given item ID occurs

Parameters

$itemId

The unique ID of the item

ItemCrossSellingRepositoryContract

Repository for item cross-selling

Namespace

Plenty\Modules\Item\ItemCrossSelling\Contracts

Methods

public create(array $data):ItemCrossSelling

Parameters

$data

public show(int $itemId):ItemCrossSelling

Parameters

$itemId

The unique ID of the item

public delete(int $itemId, int $crossItemId):bool

Parameters

int	$itemId	The unique ID of the item
int	$crossItemId	The unique ID of the linked cross-selling item

public findByItemId(int $itemId):array

Parameters

$itemId

The unique ID of the item

public findAllByItemId(int $itemId):array

List all cross-selling links where the given item ID occurs

Parameters

$itemId

The unique ID of the item

public search(int $itemsPerPage = 50, int $page = 1):PaginatedResult

Parameters

int	$itemsPerPage
int	$page

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

DynamicItemCrossSelling

The item dynamic cross-selling model including the item

Namespace

Plenty\Modules\Item\ItemCrossSelling\Models

Properties

Type	Name	Description
int	itemId	The unique ID of the item to which cross-selling items are linked
int	crossItemId	The unique ID of the cross-selling item that is linked to the item
int	count	The count
int	lastUpdate	Last update integer
Item	item

Methods

public toArray()

Returns this model as an array.

ItemCrossSelling

The item cross-selling model including the item

Namespace

Plenty\Modules\Item\ItemCrossSelling\Models

Properties

Type	Name	Description
int	itemId	The unique ID of the item to which cross-selling items are linked
int	crossItemId	The unique ID of the cross-selling item that is linked to the item
string	relationship	The cross-selling relationship between item and cross-selling item. Possible values: Accessory = The cross-selling item is an accessory of the item. ReplacementPart = The cross-selling item is a replacement part for the item. Similar = The cross-selling item is similar to the item. Bundle = The cross-selling item is suitable to be sold as a bundle with the item.
bool	isDynamic	Flag that indicates if the cross-selling link was generated automatically.
Item	item

Methods

public toArray()

Returns this model as an array.

ItemImage

Contracts

ItemImageAvailabilityRepositoryContract

The contract for the item image availability repository

Namespace

Plenty\Modules\Item\ItemImage\Contracts

Methods

public create(array $data):ItemImageAvailability

Creates an image availability

Parameters

$data

The image availability data as associative array

public delete(array $data):DeleteResponse

Deletes an image availability.

Parameters

$data

The image availability data as associative array

public findByImageId(int $imageId):ItemImageAvailability

Lists image availabilities. The ID of the image must be specified.

Parameters

$imageId

The ID of the image

public findByType(int $imageId, string $type):ItemImageAvailability

Lists image availabilities. The ID of the image and the type must be specified.

Parameters

int	$imageId	The ID of the image
string	$type	The type of the image

ItemImageNameRepositoryContract

The contract for the item image name repository

Namespace

Plenty\Modules\Item\ItemImage\Contracts

Methods

public create(array $data):ItemImageName

Creates an image name

Parameters

$data

The image name data as associative array

public update(array $data, int $imageId, string $lang):ItemImageName

Updates an image name. The ID of the image and the language must be specified.

Parameters

array	$data	The image name data as associative array
int	$imageId	The ID of the image
string	$lang	The language of the image name

public delete(int $imageId, string $lang):DeleteResponse

Deletes an image name. The ID of the image and the language must be specified.

Parameters

int	$imageId	The ID of the image
string	$lang	The language of the image name

public findOne(int $imageId, string $lang):ItemImageName

Gets an image name. The ID of the image and the language must be specified.

Parameters

int	$imageId	The ID of the image
string	$lang	The language of the image name

public findByImageId(int $imageId):array

Lists all image names. The ID of the image must be specified.

Parameters

$imageId

The ID of the image

ItemImageRepositoryContract

The contract for the item image repository

Namespace

Plenty\Modules\Item\ItemImage\Contracts

Methods

public update(array $data, int $imageId):ItemImage

Updates an image. The ID of the image must be specified.

Parameters

array	$data	The image data as associative array
int	$imageId	The ID of the image

public delete(int $imageId):DeleteResponse

Deletes an image. The ID of the item must be specified.

Parameters

$imageId

The ID of the image

public show(int $imageId):ItemImage

Shows an image. The ID of the item must be specified.

Parameters

$imageId

The ID of the image

public findByItemId(int $itemId):array

Lists images. The ID of the item must be specified.

Parameters

$itemId

The ID of the image

public findByVariationId(int $variationId):array

Lists images. The ID of the variation must be specified.

Parameters

$variationId

The ID of the variation

public findByItemIdAndOriginalChecksum(int $itemId, string $checksum):ItemImage

Shows an image. The ID of the item and hash must be specified.

Parameters

int	$itemId	The ID of the item
string	$checksum	The MD5 checksum of the image

public upload(array $data):ItemImage

Uploads an item image

Parameters

$data

The image data as associative array

public warmup(array $urls, string $queue = "plentymarkets-command"):void

Calls a stack of image urls to prepare cache

Parameters

array	$urls	array of urls to call
string	$queue	name of queue

public syncOldImagesToCDN():void

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

ItemImageSettingsRepositoryContract

Get, update or invalidate item image settings

Namespace

Plenty\Modules\Item\ItemImage\Contracts

Methods

public get():ItemImageSettings

public update($data):ItemImageSettings

Parameters

$data

public invalidate(string $path):ItemImageSettings

Parameters

$path

public invalidateStatus():void

Models

ItemImage

The ItemImage Model

Namespace

Plenty\Modules\Item\ItemImage\Models

Properties

Type	Name	Description
int	id	The unique ID of the image
int	itemId	The unique ID of the item the image is associated with
string	fileType	The file format of the image. Possible file formats: jpg, jpeg, png, gif, svg
string	path	The path under which the image is saved.
int	position	The position of the image. The position is used for sorting images in the online store.
string	createdAt	The time the image was uploaded.
string	updatedAt	The time the image details were last updated.
string	md5Checksum	The MD5 hash value of the image file
string	md5ChecksumOriginal	The MD5 hash value of the original image file
int	size	The size of the image in pixels
int	width	The width of the image in pixels
int	height	The height of the image in pixels
string	url	The URL under which the image can be accessed after the upload.
string	urlMiddle	The URL that points to the medium-sized version of the item image.
string	urlPreview	The URL that points to the first preview version of the item image.
string	urlSecondPreview	The URL that points to the second preview version of the item image.
array	names	Lists the image's name details as an array.
array	availabilities	Lists the image's availability details as an array.
array	attributeValueImages	Lists the attribute value image's details as an array.

Methods

public toArray()

Returns this model as an array.

ItemImageAvailability

Namespace

Plenty\Modules\Item\ItemImage\Models

Properties

Type	Name	Description
int	imageId	The ID of the image. The ID must be unique.
string	type	The type of referrer for which the image is available. Possible types: mandant = The image can be made available for clients (stores). marketplace = The image can be made available for markets. listing = The image can be made available for listings.
float	value	For the type mandant, this is the plentyID of the client (store) for which the image is available. For the types marketplace and listing, this is the ID of the referrer for which the image is available. -1.00 = The image is available for all referrers of this type.

Methods

public toArray()

Returns this model as an array.

ItemImageName

Namespace

Plenty\Modules\Item\ItemImage\Models

Properties

Type	Name	Description
int	imageId	The ID of the image. The ID must be unique.
string	lang	The language of the image name
string	name	The name of the image in the specified language
string	alternate	The alternative name of the image in the specified language

Methods

public toArray()

Returns this model as an array.

ItemImageUpload

ItemImage

Namespace

Plenty\Modules\Item\ItemImage\Models

Properties

Type	Name	Description
int	id	The ID of the image. The ID must be unique.
int	itemId	The ID of the item the image is associated with
string	fileType	The file format of the image. Possible file formats: JPG, JPEG, PNG, GIF, SVG
string	path	The path under which the image is saved. Permitted characters for file names: alphanumeric (a-z, A-Z, 0-9), hypens (-), underscores (_).
int	position	The position of the image. The position is used for sorting images in the online store.
string	created	The time the image was uploaded.
string	updated	The time the image details were last updated.
string	uploadImageData	The base64 encoded image data of the image
string	uploadUrl	The URL under which the image can be accessed for uploading. Permitted characters for file names: alphanumeric (a-z, A-Z, 0-9), hypens (-), underscores (_).
string	uploadFileName	The file name assigned to the uploaded image. Permitted characters for file names: alphanumeric (a-z, A-Z, 0-9), hypens (-), underscores (_).
array	names	names
array	availabilities	availabilities

Methods

public toArray()

Returns this model as an array.

ItemLabel

Contracts

ItemLabelRepositoryContract

The contract for the item label repository

Namespace

Plenty\Modules\Item\ItemLabel\Contracts

Methods

public generateLabel(array $data):string

Get a variation label

Parameters

$data

The required data to generate the item label

public listTemplates():array

List item label templates

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

ItemLabel

The item label model

Namespace

Plenty\Modules\Item\ItemLabel\Models

Properties

Type	Name	Description
int	labelId	The unique ID of the label template
int	itemId	The unique ID of the item

Methods

public toArray()

Returns this model as an array.

ItemProperty

Contracts

ItemPropertyRepositoryContract

The contract for the item property repository

Namespace

Plenty\Modules\Item\ItemProperty\Contracts

Methods

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

ItemProperty

ItemPropertyValue

Namespace

Plenty\Modules\Item\ItemProperty\Models

Properties

Type	Name	Description
int	id	The id of the variation property value
int	itemId	The id of the variation
int	propertyId	The id of the property item
int	propertySelectionId	The id of the property selection
int	valueInt	The int value of the variation property value
float	valueFloat	The float value of the variation property value
string	valueFile	The file value of the variation property value
float	surcharge	The surcharge of the variation property value
Property	property
array	propertySelection
array	valueTexts

Methods

public toArray()

Returns this model as an array.

ItemPropertyValueText

The ItemPropertyValueText

Namespace

Plenty\Modules\Item\ItemProperty\Models

Properties

Type	Name	Description
int	valueId
string	lang
string	value

Methods

public toArray()

Returns this model as an array.

ItemSerialNumber

Contracts

ItemSerialNumberRepositoryContract

The contract of the item serial number repository

Namespace

Plenty\Modules\Item\ItemSerialNumber\Contracts

Methods

public all(int $perPage = 100, int $page = 1):PaginatedResult

Lists all serial numbers.

Parameters

int	$perPage
int	$page

public show(int $id):ItemSerialNumber

Gets a serial number. The ID of the serial number must be specified.

Parameters

$id

public create(array $data):ItemSerialNumber

Creates a serial number

Parameters

$data

public update(int $id, array $data):ItemSerialNumber

Updates a serial number. The ID of the serial number must be specified.

Parameters

int	$id
array	$data

public delete(int $id):DeleteResponseContract

Deletes a serial number. The ID of the serial number must be specified.

Parameters

$id

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

Models

ItemSerialNumber

The item serial number model

Namespace

Plenty\Modules\Item\ItemSerialNumber\Models

Properties

Type	Name	Description
int	id	The ID of the serial number
int	orderId	The ID of the order
int	orderItemId	The ID of the order item
int	itemId	The ID of the item
string	serialNumber	The serial number
string	createdAt	The date the serial number was created

Methods

public toArray()

Returns this model as an array.

ItemShippingProfiles

Contracts

ItemShippingProfilesRepositoryContract

Repository for ItemShippingProfiles

Namespace

Plenty\Modules\Item\ItemShippingProfiles\Contracts

Methods

public find(int $id):ItemShippingProfiles

Finds a shipping profile link by ID

Parameters

$id

The unique ID of the link between shipping profile and item

public findByItemId(int $itemId):array

Lists all shipping profiles activated for an item

Parameters

$itemId

The unique ID of the item

public create(array $data):ItemShippingProfiles

Activates a shipping profile for an item

Parameters

$data

public delete(int $id):array

Deactivates a shipping profile for an item

Parameters

$id

The unique ID of the link between shipping profile and item

public getItemShippingProfiles(int $itemsPerPage, int $page):PaginatedResult

Lists all shipping profiles of all items

Parameters

int	$itemsPerPage
int	$page

public createBulk(array $data):array

Activates up to 50 shipping profiles for items

Parameters

$data

public deleteBulk(int $itemId):void

Deactivates all shipping profiles for an item

Parameters

$itemId

public deleteOne(int $shippingProfileId, int $itemId):DeleteResponse

Delete the link between the specified shipping profile and item

Parameters

int	$shippingProfileId
int	$itemId

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

Models

ItemShippingProfiles

The shipping profile model

Namespace

Plenty\Modules\Item\ItemShippingProfiles\Models

Properties

Type	Name	Description
int	id	The unique ID of the link between item and shipping profile
int	itemId	The unique ID of the item
int	profileId	The unique ID of the shipping profile

Methods

public toArray()

Returns this model as an array.

Manufacturer

Contracts

ManufacturerCommissionRepositoryContract

The contract for the manufacturer commission repository

Namespace

Plenty\Modules\Item\Manufacturer\Contracts

Methods

public find(int $id):ManufacturerCommission

Gets a manufacturer commission. The ID of the manufacturer commission must be specified.

Parameters

$id

The ID of the manufacturer

public create(array $data):ManufacturerCommission

Creates a manufacturer commission.

Parameters

$data

The manufacturer commission data as an associative array

public update(array $data, int $id):ManufacturerCommission

Updates a manufacturer commission. The ID of the manufacturer commission must be specified.

Parameters

array	$data	The manufacturer commission data as an associative array
int	$id	The ID of the manufacturer

public delete(int $id):DeleteResponse

Deletes a manufacturer commission. The ID of the manufacturer commission must be specified.

Parameters

$id

The ID of the manufacturer

public findByManufacturerId(int $manufacturerId):array

Lists manufacturer commissions. The ID of the manufacturer must be specified.

Parameters

$manufacturerId

The ID of the manufacturer

ManufacturerExternalRepositoryContract

The contract for the manufacturer external repository

Namespace

Plenty\Modules\Item\Manufacturer\Contracts

Methods

public find(int $manufacturerId, int $marketId):ManufacturerExternal

Gets a manufacturer external. The ID of the manufacturer and the ID of the market must be specified.

Parameters

int	$manufacturerId	The ID of the manufacturer
int	$marketId	The ID of the market

public create(array $data):ManufacturerExternal

Creates a manufacturer external.

Parameters

$data

The manufacturer external data as an associative array

public update(array $data, int $manufacturerId, int $marketId):ManufacturerExternal

Updates a manufacturer external. The ID of the manufacturer and the ID of the market must be specified.

Parameters

array	$data	The manufacturer external data as an associative array
int	$manufacturerId	The ID of the manufacturer
int	$marketId	The ID of the market

public delete(int $manufacturerId, int $marketId):DeleteResponse

Deletes a manufacturer external. The ID of the manufacturer and the ID of the market must be specified.

Parameters

int	$manufacturerId	The ID of the manufacturer
int	$marketId	The ID of the market

public search():array

Lists manufacturer externals.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

ManufacturerRepositoryContract

The contract for the manufacturer repository

Namespace

Plenty\Modules\Item\Manufacturer\Contracts

Methods

public create(array $data):Manufacturer

Creates a manufacturer.

Parameters

$data

The manufacturer data as an associative array

public update(array $data, int $manufacturerId):Manufacturer

Updates a manufacturer. The ID of the manufacturer must be specified.

Parameters

array	$data	The manufacturer data as an associative array
int	$manufacturerId	The ID of the manufacturer

public delete(int $manufacturerId):DeleteResponse

Deletes a manufacturer. The ID of the manufacturer must be specified.

Parameters

$manufacturerId

The ID of the manufacturer

public findById(int $manufacturerId, array $with = []):Manufacturer

Gets a manufacturer. The ID of the manufacturer must be specified.

Parameters

int	$manufacturerId	The ID of the manufacturer
array	$with

public all(array $columns = [], int $perPage = 50, int $page = 1, array $with = []):PaginatedResult

Lists all manufacturers.

Parameters

array	$columns	An array of the shown columns. All columns are returned by default.
int	$perPage	The amount of manufacturers shown per page. Default value is 50.
int	$page	The shown page. Default value is 1.
array	$with

public search(array $params = [], array $columns = []):PaginatedResult

Lists manufacturers by filter

Parameters

array	$params	The filter array
array	$columns	An array of the shown columns. All columns are returned by default.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Manufacturer

The item manufacturer model

Namespace

Plenty\Modules\Item\Manufacturer\Models

Properties

Type	Name	Description
int	id	The unique ID of the manufacturer.
string	name	The name of the manufacturer
string	externalName	The external name of the manufacturer. The external name is used for the item export to external markets. If no external name is saved, the Name will be used. The external name will also be transferred to FINDOLOGIC and will be indexed for item searches.
string	logo	The URL of the manufacturer's logo
string	url	The URL of the manufacturer's website
string	street	The street of the manufacturer's address
string	houseNo	The house number of the manufacturer's address
string	postcode	The postal code of the manufacturer's address
string	town	The town of the manufacturer's address
string	phoneNumber	The phone number of the manufacturer
string	faxNumber	The fax number of the manufacturer
string	email	The email address of the manufacturer
int	countryId	The ID of the country in which the manufacturer is based; 0 = unknown.
int	pixmaniaBrandId	The manufacturer's ID on the market Pixmania
int	neckermannAtEpBrandId	The manufacturer's ID on the market Neckermann Austria, Enterprise version
int	laRedouteBrandId	The manufacturer's ID on the market La Redoute
int	position	The position of the manufacturer
string	comment	Internal comments about the manufacturer (optional)
string	updatedAt	The time the manufacturer information was last updated.
array	commissions
array	externals

Methods

public toArray()

Returns this model as an array.

ManufacturerCommission

The item manufacturer commission model

Namespace

Plenty\Modules\Item\Manufacturer\Models

Properties

Type	Name	Description
int	id	The unique ID of the manufacturer commission
int	manufacturerId	The unique ID of the manufacturer
int	plentyId	The unique ID of the client (store) that the commission applies to. The route /rest/webstores provides access to clients (stores).
float	referrerId	The unique ID of the referrer that the commission applies to. The route /rest/orders/referrers provides access to referrers.
float	commission	The manufacturer commission value in percent
Manufacturer	manufacturer

Methods

public toArray()

Returns this model as an array.

ManufacturerExternal

The item manufacturer external model

Namespace

Plenty\Modules\Item\Manufacturer\Models

Properties

Type	Name	Description
int	manufacturerId	The unique ID of the manufacturer
int	marketId	The unique ID of the market
string	value	The external value
Manufacturer	manufacturer

Methods

public toArray()

Returns this model as an array.

PackingUnit

Contracts

PackingUnitRepositoryContract

Get the packing units for the item variations

Namespace

Plenty\Modules\Item\PackingUnit\Contracts

Methods

public getPackingUnits(string $language):array

Get the item variation packing units

Parameters

$language

Optional. The language of the packing units. If no language will be provided, all of them will be returned

public getPackingUnitsById(int $id, string $language = "all", bool $isUnitId = false):PackingUnit

Get the item variation packing unit for a specific given id

Parameters

int	$id	The id of the packing unit
string	$language	Optional. The language of the packing units. If no language will be provided, all of them will be returned
bool	$isUnitId	Optional. The flag to say if the id provided is the ID of the unit (from 0 to 39). If the flag is true, the query will take into account the ID as being the unit ID

Models

PackingUnit

The model that holds the names of the item variation packing units

Namespace

Plenty\Modules\Item\PackingUnit\Models

Properties

Type	Name	Description
int	id	The id of the packing unit entry. Primary key auto-increment
int	unitId	The id of the packing unit as it was until now (from 0 to 39 without 33)
string	unitNameEN	The name of the packing unit in English
string	unitNameDE	The name of the packing unit in German

Methods

public toArray()

Returns this model as an array.

Property

Contracts

PropertyGroupNameRepositoryContract

The contract for the property group name repository

Namespace

Plenty\Modules\Item\Property\Contracts

Methods

public create(array $data, int $propertyGroupId):PropertyGroupName

Creates a property group name. The ID of the property group must be specified.

Parameters

array	$data	The property group name data as an associative array
int	$propertyGroupId	The ID of the property group

public delete(int $propertyGroupId, string $lang):bool

Deletes a property group name. The ID of the property group and the language must be specified.

Parameters

int	$propertyGroupId	The ID of the property group
string	$lang	The specific language of the property group name

public update(array $data, int $propertyGroupId, string $lang):PropertyGroupName

Updates a property group name. The ID of the property group and the language must be specified.

Parameters

array	$data	The property group name data as an associative array
int	$propertyGroupId	The ID of the property group
string	$lang	The specific language of the property group name

public findOne(int $propertyGroupId, string $lang):PropertyGroupName

Gets a property group name. The ID of the property group and the language must be specified.

Parameters

int	$propertyGroupId	The ID of the property group
string	$lang	The specific language of the property group name

public findByPropertyGroupId(int $propertyGroupId):array

Lists property group names. The ID of the property group must be specified.

Parameters

$propertyGroupId

The ID of the property group

PropertyGroupRepositoryContract

The contract for the property group repository

Namespace

Plenty\Modules\Item\Property\Contracts

Methods

public create(array $data):PropertyGroup

Creates a property group.

Parameters

$data

The property group data as an associative array

public show(int $id):PropertyGroup

Gets a property group. The ID of the property group must be specified.

Parameters

$id

The ID of the property group

public update(array $data, int $id):PropertyGroup

Updates a property group. The ID of the property group must be specified.

Parameters

array	$data	The property group data as an associative array
int	$id	The ID of the property group

public delete(int $id):bool

Deletes a property group. The ID of the property group must be specified.

Parameters

$id

The ID of the property group

public findById(int $id):PropertyGroup

Gets a property group. The ID of the property group must be specified.

Parameters

$id

The ID of the property group

public all(array $columns = [], int $perPage = 50, int $page = 1, array $with = []):array

Lists all property groups.

Parameters

array	$columns	An array of the shown columns. All columns are returned by default.
int	$perPage	The amount of shown property groups per page. Default value is 50.
int	$page	The shown page. Default value is 1.
array	$with

public findByBackendName(string $backendName):PropertyGroup

Gets a property group. The backend name of the property group must be specified.

Parameters

$backendName

PropertyMarketReferenceRepositoryContract

The contract for the property market reference repository

Namespace

Plenty\Modules\Item\Property\Contracts

Methods

public create(array $data, int $propertyId):PropertyMarketReference

Creates a property market reference. The ID of the property must be specified.

Parameters

array	$data	The property market component data as an associative array
int	$propertyId	The ID of the property

public delete(int $propertyId, float $marketReference):bool

Deletes a property market reference. The ID of the property and the language must be specified.

Parameters

int	$propertyId	The ID of the property
float	$marketReference	The market reference value

public update(array $data, int $propertyId, float $marketReference):PropertyMarketReference

Updates a property market reference. The ID of the property and the language must be specified.

Parameters

array	$data	The property market component data as an associative array
int	$propertyId	The ID of the property
float	$marketReference	The market reference value

public findOne(int $propertyId, float $marketReference):PropertyMarketReference

Gets a property market reference. The ID of the property and the language must be specified.

Parameters

int	$propertyId	The ID of the property
float	$marketReference	The market reference value

public findByPropertyId(int $propertyId):PropertyMarketReference

List of property market references. The ID of the property must be specified.

Parameters

$propertyId

The ID of the property

public getPropertyMarketReferences(float $referrerId, int $componentId = null, array $filters = []):array

Lists all property market references.

Parameters

float	$referrerId	The ID of the referrer
int	$componentId	The ID of the component
array	$filters	You can pass here multiple filters. Available: `componentId` - pass multiple component IDs that should be searched for.

PropertyNameRepositoryContract

The contract for the property name repository

Namespace

Plenty\Modules\Item\Property\Contracts

Methods

public create(array $data, int $propertyId):PropertyName

Creates a property name. The ID of the property must be specified.

Parameters

array	$data	The property name data as an associative array
int	$propertyId	The ID of the property

public delete(int $propertyId, string $lang):bool

Deletes a property name. The ID of the property and the language must be specified.

Parameters

int	$propertyId	The ID of the property
string	$lang	The language of the property name

public update(array $data, int $propertyId, string $lang):PropertyName

Updates a property name. The ID of the property and the language must be specified.

Parameters

array	$data	The property name data as an associative array
int	$propertyId	The ID of the property
string	$lang	The language of the property name

public findOne(int $propertyId, string $lang):PropertyName

Gets a property name. The ID of the property and the language must be specified.

Parameters

int	$propertyId	The ID of the property
string	$lang	The language of the property name

public findBypropertyId(int $propertyId):PropertyName

Lists property names. The ID of the property must be specified.

Parameters

$propertyId

The ID of the property

PropertyRepositoryContract

The contract for the property repository

Namespace

Plenty\Modules\Item\Property\Contracts

Methods

public create(array $data):Property

Creates a property.

Parameters

$data

The property data as an associative array

public show(int $id):Property

Gets a property. The ID of the property must be specified.

Parameters

$id

The ID of the property

public update(array $data, int $id):Property

Updates a property. The ID of the property must be specified.

Parameters

array	$data	The property data as an associative array
int	$id	The ID of the property

public delete(int $id):bool

Deletes a property. The ID of the property must be specified.

Parameters

$id

The ID of the property

public findById(int $id):Property

Gets a property. The ID of the property must be specified.

Parameters

$id

The ID of the property

public all(array $columns = [], int $perPage = 50, int $page = 1):array

Lists all properties.

Parameters

array	$columns	An array of the shown columns. All columns are returned by default.
int	$perPage	The amount of attribute values shown per page. Default value is 50
int	$page	The shown page. Default value is 1.

public search(array $columns = [], int $perPage = 50, int $page = 1, array $with = [], array $filter = []):PaginatedResult

Search properties.

Parameters

array	$columns	An array of the shown columns. All columns are returned by default.
int	$perPage	The amount of attribute values shown per page. Default value is 50
int	$page	The shown page. Default value is 1.
array	$with
array	$filter

public findByBackendName(string $backendName):Property

Gets an property. The backend name of the property must be specified.

Parameters

$backendName

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertySelectionRepositoryContract

The contract for the property selection repository

Namespace

Plenty\Modules\Item\Property\Contracts

Methods

public create(array $data, int $propertyId):PropertySelection

Creates a property selection. The ID of the property must be specified.

Parameters

array	$data	The property selection data as an associative array
int	$propertyId	The ID of the property

public createLang(array $data, int $propertyId, int $id):PropertySelection

Creates a property selection lang. The ID of the property selection must be specified.

Parameters

array	$data	The property selection data as an associative array
int	$propertyId	The ID of the property
int	$id	The ID of the property selection

public findByProperty(int $propertyId, string $lang = null):array

List of property selections. The ID of the property must be specified.

Parameters

int	$propertyId
string	$lang	The language of the property selection

public findByPropertyId(int $propertyId):PropertySelection

Deprecated!

This method will not be supported in the future. Please refrain from using it as soon as possible.

List of property selections. The ID of the property must be specified.

Parameters

$propertyId

The ID of the property

public deleteSelection(int $id):DeleteResponse

Deletes a property selection. The ID of the property selection must be specified.

Parameters

$id

The ID of the property selection

public delete(int $id, string $lang):bool

Deletes a property selection in a specified language. The ID of the property selection and the language must be specified.

Parameters

int	$id	The ID of the property selection
string	$lang	The language of the property selection

public findOne(int $id, string $lang):PropertySelection

Get a property selection in the specified language. The ID of the property selection and the language must be specified.

Parameters

int	$id	The ID of the property selection
string	$lang	The language of the property selection

public findSelection(int $id):array

Get a property selection. The ID of the property selection must be specified.

Parameters

$id

The ID of the property selection

public update(array $data, int $id, string $lang):PropertySelection

Updates a property selection. The ID of the property selection and the language must be specified.

Parameters

array	$data	The property selection data as an associative array
int	$id	The ID of the property selection
string	$lang	The language of the property selection

Models

Property

The property including Property name and property market reference

Namespace

Plenty\Modules\Item\Property\Models

Properties

Type	Name	Description
int	id	The ID of the property
int	position	The position of the property
int	propertyGroupId	The ID of the property group the property is assigned to. Value is null if property is not assigned to a property group.
string	unit	The unit of measurement of the property. Value is null if no unit is associated.
string	backendName	The backend name of the property. The back end name is not visible to customers.
string	comment	Internal comment/note saved for the property. Internal comments are not visible to customers.
string	valueType	Permitted property values are: empty = No property type int = A whole number can be saved for an item, e.g. a size. float = A number with decimal places can be saved for an item, e.g. a measurement. selection = One of several options can be saved for the item. The values of the property value Selection can be managed using the route PropertySelection. text = Text can be saved for an item. file = A file can be saved for an item.
bool	isSearchable	Flag that indicates if items can be found by entering the property name as a search term.
bool	isOderProperty	Flag that indicates if the property is available in the order process. Depending on the property type, customers e.g. can enter a text or value or select an option from a drop-down list.
bool	isShownOnItemPage	Flag that indicates if the property will be shown on the item's page in the online store-
bool	isShownOnItemList	Flag that indicates if the property will be shown in the item listing in the online store.
bool	isShownAtCheckout	Flag that indicates if the property will be shown in the order process.
bool	isShownInPdf	Flag that indicates if the property will be shown in PDF documents.
bool	isShownAsAdditionalCosts	Display as additional costs
float	surcharge	The surcharge for the property. Surcharges will automatically be added to the item price in the detailed view of an item and in the order process. The default value is 0.00, i.e. no surcharge. In the plentymarkets front end, the template variable PriceDynamic displays the price of a variation including the surcharge.
string	updatedAt	The time the property was last updated.
array	names
array	marketComponents
array	group
array	selections

Methods

public toArray()

Returns this model as an array.

PropertyGroup

The PropertyGroup including PropertyGroupName

Namespace

Plenty\Modules\Item\Property\Models

Properties

Type	Name	Description
int	id	The unique ID of the property group
string	backendName	The back end name of the property group. This name is not visible to customers.
string	orderPropertyGroupingType	Indicates how order properties are grouped for selection in the order process. This parameter is applicable to order properties of the type None only. none = Order properties are not grouped. single = One of the grouped order properties can be selected from the drop-down list. multi = Multiple order properties can be selected.
bool	isSurchargePercental	Flag that indicates if surcharge values are calculated in percent.
int	ottoComponentId
string	updatedAt	The time the property group was last updated.
array	names
array	properties

Methods

public toArray()

Returns this model as an array.

PropertyGroupName

The PropertyGroupName including PropertyGroup

Namespace

Plenty\Modules\Item\Property\Models

Properties

Type	Name	Description
int	propertyGroupId
string	lang
string	name
string	description
PropertyGroup	propertyGroup

Methods

public toArray()

Returns this model as an array.

PropertyMarketReference

The PropertyMarketReference including Property

Namespace

Plenty\Modules\Item\Property\Models

Properties

Type	Name	Description
int	propertyId	The unique ID of the property
int	componentId	The unique ID of the reference for the market
float	marketId	The unique ID of the market
string	externalComponent	The external reference of the property
Property	property

Methods

public toArray()

Returns this model as an array.

PropertyName

The PropertyName including Property

Namespace

Plenty\Modules\Item\Property\Models

Properties

Type	Name	Description
int	propertyId	The unique ID of the property
string	lang	The language code of the property name
string	name	The name of the property. The property name is displayed in the online store.
string	description	The description of the property. The property description is displayed in the online store.
Property	property

Methods

public toArray()

Returns this model as an array.

PropertySelection

The property selection including the property

Namespace

Plenty\Modules\Item\Property\Models

Properties

Type	Name	Description
int	id	The unique ID of the selection
int	propertyId	The unique ID of the property
string	lang	The code of the language for which name and description of the selection were saved.
string	name	The name of the selection. The name is displayed in the online store.
string	description	The description of the selection. This description is displayed in the online store.
Property	property

Methods

public toArray()

Returns this model as an array.

SalesPrice

Contracts

SalesPriceAccountRepositoryContract

The contract for the sales price referrer account repository

Namespace

Plenty\Modules\Item\SalesPrice\Contracts

Methods

public create(array $data, int $salesPriceId):SalesPriceAccount

Activates a referrer account for a sales price. The ID of the sales price must be specified.

Parameters

array	$data	The account data as an associative array
int	$salesPriceId	The unique ID of the sales price

public delete(int $salesPriceId, int $accountType, int $accountId):DeleteResponse

Deactivates a referrer account for a sales price. The ID of the sales price, the type and the ID of the referrer account must be specified.

Parameters

int	$salesPriceId	The unique ID of the sales price
int	$accountType	The type of the referrer account linked to the sales price
int	$accountId	The ID of the referrer account linked to the sales price

public findOne(int $salesPriceId, int $accountType, int $accountId):SalesPriceAccount

Gets a referrer account for a sales price. The ID of the sales price, the type and the ID of the referrer account must be specified.

Parameters

int	$salesPriceId	The unique ID of the sales price
int	$accountType	The type of the referrer account linked to the sales price
int	$accountId	The ID of the referrer account linked to the sales price

public findByPriceId(int $salesPriceId):array

Lists the activated referrer accounts of a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The unique ID of the sales price

public deleteByPriceId(int $salesPriceId):DeleteResponse

Deactivates the referrer accounts for a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The unique ID of the sales price

SalesPriceCountryRepositoryContract

The contract for the sales price country repository

Namespace

Plenty\Modules\Item\SalesPrice\Contracts

Methods

public create(array $data, int $salesPriceId):SalesPriceCountry

Activates a country for a sales price. The ID of the sales price must be specified.

Parameters

array	$data	The sales price country data as an associative array.
int	$salesPriceId	The unique ID of the sales price

public delete(int $salesPriceId, int $countryId):DeleteResponse

Deactivates a country for a sales price. The ID of the sales price and the ID of the country must be specified.

Parameters

int	$salesPriceId	The ID of the sales price
int	$countryId	The unique ID of the country; -1 = all countries.

public findOne(int $salesPriceId, int $countryId):SalesPriceCountry

Gets a country for a sales price. The ID of the sales price and the ID of the country must be specified.

Parameters

int	$salesPriceId	The ID of the sales price
int	$countryId	The unique ID of the country.

public findByPriceId(int $salesPriceId):array

Lists the countries for a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The unique ID of the sales price

public deleteByPriceId(int $salesPriceId):DeleteResponse

Deletes countries from a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The ID of the sales price

SalesPriceCurrencyRepositoryContract

The contract for the sales price currency repository

Namespace

Plenty\Modules\Item\SalesPrice\Contracts

Methods

public create(array $data, int $salesPriceId):SalesPriceCurrency

Activates a currency for a sales price. The ID of the sales price must be specified.

Parameters

array	$data	The sales price currency data as an associative array
int	$salesPriceId	The unique ID of the sales price

public delete(int $salesPriceId, string $currency):DeleteResponse

Deactivates a currency for a sales price. The ID of the sales price and the ISO code of the currency must be specified.

Parameters

int	$salesPriceId	The unique ID of the sales price
string	$currency	The ISO code of the currency; -1 = all currencies.

public findOne(int $salesPriceId, string $currency):SalesPriceCurrency

Gets a sales price currency. The ID of the sales price and the ISO code of the currency must be specified.

Parameters

int	$salesPriceId	The ID of the sales price
string	$currency	The ISO code of the currency; -1 = all currencies.

public findByPriceId(int $salesPriceId):array

Lists the active currencies of a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The unique ID of the sales price

public deleteByPriceId(int $salesPriceId):DeleteResponse

Deactivates the currencies of a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The unique ID of the sales price

SalesPriceCustomerClassRepositoryContract

The contract for the sales price customer class repository

Namespace

Plenty\Modules\Item\SalesPrice\Contracts

Methods

public create(array $data, int $salesPriceId):SalesPriceCustomerClass

Activates a customer class for a sales price. The ID of the sales price must be specified.

Parameters

array	$data	The customer class data as an associative array
int	$salesPriceId	The unique ID of the sales price

public delete(int $salesPriceId, int $customerClassId):DeleteResponse

Deactivates a customer class for a sales price. The ID of the sales price and the ID of the customer class must be specified.

Parameters

int	$salesPriceId	The unique ID of the sales price
int	$customerClassId	The unique ID of the customer class

public findOne(int $salesPriceId, int $customerClassId):SalesPriceCustomerClass

Gets a customer class for a sales price. The ID of the sales price and the ID of the customer class must be specified.

Parameters

int	$salesPriceId	The unique ID of the sales price
int	$customerClassId	The unique ID of the customer class

public findByPriceId(int $salesPriceId):array

Lists the active customer classes of a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The unique ID of the sales price

public deleteByPriceId(int $salesPriceId):DeleteResponse

Deactivates the customer classes of a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The unique ID of the sales price

SalesPriceNameRepositoryContract

The contract for the sales price name repository

Namespace

Plenty\Modules\Item\SalesPrice\Contracts

Methods

public create(array $data, int $salesPriceId):SalesPriceName

Creates a sales price name. The ID of the sales price must be specified.

Parameters

array	$data	The sales price name data as an associative array
int	$salesPriceId	The unique ID of the sales price

public update(array $data, int $salesPriceId, string $lang):SalesPriceName

Updates a sales price name. The ID of the sales price and the language code must be specified.

Parameters

array	$data	The sales price name data as an associative array
int	$salesPriceId	The unique ID of the sales price
string	$lang	The language code of the sales price name

public delete(int $salesPriceId, string $lang):DeleteResponse

Deletes a sales price name. The ID of the sales price and the language code must be specified.

Parameters

int	$salesPriceId	The unique ID of the sales price
string	$lang	The language code of the sales price name

public findOne(int $salesPriceId, string $lang):SalesPriceName

Gets a sales price name. The ID of the sales price and the language code must be specified.

Parameters

int	$salesPriceId	The unique ID of the sales price
string	$lang	The language code of the sales price name

public findByPriceId(int $salesPriceId):array

Lists all sales price names of a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The unique ID of the sales price

SalesPriceOnlineStoreRepositoryContract

The contract for the sales price online store repository

Namespace

Plenty\Modules\Item\SalesPrice\Contracts

Methods

public create(array $data, int $salesPriceId):SalesPriceOnlineStore

Activates a client (store) for a sales price. The ID of the sales price must be specified.

Parameters

array	$data	The client (store) data as an associative array
int	$salesPriceId	The unique ID of the sales price

public delete(int $salesPriceId, int $onlineStoreId):DeleteResponse

Deactivates a client (store) for a sales price. The ID of the sales price and the ID of the client (store) must be specified.

Parameters

int	$salesPriceId	The unique ID of the sales price
int	$onlineStoreId	The unique ID of the client (store)

public deleteByPriceId(int $salesPriceId):DeleteResponse

Deactivates all clients (stores) for a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The unique ID of the sales price

public findOne(int $salesPriceId, int $onlineStoreId):SalesPriceOnlineStore

Gets client (store) information for a sales price. The ID of the sales price and the ID of the client (store) must be specified.

Parameters

int	$salesPriceId	The unique ID of the sales price
int	$onlineStoreId	The ID of the online store

public findByPriceId(int $salesPriceId):array

Lists the active clients (stores) for a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The unique ID of the sales price

SalesPriceReferrerRepositoryContract

The contract for the sales price referrer repository

Namespace

Plenty\Modules\Item\SalesPrice\Contracts

Methods

public create(array $data, int $salesPriceId):SalesPriceReferrer

Activates a referrer for a sales price. The ID of the sales price must be specified.

Parameters

array	$data	The sales price referrer data as an associative array
int	$salesPriceId	The unique ID of the sales price

public delete(int $salesPriceId, int $referrerId):DeleteResponse

Deactivates a referrer for a sales price. The ID of the sales price and the ID of the referrer must be specified.

Parameters

int	$salesPriceId	The unique ID of the sales price
int	$referrerId	The ID of the referrer

public findOne(int $salesPriceId, int $referrerId):SalesPriceReferrer

Gets a referrer. The ID of the sales price and the ID of the referrer must be specified.

Parameters

int	$salesPriceId	The unique ID of the sales price
int	$referrerId	The ID of the referrer

public findByPriceId(int $salesPriceId):array

Lists all activated referrers of a sales. The ID of the sales price must be specified.

Parameters

$salesPriceId

The unique ID of the sales price

public deleteByPriceId(int $salesPriceId):DeleteResponse

Deactivates all referrers for a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The unique ID of the sales price

SalesPriceRepositoryContract

The contract for the sales price repository

Namespace

Plenty\Modules\Item\SalesPrice\Contracts

Methods

public show(int $salesPriceId):SalesPrice

Gets a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The ID of the sales price

public create(array $data):SalesPrice

Creates a sales price.

Parameters

$data

The sales price data as an associative array

public update(array $data, int $salesPriceId):SalesPrice

Updates a sales price. The ID of the sales price must be specified.

Parameters

array	$data	The sales price data as an associative array
int	$salesPriceId	The ID of the sales price

public delete(int $salesPriceId):DeleteResponse

Deletes a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The ID of the sales price

public findById(int $salesPriceId):SalesPrice

Gets a sales price. The ID of the sales price must be specified.

Parameters

$salesPriceId

The ID of the sales price

public all(array $columns = [], int $perPage = 50, int $page = 1):PaginatedResult

Lists all sales prices.

Parameters

array	$columns	An array of the shown columns. All columns are returned by default.
int	$perPage	The amount of sales prices shown per page. Default value is 50
int	$page	The shown page. Default value is 1

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

SalesPriceSearchRepositoryContract

The contract for the sales price search repository

Namespace

Plenty\Modules\Item\SalesPrice\Contracts

Methods

public search(SalesPriceSearchRequest
 $request):SalesPriceSearchResponse

Parameters

SalesPriceSearchRequest

$request

public searchAll(SalesPriceSearchRequest
 $request):array

Parameters

SalesPriceSearchRequest

$request

Models

SalesPrice

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties

Type	Name	Description
int	id	The unique ID of the sales price
int	position	The position of the sales price
float	minimumOrderQuantity	The minimum order quantity of the sales price. Sales prices with different minimum quantities can be used to create a quantity based graduation of prices in plentymarkets.
string	type	The price type of the sales price. RRP = Sales price is the recommended retail price (RRP). If the RRP and another sales price are linked with a variation, the RRP will be displayed in the online store as red strike-through text next to the sales price. Special offer = Sales price as a special offer. Special offers are used for markets, e.g. Amazon and Hitmeister.
bool	isCustomerPrice	Flag that indicates if the sales price is a customer price. Currently, this setting is not in use.
bool	isDisplayedByDefault	Flag that indicates if the sales price is displayed automatically in the Sales Prices area of the plentymarkets backend when a new item is created. When false, the sales price can still be added manually when a new item is created.
bool	isLiveConversion	Flag that indicates if the sales price is converted live in the online store. When true, the default currency price will be converted into the active currencies based on the conversion rates saved in plentymarkets.
string	interval	The interval of the price. Possible values are: daily, weekly, monthly, quarterly, semi-annual and annual.
string	createdAt	The time the sales price was created.
string	updatedAt	The time the sales price was last updated.
array	names	names
array	accounts	accounts
array	countries	countries
array	currencies	currencies
array	customerClasses	customerClasses
array	referrers	referrer
array	clients	clients

Methods

public toArray()

Returns this model as an array.

SalesPriceAccount

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties

Type	Name	Description
int	salesPriceId	The unique ID of the sales price
int	referrerId	The ID of the referrer linked to the sales price
int	accountId	The ID of the referrer account linked to the sales price
string	createdAt	The time the referrer account was linked to the sales price.
string	updatedAt	The time the link was last updated.

Methods

public toArray()

Returns this model as an array.

SalesPriceCountry

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties

Type	Name	Description
int	salesPriceId	The unique ID of the sales price
int	countryId	The unique ID of the country
string	createdAt	The time the country was activated.
string	updatedAt	The time the relationship between country and sales price was last updated.

Methods

public toArray()

Returns this model as an array.

SalesPriceCurrency

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties

Type	Name	Description
int	salesPriceId	The unique ID of the sales price
string	currency	The ISO code of the currency; -1 = all currencies.
string	createdAt	The time the currency was activated.
string	updatedAt	The time the relationship between currency and sales price was last updated.

Methods

public toArray()

Returns this model as an array.

SalesPriceCustomerClass

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties

Type	Name	Description
int	salesPriceId	The unique ID of the sales price
int	customerClassId	The unique ID of the customer class
string	createdAt	The time the customer class was activated.
string	updatedAt	The time the relationship between customer class and sales price was last updated.

Methods

public toArray()

Returns this model as an array.

SalesPriceName

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties

Type	Name	Description
int	salesPriceId	The unique ID of the sales price
string	lang	The language code of the sales price name
string	nameInternal	The internal name of the sales price. The internal name is used in the plentymarkets back end only.
string	nameExternal	The external name of the sales price. The external name is displayed in the online store and as such is visible for customers.
string	createdAt	The time the name was created.
string	updatedAt	The time the name was last updated.

Methods

public toArray()

Returns this model as an array.

SalesPriceOnlineStore

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties

Type	Name	Description
int	salesPriceId	The unique ID of the sales price
int	plentyId	The unique ID of the client (store)
string	createdAt	The time the client (store) was activated.
string	updatedAt	The time the relationship between the client (store) and the sales price was last updated.

Methods

public toArray()

Returns this model as an array.

SalesPriceReferrer

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties

Type	Name	Description
int	salesPriceId	The unique ID of the sales price
float	referrerId	The unique ID of the referrer
string	createdAt	The time the referrer was activated.
string	updatedAt	The time the relationship between referrer and sales price was last updated.

Methods

public toArray()

Returns this model as an array.

SalesPriceSearchRequest

SalesPriceSearchRequest DataModel

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties

Type	Name	Description
int	variationId
string	type
int	plentyId
int	customerClassId
int	countryId
string	currency
int	accountId
string	accountType
int	referrerId
int	quantity
bool	ignoreType
int	vatId
string	customsTariffNumber

Methods

public toArray()

Returns this model as an array.

SalesPriceSearchResponse

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties

Type	Name	Description
int	salesPriceId
float	price
float	priceNet
float	basePrice
float	basePriceNet
float	unitPrice
float	unitPriceNet
float	customerClassDiscountPercent
float	customerClassDiscount
float	customerClassDiscountNet
float	categoryDiscountPercent
float	categoryDiscount
float	categoryDiscountNet
int	vatId
float	vatValue
string	currency
string	interval
float	conversionFactor
float	minimumOrderQuantity
string	updatedAt
string	type

Methods

public toArray()

Returns this model as an array.

Search

Aggregations

AttributeValueListAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getName():string

public getField():string

public getSize():int

public getAggregation():array

public getPath():string

public process(array $data):array

Parameters

$data

public toArray():array

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

AttributeValueListAggregationProcessor

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public process(array $data):array

Parameters

$data

public getName():string

public getDependencies():array

public addMutator(MutatorInterface
 $mutator):Processor

Parameters

$mutator

public addCondition(ConditionInterface
 $conditions):Processor

Parameters

$conditions

AvailabilityAggregation

aggregation for item availabilities

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getName():string

public getField():string

public getAggregation():array

public setInclude(string $string):void

Parameters

$string

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

AvailabilityAggregationProcessor

aggregation processor for item availabilities

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public process(array $data):array

Parameters

$data

public getName():void

public getDependencies():array

public addMutator(MutatorInterface
 $mutator):Processor

Parameters

$mutator

public addCondition(ConditionInterface
 $conditions):Processor

Parameters

$conditions

CardinalityAggregationBase

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getName():string

public getAggregation():array

public getField():string

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

CategoryAllTermsAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getName():string

public getField():void

public setSize($size = 10):void

Parameters

$size

public getAggregation():array

public setInclude(string $string):void

Parameters

$string

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

CategoryBranchTermsAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getName():string

public getField():void

public getAggregation():array

public setInclude(string $string):void

Parameters

$string

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

CategoryProcessor

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public process(array $data):array

Parameters

$data

public getDependencies():array

public addMutator(MutatorInterface
 $mutator):Processor

Parameters

$mutator

public addCondition(ConditionInterface
 $conditions):Processor

Parameters

$conditions

FacetAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getName():string

public getField():string

public getSize():int

public getAggregation():array

public getPath():string

public process(array $data):array

Parameters

$data

public toArray():array

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

FacetAggregationProcessor

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public process(array $data):array

Parameters

$data

public getName():string

public getDependencies():array

public addMutator(MutatorInterface
 $mutator):Processor

Parameters

$mutator

public addCondition(ConditionInterface
 $conditions):Processor

Parameters

$conditions

FacetFacetTermsAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getName():string

public getField():void

public getAggregation():array

public setInclude(string $string):void

Parameters

$string

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

FacetFacetValuesTermsAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getName():string

public getField():void

public getAggregation():array

public setInclude(string $string):void

Parameters

$string

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

FacetFilterAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public setFacetId(int $facetId):void

Parameters

$facetId

public getName():string

public getAggregation():array

public addFilter(TypeInterface
 $filter):void

Parameters

TypeInterface

$filter

public setIndex($index):void

Parameters

$index

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

FacetTermsAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public setFacetId(int $facetId):void

Parameters

$facetId

public getName():string

public getField():void

public getAggregation():array

public setInclude(string $string):void

Parameters

$string

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

FeedbackAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getName():string

public getField():string

public getRanges():void

public getAggregation():void

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

FeedbackAggregationProcessor

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public process(array $data):array

Parameters

$data

public getName():string

public getDependencies():array

public addMutator(MutatorInterface
 $mutator):Processor

Parameters

$mutator

public addCondition(ConditionInterface
 $conditions):Processor

Parameters

$conditions

ItemAttributeValueCardinalityAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getField():void

public getName():string

public getAggregation():array

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

ItemAttributeValueCardinalityAggregationProcessor

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public process($data):void

Parameters

$data

public getDependencies():array

public addMutator(MutatorInterface
 $mutator):Processor

Parameters

$mutator

public addCondition(ConditionInterface
 $conditions):Processor

Parameters

$conditions

ItemCardinalityAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getField():void

public getName():string

public getAggregation():array

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

ItemCardinalityAggregationProcessor

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public process($data):void

Parameters

$data

public getDependencies():array

public addMutator(MutatorInterface
 $mutator):Processor

Parameters

$mutator

public addCondition(ConditionInterface
 $conditions):Processor

Parameters

$conditions

OptimizedAttributeValueListAggregationProcessor

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public process(array $data):array

Parameters

$data

public getName():string

public getDependencies():array

public addMutator(MutatorInterface
 $mutator):Processor

Parameters

$mutator

public addCondition(ConditionInterface
 $conditions):Processor

Parameters

$conditions

PriceFacetFilterAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public setFacetId(int $facetId):void

Parameters

$facetId

public getName():string

public getAggregation():array

public addFilter(TypeInterface
 $filter):void

Parameters

TypeInterface

$filter

public setIndex($index):void

Parameters

$index

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

PriceRangeAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getField():void

public getName():void

public getAggregation():void

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

PriceRangeAggregationProcessor

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public process(array $data):array

Parameters

$data

public getName():string

public getDependencies():array

public addMutator(MutatorInterface
 $mutator):Processor

Parameters

$mutator

public addCondition(ConditionInterface
 $conditions):Processor

Parameters

$conditions

VariationAttributeValueListAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getName():string

public getField():string

public getSize():int

public getAggregation():array

public setSorting(SortingInterface
 $sorting):void

Parameters

SortingInterface

$sorting

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

VariationAttributeValueListAggregationProcessor

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public process(array $data):array

Parameters

$data

public getName():string

public getDependencies():array

public addMutator(MutatorInterface
 $mutator):Processor

Parameters

$mutator

public addCondition(ConditionInterface
 $conditions):Processor

Parameters

$conditions

VariationCardinalityAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods

public getField():void

public getName():string

public getAggregation():array

public toArray():array

public process(array $data):array

Parameters

$data

public addAggregation(AggregationInterface
 $aggregation):void

Parameters

$aggregation

public addSource(SourceInterface
 $source):AggregationInterface

Parameters

$source

public setPage(int $page, int $rowsPerPage):AggregationInterface

Parameters

int	$page
int	$rowsPerPage

public getSources():void

Contracts

VariationElasticSearchAvailibilityRepositoryContract

Namespace

Plenty\Modules\Item\Search\Contracts

Methods

public isReady():bool

public isAvailable():bool

VariationElasticSearchMultiSearchRepositoryContract

kommt noch

Namespace

Plenty\Modules\Item\Search\Contracts

Methods

public setIndex(IndexInterface
 $index):ElasticSearchMultiSearchRepositoryContract

Parameters

IndexInterface

$index

public addSearch($search):ElasticSearchMultiSearchRepositoryContract

Parameters

$search

public execute():array

VariationElasticSearchScrollRepositoryContract

kommt noch

Namespace

Plenty\Modules\Item\Search\Contracts

Methods

public hasNext():bool

public setNumberOfDocumentsPerShard(int $size):void

Parameters

$size

public setIndex(IndexInterface
 $index):ElasticSearchSearchRepositoryContract

Parameters

IndexInterface

$index

public addSearch($search):ElasticSearchSearchRepositoryContract

Parameters

$search

public execute():array

VariationElasticSearchSearchRepositoryContract

kommt noch

Namespace

Plenty\Modules\Item\Search\Contracts

Methods

public execute():array

public setIndex(IndexInterface
 $index):ElasticSearchSearchRepositoryContract

Parameters

IndexInterface

$index

public addSearch($search):ElasticSearchSearchRepositoryContract

Parameters

$search

VariationElasticSearchSettingsRepositoryContract

Read and update search settings

Namespace

Plenty\Modules\Item\Search\Contracts

Methods

public getLanguages():LanguageSettings

Get language settings

public saveLanguages(array $data):LanguageSettings

Update language settings

Parameters

$data

public getSearchSettings():SearchSettings

Get search settings

public saveSearchSettings(array $data):SearchSettings

Update search settings

Parameters

$data

public getSuggestSettings():SuggestSettings

public saveSuggestSettings(array $data):SuggestSettings

Parameters

$data

Filter

AttributeFilter

Filters the index by specific attributes or attribute values

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public hasAttribute(int $attributeId):void

Parameters

$attributeId

public hasAnyAttribute(array $attributeIds):void

Parameters

$attributeIds

public hasAllAttributes(array $attributeIds):void

Parameters

$attributeIds

public hasAttributeValue(int $attributeValueId):void

Parameters

$attributeValueId

public hasAnyAttributeValue(array $attributeValueIds):void

Parameters

$attributeValueIds

public hasAllAttributeValues(array $attributeValueIds):void

Parameters

$attributeValueIds

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

BarcodeFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public getPath():string

public hasCode($code, string $precision):void

Parameters

	$code
string	$precision

public hasType(string $type):void

Parameters

$type

public hasId(int $id):void

Parameters

$id

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

CategoryFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public isInAtLeastOneCategory(array $categoryIds, string $depth = self::DEPTH_ANY):void

Parameters

array	$categoryIds
string	$depth

public static getPathByDepth(string $depth):string

Parameters

$depth

public isInEachCategory(array $categoryIds, string $depth = self::DEPTH_ANY):void

Parameters

array	$categoryIds
string	$depth

public isInCategory(int $categoryId, string $depth = self::DEPTH_ANY):void

Parameters

int	$categoryId
string	$depth

public isInACategory():void

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

ClientFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public isVisibleForClient(int $clientId):void

Parameters

$clientId

public isVisibleForAtLeastOneClient(array $clientIds):void

Parameters

$clientIds

public isVisibleForAllClients(array $clientIds):void

Parameters

$clientIds

public hasAutomaticClientVisibility(array $values):void

-1, 0, 1, 2

Parameters

$values

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

CrossSellingFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public getPath():string

public hasRelation(string $relation):Filter

Parameters

$relation

public hasAnyRelation(array $relations):Filter

Parameters

$relations

public isDynamic():Filter

public isManual():Filter

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

FacetFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public hasAtLeastOneFacet(array $facetIds):void

Parameters

$facetIds

public hasEachFacet(array $facetIds):void

Parameters

$facetIds

public hasFacet(int $facetIds):void

Parameters

$facetIds

public hasAFacet():void

public hasAtLeastOneFacetValue(int $facetId, array $valueIds):void

Parameters

int	$facetId
array	$valueIds

public hasEachFacetValue(int $facetId, array $valueIds):void

Parameters

int	$facetId
array	$valueIds

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

FeedbackRangeFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public hasFeedbackGreaterThan(int $value):void

Parameters

$value

public getType():string

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

ImageFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public getPath():void

public hasMarketId(int $marketId):void

Parameters

$marketId

public setSection(string $section):void

Parameters

$section

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

ItemFilter

to bew written

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public hasId(int $id):void

Parameters

$id

public hasIds(array $ids):void

Parameters

$ids

public hasAnImage():void

public hasFlag1(int $flagId):void

Parameters

$flagId

public hasFlag2(int $flagId):void

Parameters

$flagId

public hasManufacturer(int $manufacturerId):void

Parameters

$manufacturerId

public hasManufacturers(array $manufacturerIds):void

Parameters

$manufacturerIds

public hasAManufacturer():void

public isItemType(string $itemType):void

Parameters

$itemType

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

MarketFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public isVisibleForMarket(int $marketId):void

Parameters

$marketId

public isVisibleForAtLeastOneMarket(array $marketIds):void

Parameters

$marketIds

public isVisibleForAllMarkets(array $marketIds):void

Parameters

$marketIds

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

PriceFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

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

Parameters

float	$min
float	$max

public betweenByClient(float $min = null, float $max = null, int $clientId = null):void

Parameters

float	$min
float	$max
int	$clientId

public getType():string

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

PropertyFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public getPath():void

public hasAtLeastOneProperty(array $ids):Filter

Parameters

$ids

public hasEachProperty(array $ids):Filter

Parameters

$ids

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

SalesPriceFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public hasAtLeastOnePrice(array $priceIds):void

Parameters

$priceIds

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

SearchFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public setNamesString(string $string, string $lang):void

Parameters

string	$string
string	$lang

public setSearchString(string $value, string $lang, string $precision = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SEARCH_TYPE_EXACT, string $operator = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::OR_OPERATOR):void

Parameters

string	$value
string	$lang
string	$precision
string	$operator

public setVariationNumber(string $value):void

Parameters

$value

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

SkuFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public getPath():void

public hasMarketId(float $marketId):void

Parameters

float

$marketId

public hasAccountId(int $accountId):void

Parameters

$accountId

public hasStatus(string $status):void

Parameters

$status

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

TagFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public hasTag(int $tagId):void

Parameters

$tagId

public hasAnyTag(array $tagIds):void

Parameters

$tagIds

public hasAllTags(array $tagIds):void

Parameters

$tagIds

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

TextFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public hasAnyName():void

public hasNameInLanguage(string $lang = self::LANG_DE, string $filter = self::FILTER_ANY_NAME):void

Parameters

string	$lang
string	$filter

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

public static isLanguageSupported(string $lang):bool

Parameters

$lang

public static isLanguageActivated(string $lang):bool

Parameters

$lang

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

Parameters

string	$lang
string	$fallback

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

Parameters

string	$lang
string	$fallback

VariationAvailabilityUpdatedAtFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public getTimestamp():void

public getType():string

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

VariationBaseFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public hasNumber(string $number, string $precision):void

Parameters

string	$number
string	$precision

public isActive():void

public isInactive():void

public hasId(int $id):void

Parameters

$id

public hasIds(array $ids):void

Parameters

$ids

public hasItemId(int $itemId):void

Parameters

$itemId

public hasItemIds(array $itemIds):void

Parameters

$itemIds

public isMain():void

public isChild():void

public isSalable(bool $bool = true):void

Parameters

$bool

public isSalableAndActive(bool $bool = true):void

Parameters

$bool

public isHiddenInCategoryList($bool = true):void

Parameters

$bool

public hasADescriptionInLanguage(string $language):void

Parameters

$language

public hasAnImageOrItemHasAnImage():void

public hasAnImage():void

public hasManufacturer(int $manufacturerId):void

Parameters

$manufacturerId

public hasSupplier(int $supplierId):void

Parameters

$supplierId

public hasAtLeastOneAvailability(array $availabilities):void

Parameters

$availabilities

public hasActiveChildren(bool $bool = true):void

Parameters

$bool

public hasChildren(bool $bool = true):void

Parameters

$bool

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

VariationBundleFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public hasBundleType(string $bundleType):void

Parameters

$bundleType

public hasNoBundleType():void

use if value is "null"

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

VariationLastUpdatedFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public getTimestamp():void

public getType():string

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

VariationPropertyFilter

foo

Namespace

Plenty\Modules\Item\Search\Filter

Methods

public hasPropertySelection(int $id):void

Parameters

$id

public hasAtLeastOnePropertySelection(array $ids):void

Parameters

$ids

public hasEachPropertySelection(array $ids):void

Parameters

$ids

public toArray():array

public addStatement(StatementInterface
 $statement):void

Parameters

$statement

public addQuery($statement):void

Parameters

$statement

Helper

SearchHelper

To be written

Namespace

Plenty\Modules\Item\Search\Helper

Methods

public getFacetSearch():DocumentSearch

public getFacetFilter():FacetFilter

public getSearchQuery(string $query):SearchQuery

Parameters

$query

Models

LanguageSettings

The language settings model

Namespace

Plenty\Modules\Item\Search\Models

Properties

Type	Name	Description
array	languages

Methods

public toArray()

Returns this model as an array.

SearchSettings

The search settings model

Namespace

Plenty\Modules\Item\Search\Models

Properties

Type	Name	Description
array	fields

Methods

public toArray()

Returns this model as an array.

SuggestSettings

The suggest settings model

Namespace

Plenty\Modules\Item\Search\Models

Properties

Type	Name	Description
array	fields

Methods

public toArray()

Returns this model as an array.

Mutators

BarcodeMutator

Namespace

Plenty\Modules\Item\Search\Mutators

Methods

public getPath():string

public mutateObject(array $data):array

Parameters

$data

public addMarket(int $marketId):Mutators

Parameters

$marketId

public getDependencies():array

public mutate(array $data):array

Parameters

$data

DefaultCategoryMutator

Namespace

Plenty\Modules\Item\Search\Mutators

Methods

public getPath():string

public mutateRow(array $data, $key):array

Parameters

array	$data
	$key

public setPlentyId(int $plentyId):DefaultCategoryMutator

Parameters

$plentyId

public getDependencies():array

public mutate(array $data):array

Parameters

$data

FacetMutator

Namespace

Plenty\Modules\Item\Search\Mutators

Methods

public mutate(array $data):array

Parameters

$data

public static facetSort(array $a, array $b):int

Parameters

array	$a
array	$b

public getDependencies():array

ImageDomainMutator

Converts image domains to client specific image domains.

Namespace

Plenty\Modules\Item\Search\Mutators

Methods

public getPath():string

public mutateObject(array $data):array

Parameters

$data

public setClient(int $plentyId):Mutators

Parameters

$plentyId

public mutate(array $data):array

Parameters

$data

public getDependencies():array

ImageMutator

To be written...

Namespace

Plenty\Modules\Item\Search\Mutators

Methods

public getPath():string

public setSorting(string $field):void

Parameters

$field

public setSections($sections):void

Parameters

$sections

public mutateObject(array $data):array

Parameters

$data

public addMarket(int $marketId):Mutators

Parameters

$marketId

public addClient(int $plentyId):Mutators

Parameters

$plentyId

public addListing(int $listingId):Mutators

Parameters

$listingId

public getDependencies():array

public mutate(array $data):array

Parameters

$data

KeyMutator

Namespace

Plenty\Modules\Item\Search\Mutators

Methods

public getKeyList():array

public setKeyList($keyList):void

Parameters

$keyList

public getNestedKeyList():void

public setNestedKeyList($nestedKeyList):void

Parameters

$nestedKeyList

public mutate(array $data):array

Parameters

$data

public getDependencies():array

SkuMutator

Namespace

Plenty\Modules\Item\Search\Mutators

Methods

public getPath():string

public mutateObject(array $data):array

Parameters

$data

public setMarket(int $marketId):Mutators

Parameters

$marketId

public setAccount(int $accountId):Mutators

Parameters

$accountId

public getDependencies():array

public mutate(array $data):array

Parameters

$data

VariationPropertyGroupMutator

To be written...

Namespace

Plenty\Modules\Item\Search\Mutators

Methods

public mutate(array $data):array

Parameters

$data

public getDependencies():void

VariationPropertyMutator

To be written...

Namespace

Plenty\Modules\Item\Search\Mutators

Methods

public mutate(array $data):array

Parameters

$data

public getDependencies():void

Query

SearchQuery

foo

Namespace

Plenty\Modules\Item\Search\Query

Methods

public addBarcode(int $boost):void

Parameters

$boost

public addNumericField(string $field, int $boost):void

Parameters

string	$field
int	$boost

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

Parameters

string	$field
string	$language
int	$boost

public addField(string $field, int $boost):void

Parameters

string	$field
int	$boost

public toArray():array

public setType(string $type):void

Parameters

$type

public setOperator(string $operator):MultiMatchQuery

Parameters

$operator

public setFuzzy(bool $fuzzy):MultiMatchQuery

Parameters

$fuzzy

public static isLanguageSupported(string $lang):bool

Parameters

$lang

public static isLanguageActivated(string $lang):bool

Parameters

$lang

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

Parameters

string	$lang
string	$fallback

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

Parameters

string	$lang
string	$fallback

Repositories

VariationElasticSearchAvailibilityRepository

Namespace

Plenty\Modules\Item\Search\Repositories

Methods

public isReady():bool

public isAvailable():bool

Sort

NameSorting

To be written

Namespace

Plenty\Modules\Item\Search\Sort

Methods

public toArray():array

public static isLanguageSupported(string $lang):bool

Parameters

$lang

public static isLanguageActivated(string $lang):bool

Parameters

$lang

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

Parameters

string	$lang
string	$fallback

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

Parameters

string	$lang
string	$fallback

Suggestions

SearchSuggestion

foo

Namespace

Plenty\Modules\Item\Search\Suggestions

Methods

public setLanguage(string $language):Suggestions

Parameters

$language

public getName():void

public getField():void

public toArray():array

public process(array $data):array

Parameters

$data

public setText(string $text):Suggestion

Parameters

$text

SearchSuggestionProcessor

to be written

Namespace

Plenty\Modules\Item\Search\Suggestions

Methods

public process(array $data):array

Parameters

$data

public getDependencies():array

public addMutator(MutatorInterface
 $mutator):Processor

Parameters

$mutator

public addCondition(ConditionInterface
 $conditions):Processor

Parameters

$conditions

Stock

Events

BasketItemWarnOversell

The event is triggered to warn about an overselling.

Namespace

Plenty\Modules\Item\Stock\Events

Methods

public getBasketItem():BasketItem

public getQuantity():int

Hooks

CheckItemStock

Namespace

Plenty\Modules\Item\Stock\Hooks

Methods

public handle(BasketItemEvent
 $basketItemEvent):void

Parameters

BasketItemEvent

$basketItemEvent

Unit

Contracts

UnitNameRepositoryContract

The contract for the unit name repository

Namespace

Plenty\Modules\Item\Unit\Contracts

Methods

public create(array $data, int $unitId):UnitName

Creates a unit name. The ID of the unit must be specified.

Parameters

array	$data	The unit name data as an associative array
int	$unitId	The ID of the unit

public delete(int $unitId, string $lang):DeleteResponse

Deletes a unit name. The ID of the unit and the language must be specified.

Parameters

int	$unitId	The ID of the unit
string	$lang	The lang of the unit name

public update(array $data, int $unitId, string $lang):UnitName

Updates a unit name. The ID of the unit and the language must be specified.

Parameters

array	$data	The unit name data as an associative array
int	$unitId	The ID of the unit
string	$lang	The language of the unit name

public findOne(int $unitId, string $lang):UnitName

Gets a unit name. The ID of the unit and the language must be specified.

Parameters

int	$unitId	The ID of the unit
string	$lang	The language of the unit name

public findByUnitId(int $unitId):array

Lists unit names. The ID of the unit must be specified.

Parameters

$unitId

The ID of the unit

UnitRepositoryContract

The contract for the unit repository

Namespace

Plenty\Modules\Item\Unit\Contracts

Methods

public create(array $data):Unit

Creates a unit.

Parameters

$data

The unit data as an associative array

public show(int $id):Unit

Gets a unit. The ID of the unit must be specified.

Parameters

$id

The ID of the unit

public update(array $data, int $id):Unit

Updates a unit. The ID of the unit must be specified.

Parameters

array	$data	The unit data as an associative array
int	$id	The ID of the unit

public delete(int $id):DeleteResponse

Deletes a unit. The ID of the unit must be specified.

Parameters

$id

The ID of the unit

public findById(int $id):Unit

Gets a unit. The ID of the unit must be specified.

Parameters

$id

The ID of the unit

public all(array $columns = [], int $perPage = 50, int $page = 1):PaginatedResult

Lists all units.

Parameters

array	$columns	An array of the shown columns. All columns are returned by default.
int	$perPage	The amount of units shown per page. Default value is 50.
int	$page	The shown page. Default value is 1.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Unit

The unit model including the unit name

Namespace

Plenty\Modules\Item\Unit\Models

Properties

Type	Name	Description
int	id	The unique ID of the unit
int	position	The position of the unit
string	unitOfMeasurement	The International System of Units (ISO) code of the unit
bool	isDecimalPlacesAllowed	Flag that indicates if decimal places are allowed for this unit of measurement. If false, only integer values are allowed for the unit.
string	updatedAt	The time the unit was last updated.
string	createdAt	The time the unit was created.
array	names

Methods

public toArray()

Returns this model as an array.

UnitName

The unit name model including the unit

Namespace

Plenty\Modules\Item\Unit\Models

Properties

Type	Name	Description
int	unitId	The unique ID of the unit
string	lang	The language of the unit name
string	name	The name of the unit
Unit	unit

Methods

public toArray()

Returns this model as an array.

UnitCombination

Contracts

UnitCombinationRepositoryContract

Interface for unit combination

Namespace

Plenty\Modules\Item\UnitCombination\Contracts

Methods

public all(int $itemsPerPage = 50, int $page = 1):PaginatedResult

Returns all unit combinations

Parameters

int	$itemsPerPage
int	$page

public get(int $id):UnitCombination

Returns the unit combination that matches the specified ID

Parameters

$id

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

UnitCombination

The unitCombination model

Namespace

Plenty\Modules\Item\UnitCombination\Models

Properties

Type	Name	Description
int	id	The id of the unitCombination
int	unitId	The id of the unit
int	content	The content of the unit
Unit	unit

Methods

public toArray()

Returns this model as an array.

Variation

Contracts

VariationExportServiceContract

Enhances the loading speed.

Namespace

Plenty\Modules\Item\Variation\Contracts

Methods

public addPreloadTypes(array $types):void

Parameters

$types

public preload(array $values, array $parameters = []):array

Parameters

array	$values
array	$parameters

public getData(string $dataType, int $variationId):void

Parameters

string	$dataType
int	$variationId

public getAll(int $variationId):void

Parameters

$variationId

public resetPreLoadedData():void

Resets the pre loaded data

public resetPreloadTypes():void

Resets the current pre load types

VariationImageServiceContract

Preload all variations linked to an image for several item IDs

Namespace

Plenty\Modules\Item\Variation\Contracts

Methods

public preload(array $values):array

Parameters

$values

public getData(int $itemId, int $imageId = null):void

Parameters

int	$itemId
int	$imageId

public resetPreLoadedData():void

public getAll():array

VariationInheritanceServiceContract

To be written...

Namespace

Plenty\Modules\Item\Variation\Contracts

Methods

public activate(Variation
 $variation, string $type):void

Parameters

Variation	$variation
string	$type

public deactivate(Variation
 $variation, string $type):void

Parameters

Variation	$variation
string	$type

VariationLookupRepositoryContract

lookup repository for variations

Namespace

Plenty\Modules\Item\Variation\Contracts

Methods

public hasBarcode(string $code, int $barcodeId = null):VariationLookupRepositoryContract

Parameters

string	$code
int	$barcodeId

public hasId(int $id):VariationLookupRepositoryContract

Parameters

$id

public hasItemId(int $itemId):VariationLookupRepositoryContract

Parameters

$itemId

public hasExternalId(string $externalId):VariationLookupRepositoryContract

Parameters

$externalId

public hasNumber(string $number):VariationLookupRepositoryContract

Parameters

$number

public hasSupplierItemNumber(string $supplierVariationNumber):VariationLookupRepositoryContract

Parameters

$supplierVariationNumber

public hasAttributeValueMap(array $attributeValueMap):VariationLookupRepositoryContract

Parameters

$attributeValueMap

public limit(int $limit):VariationLookupRepositoryContract

Parameters

$limit

public lookup():array

VariationMultiPackServiceContract

The contract for the variation bundle service

Namespace

Plenty\Modules\Item\Variation\Contracts

Methods

public createMultiPackBundle(int $variationId, int $componentId, int $quantity):void

Parameters

int	$variationId
int	$componentId
int	$quantity

public setMainVariationBundleItem(int $variationId):void

Parameters

$variationId

public updateMultiPackBundle(int $variationId, int $quantityId, int $quantity):void

Parameters

int	$variationId
int	$quantityId
int	$quantity

public getAttributeValueSetId(int $itemId):int

Parameters

$itemId

public matchUnit(int $itemId):int

Parameters

$itemId

public isMultiPack(int $itemId):bool

Parameters

$itemId

VariationRepositoryContract

The contract for the variation repository

Namespace

Plenty\Modules\Item\Variation\Contracts

Methods

public show(int $variationId, array $with, string $lang):Variation

Gets a variation. The ID of the variation must be specified.

Parameters

int	$variationId	The ID of the variation
array	$with
string	$lang

public showMultiple(array $ids, array $with):array

Parameters

array	$ids
array	$with

public create(array $data):Variation

Creates a variation.

Parameters

$data

The variation data as an associative array

public createPrimary(array $data):Variation

Creates a primary variation.

Parameters

$data

The variation data as an associative array

public delete(int $variationId):DeleteResponse

Deletes a variation. The ID of the variation must be specified.

Parameters

$variationId

The ID of the variation

public findById(int $variationId):Variation

Get a variation. The ID of the variation must be specified.

Parameters

$variationId

The ID of the variation

public update(array $data, int $variationId):Variation

Update a variation. The ID of the variation must be specified.

Parameters

array	$data
int	$variationId

public updateBulk(array $data):array

Updates up to 50 variations.

Parameters

$data

public changePrimaryVariation(int $variationId):Variation

Change main variation. Changes the variation with the specified variation ID to the new main variation.

Parameters

$variationId

public patchBulk(array $rows):Collection

Parameters

$rows

VariationSearchRepositoryContract

A repository for comfortable searches for variations

Namespace

Plenty\Modules\Item\Variation\Contracts

Methods

public setSearchFilter(int $name, array $params):void

Parameters

int	$name
array	$params

public setSearchParam(string $name, string $value):void

Parameters

string	$name
string	$value

public setSearchParams(array $params):void

Parameters

$params

public search():PaginatedResult

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Events

BeforeStatisticAccess

The event is triggered before a statics will be loaded

Namespace

Plenty\Modules\Item\Variation\Events

Methods

public isAccessAllowed():bool

public setAccessAllowed(bool $accessAllowed):BeforeStatisticAccess

Parameters

$accessAllowed

public getStatistic():string

public setStatistic(string $statistic):BeforeStatisticAccess

Parameters

$statistic

Exceptions

VariationException

Class VariationException

Namespace

Plenty\Modules\Item\Variation\Exceptions

Models

Variation

Namespace

Plenty\Modules\Item\Variation\Models

Properties

Type	Name	Description
int	id	The ID of the variation. The ID must be unique.
bool	isMain	Flag that indicates if the variation is the main variation of the item.
int	mainVariationId	The variation ID of the item's main variation. Value is NULL if this variation is the item's main variation.
int	itemId	The item ID of the item that this variation belongs to.
int	position	The position of the variation. Value is inherited from the item's main variation if inheritance is active.
bool	isActive	Flag that indicates if the variation is active. Only active variations can be offered in the online store and/or on markets.
string	number	The unique variation number of the variation. The variation number must be specified.
string	model	The model of the variation. Value is inherited from the item's main variation if inheritance is active.
string	externalId	The external variation ID of this variation. The external variation number is optional and allows importing items and variations from external systems to plentymarkets.
int	availability	The availability of the variation. Possible values: 1 to 10, null = Variation inherits value of main variation.
string	estimatedAvailableAt	The estimated delivery date of variations on reorder.
float	purchasePrice	The net purchase price. Value e.g. is used for price calculations.
float	movingAveragePrice	The moving average purchase price of the variation.
string	createdAt	The time the variation was created.
string	updatedAt	The time the variation was last updated.
string	relatedUpdatedAt	The time at which related information for this variation was last updated. Related information is defined as information that is linked to the variation, i.e. barcodes, categories, images, markets, clients (stores), prices, suppliers, warehouses and the default category.
string	availabilityUpdatedAt	The time at which the availability of this variation was last updated.
string	priceCalculationId	The ID of the price calculation linked to the variation. (deprecated)
string	priceCalculationUUID	The UUID of the price calculation linked to the variation.
string	picking	The order picking type of the variation. Possible values: single_picking, no_single_picking, exclude_from_picklist, null (no order picking type)
int	stockLimitation	The stock limitation for the variation. Possible values: 0 = No limitation, i.e. stock is not limited. The variations's availability is not checked automatically. 1 = Stock is limited to net stock. The variation's availability is checked automatically. 2 = Do not administer stock for this variation.
bool	isVisibleIfNetStockIsPositive	Flag that indicates if the variation is visible in the online store if net stock is positive. If true, the variation automatically becomes visible when the net stock changes to positive.
bool	isInvisibleIfNetStockIsNotPositive	Flag that indicates if the variation is invisible in the online store if net stock is not positive. If true, the variation automatically becomes invisible when the net stock changes to 0 or negative.
bool	isAvailableIfNetStockIsPositive	Flag that indicates if the variation is available in the online store if net stock is positive. If true, the variation automatically becomes available when the net stock changes to positive.
bool	isUnavailableIfNetStockIsNotPositive	Flag that indicates if the variation is unavailable in the online store if net stock is not positive. If true, the variation automatically becomes available when the net stock changes to 0 or negative.
bool	isVisibleInListIfNetStockIsPositive	Flag that indicates if the variation is visible in the item list of the online store if net stock is positive. If true, the variation automatically becomes visible in categories, search results and item lists (store specials, cross-selling, last seen items) when the net stock changes to positive.
bool	isInvisibleInListIfNetStockIsNotPositive	Flag that indicates if the variation is invisible in the item list of the online store if net stock is not positive. If true and no net stock is available for the variation, the variation can only be opened using the direct URL. The variation is not shown in the categories, search results or item lists (store specials, cross-selling, last seen items).
int	mainWarehouseId	The ID of the main warehouse of the variation.
float	maximumOrderQuantity	The maximum order quantity permitted per order. Decimal values are possible to allow orders by weight or length. Default value is 0. If value is 0, the maximum order quantity is unlimited.
float	minimumOrderQuantity	The minimum order quantity. Decimal values are possible to allow orders by weight or length.
float	intervalOrderQuantity	The quantity intervals the variation can be ordered in. Decimal values are possible to allow orders by weight or length.
string	availableUntil	The last date the item will be available for sale.
string	releasedAt	The release date of the variation. This is the date on which the variation will become available. The variation can be visible in the online store before this date, e.g. for preorders.
string	name	The name of the variation
int	unitCombinationId	The unit combination id of the variation
int	weightG	The gross weight of the variation in gramms (g). This weight includes the packaging for variations that are packaged separately. This value is used for calculating shipping packages and weight-based shipping costs.
int	weightNetG	The net weight of the variation in gramms (g). This is the weight of the variation without packaging.
int	widthMM	The width of the variation in millimetres (mm)
int	lengthMM	The length of the variation in millimeters (mm)
int	heightMM	The height of the variation in millimetres (mm)
float	extraShippingCharge1	The extra shipping charge 1 for the variation. Extra shipping charges are useful for large or bulky items that are particularly expensive to ship. Charge 1 is added to the regular shipping costs for the first item of an order. If different variations are ordered, the extra shipping charge 1 of the variation with the highest charge 1 is selected.
float	extraShippingCharge2	The extra shipping charge 2 for the variation. Extra shipping charges are useful for large or bulky items that are expensive to ship. Charge 2 is added to the shipping costs for any additional items of an order.
int	unitsContained	The number of sales units contained in one package. Default value is 1.
int	palletTypeId	The ID of the pallet type
int	packingUnits	The number of packing units if the item consists of multiple packages. Value is 0 if an item is sent as one package. All items of an order that have the value 0 will be packed into one package.
int	packingUnitTypeId	The ID of the packing unit type.
float	transportationCosts	The net transportation costs for the variation. This value is used for price calculations and for calculating the acquisition price.
float	storageCosts	The net storage costs for the variation
float	customs	The customs rate in percent
float	operatingCosts	The operating costs for the variation in percent
int	vatId	The ID of the VAT rate of the variation. VAT rates are created for each client (store) and linked to the variation.
string	bundleType	Indicates the bundle type of the variation. Possible values: bundle = The variation is a bundle bundle_item = The variation is a bundle component. Null = The variation is not associated with a bundle
int	automaticClientVisibility	Indicates if the variation is set as available for any clients (stores). Possible values: 0 / -1 (GET) or 0 (POST) = Variation is not available in any client (store). 1 / 2 (GET) or 1 (POST) = Variation is available in at least one client (store). The variation's actual visibility depends on the settings for net stock dependency.
int	automaticListVisibility	Indicates if the variation currently is visible in item lists. 3 = Variation is visible in item list because $isHiddenInCategoryList is false. 2, 1 = Variation is visible in item list because $isVisibleInListIfNetStockIsPositive is true and net stock is positive. 0, -1 = Variation is invisible in item list because $isInvisibleInListIfNetStockIsNotPositive is true and net stock is 0 or negative. -2 = Variation is invisible in item list because $isHiddenInCategoryList is true.
bool	isHiddenInCategoryList	Flag that indicates if the variation is hidden in the category list. If true, the variation will not be shown in any item category and will not be returned as a search result. The variation can only be accessed via its URL.
float	defaultShippingCosts	The default shipping costs for the variation.
bool	mayShowUnitPrice	Display unit price in the online store
int	salesRank	The sales rank of the variation. This ranking is used to position top items automatically if the option Automatically sort by monthly sales (Settings » Client (store) » Standard » Item layouts » Basic settings) is set to Yes. The sales ranking is calculated daily. If the option Automatically sort by monthly sales is set to No, a value of 0 is returned and variations are sorted by position instead.
int	parentVariationId
float	parentVariationQuantity
int	singleItemCount
string	customsTariffNumber	The customs tariff number of the variation; usually a 11 digit code number based on the Harmonised System
int	categoryVariationId	Either the ID of the variation or the ID of the item's main variation. No other values are permitted. ID of the variation = Categories are not inherited from the main variation. ID of the item's main variation = Inheritance of categories is active.
int	marketVariationId	Either the ID of the variation or the ID of the item's main variation. No other values are permitted. ID of the variation = Markets are not inherited from the main variation. ID of the item's main variation = Inheritance of markets is active.
int	clientVariationId	Either the ID of the variation or the ID of the item's main variation. No other values are permitted. ID of the variation = Clients (stores) are not inherited from the main variation. ID of the item's main variation = Inheritance of clients (stores) is active.
int	salesPriceVariationId	Either the ID of the variation or the ID of the item's main variation. No other values are permitted. ID of the variation = Sales prices are not inherited from the main variation. ID of the item's main variation = Inheritance of sales prices is active.
int	supplierVariationId	Either the ID of the variation or the ID of the item's main variation. No other values are permitted. ID of the variation = Suppliers are not inherited from the main variation. ID of the item's main variation = Inheritance of suppliers is active.
int	warehouseVariationId	Either the ID of the variation or the ID of the item's main variation. No other values are permitted. ID of the variation = Warehouses are not inherited from the main variation. ID of the item's main variation = Inheritance of warehouses is active.
int	propertyVariationId	Either the ID of the variation or the ID of the item's main variation. No other values are permitted. ID of the variation = Properties are not inherited from the main variation. ID of the item's main variation = Inheritance of properties is active.
int	tagVariationId	Either the ID of the variation or the ID of the item's main variation. No other values are permitted. ID of the variation = Tags are not inherited from the main variation. ID of the item's main variation = Inheritance of tags is active.
bool	hasCalculatedBundleWeight	Indicates if the gross bundle weight is calculated by its components.
bool	hasCalculatedBundleNetWeight	Indicates if the net bundle weight is calculated by its components.
bool	hasCalculatedBundlePurchasePrice	Indicates if the net purchase price is calculated by its components.
bool	hasCalculatedBundleMovingAveragePrice	Indicates if the moving average net purchase price is calculated by its components.
array	variationBarcodes	An array of the barcodes of the variation.
array	variationBundleComponents	An array of the bundle components of the variation.
array	variationComponentBundles	An array of the bundles that this variation is a component of.
array	variationProperties	An array of the properties of the variation.
array	properties	An array of the properties of the variation.
array	variationSalesPrices	An array of the sales prices of the variation.
array	marketItemNumbers	An array of the barcodes of the variation.
array	variationCategories	An array of the categories of the variation.
array	variationClients	An array of the clients (stores) of the variation.
array	variationMarkets	An array of the markets of the variation.
VariationDefaultCategory	variationDefaultCategory	An array of the default category of the variation.
array	variationSuppliers	An array of the suppliers of the variation.
array	itemTexts	An array of the texts of the variation.
array	variationTexts	An array of the texts of the variation.
array	variationWarehouses	An array of the warehouses of the variation.
array	tags	An array of the tags of the variation.
array	comments	An array of the comments of the variation.
array	images	An array of the images of the variation.
array	itemImages	An array of the images of the item linked to the variation.
array	itemCrossSelling	An array of the cross selling items of the item linked to the variation.
array	itemShippingProfiles	An array of the shipping profiles of the item linked to the variation.
array	variationAdditionalSkus	An array of additional SKUs of the variation.
array	variationSkus	An array of SKUs of the variation.
array	variationAttributeValues	An array of the attribute values of the variation.
UnitCombination	unit	The UnitCombination of the Variation. Object contains unitId and content.
Variation	parent	The details of the main variation of the variation if applicable.
Item	item
array	children
array	stockStorageLocations	An array of the stockStorageLocations of the variation.

Methods

public toArray()

Returns this model as an array.

Services

ExportPreloadValue

Namespace

Plenty\Modules\Item\Variation\Services\ExportPreloadValue

Properties

Type	Name	Description
int	itemId
int	variationId

Methods

public toArray()

Returns this model as an array.

VariationAdditionalSku

Contracts

VariationAdditionalSkuRepositoryContract

The contract of the variation additional sku repository

Namespace

Plenty\Modules\Item\VariationAdditionalSku\Contracts

Methods

public search(array $filter):array

Lists additional SKUs

Parameters

$filter

public get(int $id):VariationAdditionalSku

Gets an additional SKU

Parameters

$id

The unique ID of the additional SKU

public create(array $data):VariationAdditionalSku

Creates an additional SKU

Parameters

$data

public update(int $id, array $data):VariationAdditionalSku

Updates an additional SKU

Parameters

int	$id	The unique ID of the SKU
array	$data

public delete(int $id):DeleteResponse

Deletes an additional SKU

Parameters

$id

The unique ID of the additional SKU

Models

VariationAdditionalSku

The variation additional SKU model for order import

Namespace

Plenty\Modules\Item\VariationAdditionalSku\Models

Properties

Type	Name	Description
int	id	The ID of the additional sku
int	variationId	The ID of the variation.
float	marketId	The ID of the market reference.
int	marketAccountId	The ID of the market account.
string	sku	The additional sku for this variation.
string	createdAt	The time the SKU was created (YYYY-MM-DD HH:MM:SS).
string	updatedAt	The time the SKU was updated (YYYY-MM-DD HH:MM:SS).

Methods

public toArray()

Returns this model as an array.

VariationBarcode

Contracts

VariationBarcodeRepositoryContract

The contract of the variation barcode repository

Namespace

Plenty\Modules\Item\VariationBarcode\Contracts

Methods

public show(int $barcodeId, int $variationId):VariationBarcode

Gets a variation barcode. The ID of the variation and the ID of the barcode must be specified.

Parameters

int	$barcodeId	The unique ID of the barcode
int	$variationId	The unique ID of the variation

public create(array $data):VariationBarcode

Creates a variation barcode.

Parameters

$data

The variation barcode data as an associative array

public update(array $data, int $barcodeId, int $variationId):VariationBarcode

Updates a variation barcode. The ID of the variation and the ID of the barcode must be specified.

Parameters

array	$data	The variation barcode data as an associative array
int	$barcodeId	The unique ID of the barcode
int	$variationId	The unique ID of the variation

public delete(int $barcodeId, int $variationId):DeleteResponse

Deletes a variation barcode. The ID of the variation and the ID of the barcode must be specified.

Parameters

int	$barcodeId	The unique ID of the barcode
int	$variationId	The unique ID of the variation

public findByVariationId(int $variationId):array

Lists all barcodes of a variation. The ID of the variation must be specified.

Parameters

$variationId

The unique ID of the variation

Models

VariationBarcode

Variation Barcode

Namespace

Plenty\Modules\Item\VariationBarcode\Models

Properties

Type	Name	Description
string	code	The code of the variation's barcode. The combination of code and barcode ID must be unique.
int	barcodeId	The unique ID of the barcode linked to the variation. The combination of code and barcode ID must be unique.
int	variationId	The unique ID of the variation
string	createdAt	The time the variation's code was created.
Barcode	barcode	The barcode of the variation's barcode

Methods

public toArray()

Returns this model as an array.

VariationBundle

Contracts

InternalVariationBundleRepositoryContract

The contract for the variation bundle repository

Namespace

Plenty\Modules\Item\VariationBundle\Contracts

Methods

public show(int $bundleId):VariationBundle

Gets a variation bundle. The ID of the bundle must be specified.

Parameters

$bundleId

The ID of the bundle

public create(array $data):VariationBundle

Creates a variation bundle.

Parameters

$data

The variation bundle data as an associative array

public update(array $data, int $bundleId):VariationBundle

Updates a variation bundle. The ID of the bundle must be specified.

Parameters

array	$data	The variation bundle data as an associative array
int	$bundleId	The ID of the bundle

public delete(int $bundleId):DeleteResponse

Deletes a variation bundle component. The ID of the bundle must be specified.

Parameters

$bundleId

The ID of the bundle

public findByVariationId(int $variationId):VariationBundle

Lists variation bundles. The ID of the variation must be specified.

Parameters

$variationId

The ID of the variation

public findByComponentId(int $componentId):array

Lists variation bundles. The ID of the component variation must be specified.

Parameters

$componentId

The ID of the component variation

VariationBundleRepositoryContract

The contract for the variation bundle repository

Namespace

Plenty\Modules\Item\VariationBundle\Contracts

Methods

public show(int $bundleId):VariationBundle

Gets a variation bundle. The ID of the bundle must be specified.

Parameters

$bundleId

The ID of the bundle

public create(array $data):VariationBundle

Creates a variation bundle.

Parameters

$data

The variation bundle data as an associative array

public update(array $data, int $bundleId):VariationBundle

Updates a variation bundle. The ID of the bundle must be specified.

Parameters

array	$data	The variation bundle data as an associative array
int	$bundleId	The ID of the bundle

public delete(int $bundleId):DeleteResponse

Deletes a variation bundle component. The ID of the bundle must be specified.

Parameters

$bundleId

The ID of the bundle

public findByVariationId(int $variationId):VariationBundle

Lists variation bundles. The ID of the variation must be specified.

Parameters

$variationId

The ID of the variation

public findByComponentId(int $componentId):array

Lists variation bundles. The ID of the component variation must be specified.

Parameters

$componentId

The ID of the component variation

Models

VariationBundle

The variation bundle

Namespace

Plenty\Modules\Item\VariationBundle\Models

Properties

Type	Name	Description
int	id	The unique ID of the link that marks a variation as a bundle component
int	variationId	The unique ID of the variation to which other variations are added to create a bundle
int	componentVariationId	The unique ID of the variation added as bundle component
int	componentQuantity	The quantity of the variation to be added as bundle component
string	lastUpdatedTimestamp	The time the bundle was last updated.
string	createdAt	The time the bundle was created.

Methods

public toArray()

Returns this model as an array.

VariationCategory

Contracts

VariationCategoryRepositoryContract

The contract for the variation category repository

Namespace

Plenty\Modules\Item\VariationCategory\Contracts

Methods

public show(int $categoryId, int $variationId):VariationCategory

Gets the link between a category and a variation. The ID of the variation and the ID of the category must be specified.

Parameters

int	$categoryId	The ID of the category
int	$variationId	The ID of the variation

public create(array $data):VariationCategory

Creates a link between a category and a variation.

Parameters

$data

The variation category data as an associative array

public update(array $data, int $categoryId, int $variationId):VariationCategory

Updates a link between a category and a variation. The ID of the variation and the ID of the category must be specified.

Parameters

array	$data	The variation category data as an associative array
int	$categoryId	The ID of the category
int	$variationId	The ID of the variation

public delete(int $categoryId, int $variationId):DeleteResponse

Deletes the link between a category and a variation. The ID of the variation and the ID of the category must be specified.

Parameters

int	$categoryId	The ID of the category
int	$variationId	The ID of the variation

public findByVariationId(int $variationId):VariationCategory

Lists the categories linked to a variation. The ID of the variation must be specified.

Parameters

$variationId

The ID of the variation

public findByVariationIdWithInheritance(int $variationId):VariationCategory

Lists the categories linked to a variation including inheritance information. The ID of the variation must be specified.

Parameters

$variationId

public updateBulk(array $data):Collection

Updates up to 50 links between variations and categories. The ID of the variations and the ID of the categories must be specified.

Parameters

$data

The array containing the data.

public createBulk(array $data):Collection

Creates up to 50 links between variations and categories. The ID of the variations and the ID of the categories must be specified.

Parameters

$data

The array containing the data.

Models

VariationCategory

Variation Category

Namespace

Plenty\Modules\Item\VariationCategory\Models

Properties

Type	Name	Description
int	variationId	The unique ID of the variation
int	categoryId	The unique ID of the category
int	position	The position of the category
string	isNeckermannPrimary	Flag that indicates if the category is the primary category for the market Neckermann for this variation.

Methods

public toArray()

Returns this model as an array.

VariationClient

Contracts

VariationClientRepositoryContract

The contract of the variation client repository

Namespace

Plenty\Modules\Item\VariationClient\Contracts

Methods

public findOne(int $plentyId, int $variationId):VariationClient

Gets a client (store) linked to a variation. The ID of the variation and the client ID must be specified.

Parameters

int	$plentyId	The unique ID of the client (store)
int	$variationId	The unique ID of the variation

public create(array $data):VariationClient

Creates a link between a variation and a client (store).

Parameters

$data

The variation client data as an associative array

public delete(int $plentyId, int $variationId):DeleteResponse

Deletes the link between a variation and a client (store). The ID of the variation and the client ID must be specified.

Parameters

int	$plentyId	The unique ID of the client (store)
int	$variationId	The unique ID of the variation

public findByVariationId(int $variationId):VariationClient

Lists the clients (stores) linked to a variation. The ID of the variation must be specified.

Parameters

$variationId

The unique ID of the variation

public findByVariationIdWithInheritance(int $variationId):VariationClient

Lists the clients (stores) linked to a variation including inheritance information. The ID of the variation must be specified.

Parameters

$variationId

The unique ID of the variation

Models

VariationClient

Variation Client

Namespace

Plenty\Modules\Item\VariationClient\Models

Properties

Type	Name	Description
int	variationId	The unique ID of the variation
int	plentyId	The unique ID of the client (store)
string	createdAt	The time at which the client (store) was linked to the variation.

Methods

public toArray()

Returns this model as an array.

VariationDefaultCategory

Contracts

VariationDefaultCategoryRepositoryContract

The contract of the variation default category repository

Namespace

Plenty\Modules\Item\VariationDefaultCategory\Contracts

Methods

public show(int $plentyId, int $variationId):VariationDefaultCategory

Gets the default category of a variation for the client (store) specified. The ID of the variation and the plenty ID of the client (store) must be specified.

Parameters

int	$plentyId	The unique plenty ID of the client (store)
int	$variationId	The unique ID of the variation

public create(array $data):VariationDefaultCategory

Creates a link between a variation and a category that designates the category as the default category for this client (store).

Parameters

$data

The variation default category data as an associative array

public update(array $data, int $plentyId, int $variationId):VariationDefaultCategory

Updates the default category linked to a variation. The ID of the variation and the plenty ID of the client (store) must be specified.

Parameters

array	$data	The variation default category data as an associative array
int	$plentyId	The unique plenty ID of the client (store)
int	$variationId	The unique ID of the variation

public delete(int $plentyId, int $variationId):DeleteResponse

Deletes the link between a variation and a default category. The ID of the variation and the plenty ID of the client (store) must be specified.

Parameters

int	$plentyId	The unique plenty ID of the client (store)
int	$variationId	The unique ID of the variation

public findByVariationId(int $variationId):VariationDefaultCategory

Lists the default categories of a variation for all clients (stores). The ID of the variation must be specified.

Parameters

$variationId

The unique ID of the variation

Models

VariationDefaultCategory

Variation Default Category

Namespace

Plenty\Modules\Item\VariationDefaultCategory\Models

Properties

Type	Name	Description
int	variationId	The unique ID of the variation
int	branchId	The unique ID of the category branch
int	plentyId	The unique plenty ID of the client (store)
string	manually

Methods

public toArray()

Returns this model as an array.

VariationDescription

Contracts

VariationDescriptionRepositoryContract

The contract of the variation description repository

Namespace

Plenty\Modules\Item\VariationDescription\Contracts

Methods

public create(array $data):VariationDescription

Creates texts

Parameters

$data

The variation description data as an associative array

public update(array $data, int $variationId, string $lang):VariationDescription

Updates texts

Parameters

array	$data	The variation description data as an associative array
int	$variationId	The unique ID of the variation
string	$lang	The unique code of the language

public delete(int $variationId, string $lang):DeleteResponse

Deletes texts

Parameters

int	$variationId	The unique ID of the variation
string	$lang	The unique code of the language

public find(int $variationId, string $lang):VariationDescription

Gets texts

Parameters

int	$variationId	The unique ID of the variation
string	$lang	The unique code of the language

public findById(int $id):VariationDescription

Get texts

Parameters

$id

The unique ID of the item texts

public findByVariationId(int $variationId):array

List texts

Parameters

$variationId

The unique ID of the variation

Models

VariationDescription

Variation Default Category

Namespace

Plenty\Modules\Item\VariationDescription\Models

Properties

Type	Name	Description
int	id	The unique ID of the description
int	itemId	The unique ID of the item that this description belongs to
string	lang	The language code of the description
string	name	The default name of the item. By default, this name is displayed in the online store. For Default items, this name is also used for markets. Character limit: max. 240 characters.
string	name2	Alternative item name that can be used e.g. for markets. Character limit: max. 240 characters.
string	name3	Alternative item name that can be used e.g. for markets. Character limit: max. 240 characters.
string	previewDescription	The preview text. The preview text is a short description that can be displayed in item lists.
string	metaDescription	The meta description of the item. This description is analysed by search engines and displayed in search results. This text should be treated as an advertising text to maximise click-through from search engine result pages. Current recommended limit is 156 characters.
string	description	The item description. This is a detailed description displayed in the item layout of the online store.
string	technicalData	The technical data for the item. To display the technical data in the online store, insert the template variable TechnicalData and an optional title into the template ItemViewSingleItem.
string	urlPath	The URL path of the item in the online store. By default, the URL path consists of the categories and the item name. The path will be assigned automatically by plentymarkets when the item is created and will be displayed as part of the URL when the item is selected in the online store.
string	metaKeywords	Meta keywords to tag the item for search engines. More than one keyword can be separated by commas.

Methods

public toArray()

Returns this model as an array.

VariationImage

Contracts

VariationImageRepositoryContract

The contract of the variation image repository

Namespace

Plenty\Modules\Item\VariationImage\Contracts

Methods

public create(array $data):VariationImage

Creates link between image and variation

Parameters

$data

The variation image data as an associative array

public delete(int $variationId, int $imageId):DeleteResponse

Deletes Link between image and variation

Parameters

int	$variationId	The unique ID of the variation
int	$imageId	The unique ID of the image

public findByImageId(int $imageId):array

Lists variations linked to an image

Parameters

$imageId

The unique ID of the image

public findByVariationId(int $variationId):array

Lists images linked to a variation

Parameters

$variationId

The unique ID of the variation

public findByItemId(int $itemId):array

Lists all images linked to an item. The ID of the item must be specified.

Parameters

$itemId

The unique ID of the image

public findById(int $id):VariationImage

Gets an image link

Parameters

$id

The unique ID of the image link

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

VariationImage

Namespace

Plenty\Modules\Item\VariationImage\Models

Properties

Type	Name	Description
int	id	The unique ID of the link between a variation and an image
int	itemId	The unique ID of the item
int	variationId	The unique ID of the variation
int	imageId	The unique ID of the image
string	createdAt	The time the image was linked to the variation.
string	updatedAt	The time the link between an image and a variation was last updated.

Methods

public toArray()

Returns this model as an array.

VariationMarket

Contracts

VariationMarketRepositoryContract

The contract of the variation market repository

Namespace

Plenty\Modules\Item\VariationMarket\Contracts

Methods

public findOne(int $variationId, float $marketplaceId):VariationMarket

Gets the data of a market linked to a variation. The ID of the market and the ID of the variation must be specified.

Parameters

int	$variationId	The unique ID of the variation
float	$marketplaceId	The unique ID of the market

public create(array $data):VariationMarket

Creates a link between a market and a variation and adds market data.

Parameters

$data

The variation market data as an associative array

public delete(int $marketplaceId, float $variationId):DeleteResponse

Deletes the link between a market and a variation. The ID of the market and the ID of the variation must be specified.

Parameters

int	$marketplaceId	The unique ID of the market
float	$variationId	The unique ID of the variation

public findByVariationId(int $variationId):VariationMarket

Lists the markets linked to a variation. The ID of the variation must be specified.

Parameters

$variationId

The unique ID of the variation

public findByVariationIdWithInheritance(int $variationId):VariationMarket

Lists the markets linked to a variation with inheritance details. The ID of the variation must be specified.

Parameters

$variationId

The unique ID of the variation

public getVariationMarkets(int $itemsPerPage = 50, int $page = 1):PaginatedResult

Lists all links between variations and markets.

Parameters

int	$itemsPerPage
int	$page

public createBulk(array $data):void

Creates up to 50 links between variations and markets.

Parameters

$data

public deleteBulk(int $itemId, int $variationId):void

Deletes all market links of the variation specified.

Parameters

int	$itemId
int	$variationId

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

Models

VariationMarket

Variation Market

Namespace

Plenty\Modules\Item\VariationMarket\Models

Properties

Type	Name	Description
int	variationId	The unique ID of the variation
int	marketId	The unique ID of the market
string	createdAt	The time the link between the variation and the market was created.

Methods

public toArray()

Returns this model as an array.

VariationMarketIdentNumber

Contracts

VariationMarketIdentNumberRepositoryContract

The contract of the variation market ident number repository

Namespace

Plenty\Modules\Item\VariationMarketIdentNumber\Contracts

Methods

public show(int $variationMarketIdentNumberId):VariationMarketIdentNumber

Gets a market ident number (ASIN/ePID) of a variation. The ID of the market ident number must be specified.

Parameters

$variationMarketIdentNumberId

The unique ID of the market ident number

public create(array $data):VariationMarketIdentNumber

Creates a new market ident number (ASIN/ePID) for a variation.

Parameters

$data

The variation market ident number data as an associative array

public update(array $data, int $variationMarketIdentNumberId):VariationMarketIdentNumber

Updates a market ident number (ASIN/ePID) of a variation. The ID of the market ident number must be specified.

Parameters

array	$data	The variation market ident number data as an associative array
int	$variationMarketIdentNumberId	The unique ID of the market ident number

public delete(int $variationMarketIdentNumberId):DeleteResponse

Deletes a market ident number (ASIN/ePID) of a variation. The ID of the market ident number must be specified.

Parameters

$variationMarketIdentNumberId

The unique ID of the market ident number

public findByVariationId(int $variationId):array

Lists the market ident numbers (ASIN/ePID) of a variation. The ID of the variation must be specified.

Parameters

$variationId

The unique ID of the variation

Models

VariationMarketIdentNumber

Variation Market Ident Number

Namespace

Plenty\Modules\Item\VariationMarketIdentNumber\Models

Properties

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

Methods

public toArray()

Returns this model as an array.

VariationProperty

Contracts

VariationPropertyValueRepositoryContract

The contract of the variation property value repository

Namespace

Plenty\Modules\Item\VariationProperty\Contracts

Methods

public create(array $data):VariationPropertyValue

Creates a link between a property value and a variation and adds property value data.

Parameters

$data

The variation property value data as an associative array

public show(int $variationId, int $id):VariationPropertyValue

Gets the data of a property value linked to a variation. The ID of the variation property value and the variation ID must be specified.

Parameters

int	$variationId	The unique ID of the variation
int	$id	The unique ID of the link between a variation and a property value

public update(array $data, int $variationId, int $id):VariationPropertyValue

Updates the data of a variation property linked to a variation. The ID of the variation property value and the variation ID must be specified.

Parameters

array	$data	The variation property value data as an associative array
int	$variationId	The ID of the Variation
int	$id	The unique ID of the link between a property value and a variation

public delete(int $variationId, int $id):DeleteResponse

Deletes the link between a property value and a variation. The ID of the variation property value and the variation ID must be specified.

Parameters

int	$variationId	The ID of the variation
int	$id	The unique ID of the link between a variation and a property value

public deleteAll(int $variationId):DeleteResponse

Deletes all links between a variation and its property values. The ID of the variation must be specified.

Parameters

$variationId

The ID of the variation

public findByVariationId(int $variationId):array

Lists the property values linked to a variation. The ID of the variation must be specified.

Parameters

$variationId

The unique ID of the variation

public createBulk(array $data):Collection

Creates a list of variation properties.

Parameters

$data

The array containing the data.

public updateBulk(array $data):Collection

Updates a list of variation properties.

Parameters

$data

The array containing the data.

VariationPropertyValueTextRepositoryContract

The contract of the variation property value text repository

Namespace

Plenty\Modules\Item\VariationProperty\Contracts

Methods

public create(array $data):VariationPropertyValueText

Saves text for a specific property of the type Text in the specified language. The ID of the property value and the language must be specified.

Parameters

$data

public update(int $valueId, string $lang, array $data):VariationPropertyValueText

Updates the text saved for a specific property of the type Text in the specified language. The ID of the property value and the language must be specified.

Parameters

int	$valueId
string	$lang
array	$data

public delete(int $valueId, string $lang):DeleteResponse

Deletes the text saved for a specific property of the type Text in the specified language. The ID of the property value and the language must be specified.

Parameters

int	$valueId
string	$lang

public show(int $valueId, string $lang):VariationPropertyValueText

Gets the text saved for a specific property of the type Text in the specified language. The ID of the property value and the language must be specified.

Parameters

int	$valueId
string	$lang

public findByPropertyValue(int $valueId):void

Gets the texts saved for a specific property of the type Text in all available languages. The ID of the property value must be specified.

Parameters

$valueId

Models

VariationPropertyValue

The VariationPropertyValue

Namespace

Plenty\Modules\Item\VariationProperty\Models

Properties

Type	Name	Description
int	id	The unique ID of the link between the variation and the property value
int	variationId	The unique ID of the variation
int	propertyId	The unique ID of the property
int	propertySelectionId	The unique ID of the property selection of the variation
int	valueInt	The int value of the property value of the variation
float	valueFloat	The float value of the property value of the variation
string	valueFile	The file value of the property value of the variation
float	surcharge	The surcharge of the property value of the variation
array	names	Collection of the variationPropertyValueNames names that belong to this variationPropertyValue
Property	property
PropertySelection	propertySelection
array	valueTexts

Methods

public toArray()

Returns this model as an array.

VariationPropertyValueName

The property name of the variation

Namespace

Plenty\Modules\Item\VariationProperty\Models

Properties

Type	Name	Description
int	propertyValueId	The unique ID of the link between the variation and the property
string	lang	The language of the property value name.
string	value	The value of the property value name in the specified language

Methods

public toArray()

Returns this model as an array.

VariationPropertyValueText

The VariationPropertyValueText

Namespace

Plenty\Modules\Item\VariationProperty\Models

Properties

Type	Name	Description
int	valueId	The unique ID of the link between the variation and the property
string	lang	The language of the property value text
string	value	The text saved for the property of the type Text

Methods

public toArray()

Returns this model as an array.

VariationSalesPrice

Contracts

VariationSalesPriceRepositoryContract

The contract of the variation sales price repository

Namespace

Plenty\Modules\Item\VariationSalesPrice\Contracts

Methods

public show(int $salesPriceId, int $variationId):VariationSalesPrice

Gets the price data of a sales price linked to a variation. The ID of the sales price and the ID of the variation must be specified.

Parameters

int	$salesPriceId	The unique ID of the sales price
int	$variationId	The unique ID of the variation

public create(array $data):VariationSalesPrice

Creates a link between a sales price and a variation and adds sales price data.

Parameters

$data

The variation sales price data as an associative array

public update(array $data, int $salesPriceId, int $variationId):VariationSalesPrice

Updates the data of a sales price linked to a variation.

Parameters

array	$data	The variation sales price data as an associative array
int	$salesPriceId	The unique ID of the sales price
int	$variationId	The unique ID of the variation

public delete(int $salesPriceId, int $variationId):DeleteResponse

Deletes a link between a sales price and a variation and deletes the sales price data. The ID of the sales price and the ID of the variation must be specified. An exception is thrown if at least one relation exists.

Parameters

int	$salesPriceId	The unique ID of the sales price
int	$variationId	The unique ID of the variation

public deleteAll(int $variationId):DeleteResponse

Deletes all links between a variation and its sales prices and deletes the sales price data. The ID of the variation must be specified.

Parameters

$variationId

The ID of the variation

public findByVariationId(int $variationId):VariationSalesPrice

Lists the data of the sales prices linked to a variation. The ID of the variation must be specified.

Parameters

$variationId

The unique ID of the variation

public findByVariationIdWithInheritance(int $variationId):VariationSalesPrice

Lists the data of the sales prices linked to a variation with inheritance details. The ID of the variation must be specified.

Parameters

$variationId

The unique ID of the variation

public updateBulk(array $data):Collection

Updates a list of variation prices. The variation ID, sales price ID and a new price must be specified.

Parameters

$data

The array containing the data.

public createBulk(array $data):Collection

Creates a list of variation prices. The variation ID, sales price ID and a new price must be specified.

Parameters

$data

The array containing the data.

public findAll(int $itemsPerPage = 100, int $page = 1):PaginatedResult

Gets all sales price relations.

Parameters

int	$itemsPerPage
int	$page

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

Models

VariationSalesPrice

Namespace

Plenty\Modules\Item\VariationSalesPrice\Models

Properties

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

Methods

public toArray()

Returns this model as an array.

VariationSku

Contracts

VariationSkuBulkRepositoryContract

The contract of the variation SKU bulk repository.

Namespace

Plenty\Modules\Item\VariationSku\Contracts

Methods

public create(array $data):void

Creates multiple SKUs.

Parameters

$data

public updateStatus(array $ids, string $status):void

Updates status for multiple SKUs.

Parameters

array	$ids
string	$status

public updateExportedAt(array $ids, string $time = ""):void

Updates exportedAt for multiple SKUs.

Parameters

array	$ids
string	$time

public updateStockUpdatedAt(array $ids, string $time = ""):void

Updates stockUpdatedAt for multiple SKUs.

Parameters

array	$ids
string	$time

public delete(array $data):int

Deletes multiple SKUs.

Parameters

$data

VariationSkuRepositoryContract

The contract of the variation sku repository

Namespace

Plenty\Modules\Item\VariationSku\Contracts

Methods

public generateSkuWithParent(array $variation, float $marketId, int $accountId, string $sku = null, string $parentSku = null, bool $setLastExportedTimestamp = true, bool $returnObject = false):void

Generates or updates an SKU and parent SKU

Parameters

array	$variation	The array of values from the variation
float	$marketId	The unique ID of the market
int	$accountId	The unique ID of the account
string	$sku
string	$parentSku
bool	$setLastExportedTimestamp
bool	$returnObject

public generateSku(int $variationId, float $marketId, int $accountId, string $sku = null, bool $setLastExportedTimestamp = true, bool $returnObject = false):void

Generates or updates an SKU

Parameters

int	$variationId	The unique ID of the SKU
float	$marketId	The unique ID of the market
int	$accountId	The unique ID of the account
string	$sku
bool	$setLastExportedTimestamp
bool	$returnObject

public create(array $data):VariationSku

Creates an SKU

Parameters

$data

public update(array $data, int $skuId):VariationSku

Updates an SKU

Parameters

array	$data
int	$skuId	The unique ID of the SKU

public delete(int $skuId):DeleteResponse

Deletes an SKU

Parameters

$skuId

The unique ID of the SKU

public show(int $skuId):VariationSku

Gets an SKU

Parameters

$skuId

The unique ID of the SKU

public search(array $filter):array

Lists SKUs

Parameters

$filter

public findByVariationId(int $variationId):array

Lists SKUs

Parameters

$variationId

The unique ID of the variation

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

VariationSku

The variation SKU model

Namespace

Plenty\Modules\Item\VariationSku\Models

Properties

Type	Name	Description
int	id	The row ID of the table plenty_item_variation_market_status
int	variationId	The ID of the variation
float	marketId	The ID of the market
int	accountId	The ID of the market account
string	initialSku	The initial SKU of the variation. The initial SKU cannot be modified even if the variation SKU is changed. However, it is possible to reset the variation SKU to the initial SKU.
string	sku	The SKU of the variation. The SKU is adjustable but may not exist twice for the combination of market Id and account Id.
string	parentSku	The Parent SKU of the variation. The Parent SKU is adjustable. The same Parent SKU value should be used on variations of same article.
bool	isActive	Flag that indicates if the item is ready for export (currently not in use).
string	createdAt	The time the SKU was created (YYYY-MM-DD HH:MM:SS).
string	updatedAt	The time the SKU was updated (YYYY-MM-DD HH:MM:SS).
string	exportedAt	The time the variation was last exported (YYYY-MM-DD HH:MM:SS).
string	stockUpdatedAt
string	deletedAt	The time the variation was deleted (YYYY-MM-DD HH:MM:SS).
string	status	The status of the variation after the export. Possible entries are INACTIVE, ERROR, SENT and ACTIVE.
string	additionalInformation	The field that contains additional information.

Methods

public toArray()

Returns this model as an array.

VariationStock

Contracts

VariationStockRepositoryContract

The contract of the variation stock repository

Namespace

Plenty\Modules\Item\VariationStock\Contracts

Methods

public listStockByWarehouse(int $variationId, array $columns = [], int $page = 1, int $itemsPerPage = 200):array

List stock per warehouse

Parameters

int	$variationId	The ID of the variation
array	$columns	The properties to be loaded
int	$page	The requested page
int	$itemsPerPage	The number of items per page

public listStockMovements(int $variationId, array $columns, int $page, int $itemsPerPage):array

List stock movements for a variation

Parameters

int	$variationId	The ID of the variation
array	$columns	The properties to be loaded
int	$page	The requested page
int	$itemsPerPage	The number of items per page

public bookIncomingItems(int $variationId, array $data):array

Book incoming stock

Parameters

int	$variationId	The ID of the variation
array	$data	The request data

public bookOutgoingItems(int $variationId, array $data):array

Book outgoing stock

Parameters

int	$variationId	The ID of the variation
array	$data	The request data

public correctStock(int $variationId, array $data, bool $calcStockLater = false, bool $finishReceiptLater = false):array

Correct stock

Parameters

int	$variationId	The ID of the variation
array	$data	The request data
bool	$calcStockLater
bool	$finishReceiptLater

public redistributeStock(int $variationId, array $data):PaginatedResult

Redistribute stock

Parameters

int	$variationId	The ID of the variation
array	$data	The request data

public finishReceipt():void

Finish receipt

public setFilters(array $filters = []):void

Sets the filter array.

Parameters

$filters

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

VariationStock

The variation stock model

Namespace

Plenty\Modules\Item\VariationStock\Models

Properties

Type	Name	Description
int	itemId	The ID of the item
int	variationId	The ID of the variation
int	warehouseId	The ID of the warehouse
float	reservedListing	The quantity of a variation that is reserved for listings
float	reservedBundles	The quantity of a variation that is reserved for item bundles
float	valueOfGoods	The value of goods based on the physical stock
float	purchasePrice	The purchase price of the variation stock
float	physicalStock	The physical stock of the variation stock
float	reservedStock	The reserved stock of the variation stock
float	netStock	The net stock is the stock that can still be sold
float	reorderLevel	The quantity of a variation that triggers a reorder
float	deltaReorderLevel	The quantity of a variation that is required to reach the reorder level

Methods

public toArray()

Returns this model as an array.

VariationStockMovement

The variation stock movement model

Namespace

Plenty\Modules\Item\VariationStock\Models

Properties

Type	Name	Description
int	id	The ID of the stock movement
int	itemId	The ID of the item
int	variationId	The ID of the variation
int	warehouseId	The ID of the warehouse
string	reasonString	The reason string
string	attributeValues	The attribute values of a variation
int	processRowId	The ID is either the actual ID of an order or of an incoming item data set. Whether it is an order ID or an incoming item data set ID depends on the processRowType.
int	quantity	The quantity
int	reason	The reason for the movement
string	createdAt	The date and time that the movement was created. This date is in W3C format.
int	processRowType	The type of the stock movement 1 = incoming item data set 2 = order 3 = deleted stock movement 4 = new stock intake
string	bestBeforeDate	The best before date for the movement
string	batch	The batch for the movement
string	storageLocationName	The name of the storage location
string	warehouseName	The name of the warehouse
int	purchasePrice	The purchase price of a variation
int	userId	The id of the user. Can be null if the movement was not triggered by an user.

Methods

public toArray()

Returns this model as an array.

VariationSupplier

Contracts

VariationSupplierRepositoryContract

The contract for the variation supplier repository

Namespace

Plenty\Modules\Item\VariationSupplier\Contracts

Methods

public show(int $id):VariationSupplier

Gets the data of a supplier linked to a variation. The variation supplier ID must be specified.

Parameters

$id

The unique ID of the link between variation and supplier

public create(array $data):VariationSupplier

Creates a link between a supplier and a variation and adds supplier data.

Parameters

$data

The variation supplier data as an associative array

public update(array $data, int $id):VariationSupplier

Updates the data of a supplier linked to a variation. The variation supplier ID must be specified.

Parameters

array	$data	The variation supplier data as an associative array
int	$id	The unique ID of the link between variation and supplier

public delete(int $id):DeleteResponse

Deletes a link between a supplier and a variation. The variation supplier ID must be specified.

Parameters

$id

The unique ID of the link between variation and supplier

public findByVariationId(int $variationId):array

Lists the data of the suppliers linked to a variation. The ID of the variation must be specified.

Parameters

$variationId

The unique ID of the variation

public findByVariationIdWithInheritance(int $variationId):array

Lists the data of the suppliers linked to a variation with inheritance details. The ID of the variation must be specified.

Parameters

$variationId

The unique ID of the variation

Models

VariationSupplier

Variation Supplier

Namespace

Plenty\Modules\Item\VariationSupplier\Models

Properties

Type	Name	Description
int	id	The unique ID of the link between variation and supplier
int	variationId	The unique ID of the variation
int	supplierId	The unique ID of the supplier
float	purchasePrice	The price at which the variation was purchased from this supplier.
int	minimumPurchase	The minimum quantity of the variation that has to be ordered from the supplier. This value is also used as a quantity suggestion when creating reorders.
string	itemNumber	The external item number assigned to the variation by this supplier
string	lastPriceQuery	The date of the last price query to this supplier. This helps to plan price negotiations.
int	deliveryTimeInDays	The delivery time in days for the variation saved for this supplier
float	discount	The discount in percent the supplier grants for the variation.
string	isDiscountable	Flag that indicates if the supplier's discount for this variation is active.
float	packagingUnit	The packaging unit of the supplier if it differs from the packaging unit settings in plentymarkets.
string	lastUpdateTimestamp	The time the supplier data was last updated
string	createdAt	The time the supplier data was created
float	currencyPurchasePrice	The purchase price in the currency of the supplier
string	itemDescription	The supplier item description

Methods

public toArray()

Returns this model as an array.

VariationWarehouse

Contracts

VariationWarehouseRepositoryContract

The contract for the variation warehouse repository

Namespace

Plenty\Modules\Item\VariationWarehouse\Contracts

Methods

public show(int $variationId, int $warehouseId):VariationWarehouse

Gets the data of a warehouse linked to a variation. The ID of the variation and the ID of the warehouse must be specified.

Parameters

int	$variationId	The unique ID of the variation
int	$warehouseId	The unique ID of the warehouse

public create(array $data):VariationWarehouse

Creates a link between a warehouse and a variation and adds warehouse data.

Parameters

$data

The variation warehouse data as an associative array

public update(array $data, int $variationId, int $warehouseId):VariationWarehouse

Updates the data of a warehouse linked to a variation. The ID of the variation and the ID of the warehouse must be specified.

Parameters

array	$data	The variation warehouse data as an associative array
int	$variationId	The unique ID of the variation
int	$warehouseId	The unique ID of the warehouse

public delete(int $variationId, int $warehouseId):DeleteResponse

Deletes the link between a warehouse and a variation. The ID of the variation and the ID of the warehouse must be specified.

Parameters

int	$variationId	The unique ID of the variation
int	$warehouseId	The unique ID of the warehouse

public findByVariationId(int $variationId):array

Lists all warehouse data of a variation. The ID of the variation must be specified.

Parameters