Plentymarkets interface documentation

Attribute

Contracts

AttributeEbayCorrelationRepositoryContract

The contract for the attribute ebay correlation repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods
public create($data):Plenty\Modules\Item\Attribute\Models\AttributeEbayCorrelation
Return type: AttributeEbayCorrelation

Creates new ebay attribute correlation

Parameters

Name

Type

Description

$data

array

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

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

Parameters

Name

Type

Description

$id

int

The ID of the ebay attribute correlation

$with

array

public update($id, $data):Plenty\Modules\Item\Attribute\Models\AttributeEbayCorrelation
Return type: AttributeEbayCorrelation

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

Parameters

Name

Type

Description

$id

int

The ID of the ebay attribute correlation

$data

array

public delete($id):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$id

int

The ID of the ebay attribute correlation

public get($id):Plenty\Modules\Item\Attribute\Models\AttributeEbayCorrelation
Return type: AttributeEbayCorrelation

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

Parameters

Name

Type

Description

$id

int

The ID of the ebay attribute correlation

Return type: PaginatedResult

Lists ebay attribute correlations by filters.

Parameters

Name

Type

Description

$perPage

int

$page

int

$filters

array

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

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($data):Plenty\Modules\Item\Attribute\Models\AttributeMap
Return type: AttributeMap

Creates a new attribute map.

Parameters

Name

Type

Description

$data

array

public find($attributeId, $marketId):Plenty\Modules\Item\Attribute\Models\AttributeMap
Return type: AttributeMap

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

Parameters

Name

Type

Description

$attributeId

int

$marketId

float

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

Lists all attribute maps.

Parameters

Name

Type

Description

$columns

array

$perPage

int

$page

int

$filter

array

$with

array

public update($data, $attributeId, $marketId):Plenty\Modules\Item\Attribute\Models\AttributeMap
Return type: AttributeMap

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

Parameters

Name

Type

Description

$data

array

$attributeId

int

$marketId

float

public delete($attributeId, $marketId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$attributeId

int

$marketId

float

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

AttributeNameRepositoryContract

The contract for the attribute name repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods
public create($data, $attributeId):Plenty\Modules\Item\Attribute\Models\AttributeName
Return type: AttributeName

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

Parameters

Name

Type

Description

$data

array

The attribute name data as associative array

$attributeId

int

The ID of the attribute ID

public delete($attributeId, $lang):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$attributeId

int

The ID of the attribute

$lang

string

The lang of the attribute name

public update($data, $attributeId, $lang):Plenty\Modules\Item\Attribute\Models\AttributeName
Return type: AttributeName

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

Parameters

Name

Type

Description

$data

array

The attribute name data as associative array

$attributeId

int

The ID of the attribute

$lang

string

The lang of the attribute name

public findOne($attributeId, $lang):Plenty\Modules\Item\Attribute\Models\AttributeName
Return type: AttributeName

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

Parameters

Name

Type

Description

$attributeId

int

The ID of the attribute

$lang

string

The lang of the attribute name

public findByAttributeId($attributeId):Plenty\Modules\Item\Attribute\Models\AttributeName
Return type: AttributeName

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

Parameters

Name

Type

Description

$attributeId

int

The ID of the attribute

AttributeRepositoryContract

The contract for the attribute repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods
public create($data):Plenty\Modules\Item\Attribute\Models\Attribute
Return type: Attribute

Creates new attribute

Parameters

Name

Type

Description

$data

array

The attribute data as associative array

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

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

Parameters

Name

Type

Description

$id

int

The ID of the attribute

$with

array

An array of the with params

public update($data, $id):Plenty\Modules\Item\Attribute\Models\Attribute
Return type: Attribute

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

Parameters

Name

Type

Description

$data

array

The attribute data as associative array

$id

int

The ID of the attribute

public delete($id):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$id

int

The ID of the attribute

public findById($id):Plenty\Modules\Item\Attribute\Models\Attribute
Return type: Attribute

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

Parameters

Name

Type

Description

$id

int

The ID of the attribute

public findByBackendName($backendName):Plenty\Modules\Item\Attribute\Models\Attribute
Return type: Attribute

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

Parameters

Name

Type

Description

$backendName

string

public all($columns = [], $perPage = 50, $page = 1, $filter = [], $with = []):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult

Lists all attributes.

Parameters

Name

Type

Description

$columns

array

An array of the shown columns. All columns are returned by default.

$perPage

int

The attributes shown per page. Default value is 50.

$page

int

The shown page. Default value is 1.

$filter

array

$with

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.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

AttributeValueImageRepositoryContract

The contract for the attribute value image repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods
public getAttributeValueImage($itemId, $imageId, $valueId):Plenty\Modules\Item\Attribute\Models\AttributeValueImage
Return type: AttributeValueImage

Get an attribute value image link

Parameters

Name

Type

Description

$itemId

int

The unique ID of the item ID

$imageId

int

The unique ID of the image

$valueId

int

The unique ID of the attribute value

public create($data):Plenty\Modules\Item\Attribute\Models\AttributeValueImage
Return type: AttributeValueImage

Create an attribute value image link

Parameters

Name

Type

Description

$data

array

The attribute value image data as an associative array

public delete($itemId, $imageId, $valueId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

Delete an attribute value image link

Parameters

Name

Type

Description

$itemId

int

The ID of the item

$imageId

int

The ID of the image

$valueId

int

The ID of the attribute value

public update($data, $itemId, $imageId, $valueId):Plenty\Modules\Item\Attribute\Models\AttributeValueImage
Return type: AttributeValueImage

Updates an attribute value image link

Parameters

Name

Type

Description

$data

array

The attribute value image data as an associative array

$itemId

int

The unique ID of the item

$imageId

int

The unique ID of the image

$valueId

int

The unique ID of the attribute value

Return type: 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($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

AttributeValueMapRepositoryContract

The contract for the attribute value map repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods
public create($data):Plenty\Modules\Item\Attribute\Models\AttributeValueMap
Return type: AttributeValueMap

Creates a new attribute value map.

Parameters

Name

Type

Description

$data

array

public find($attributeId, $attributeValueId, $marketId):Plenty\Modules\Item\Attribute\Models\AttributeValueMap
Return type: 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

Name

Type

Description

$attributeId

int

$attributeValueId

int

$marketId

float

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

Lists all attribute value maps.

Parameters

Name

Type

Description

$columns

array

$perPage

int

$page

int

$filter

array

$with

array

public update($data, $attributeId, $attributeValueId, $marketId):Plenty\Modules\Item\Attribute\Models\AttributeValueMap
Return type: 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

Name

Type

Description

$data

array

$attributeId

int

$attributeValueId

int

$marketId

float

public delete($attributeId, $attributeValueId, $marketId):Plenty\Repositories\Models\DeleteResponse
Return type: 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

Name

Type

Description

$attributeId

int

$attributeValueId

int

$marketId

float

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

AttributeValueMarketNameRepositoryContract

The contract for the attribute value market name repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods
public create($data):Plenty\Modules\Item\Attribute\Models\AttributeValueMarketName
Return type: AttributeValueMarketName

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

Parameters

Name

Type

Description

$data

array

The attribute value market name data as associative array

public delete($valueId, $lang, $referenceType):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$valueId

int

The ID of the attribute value

$lang

string

The lang of the attribute value name

$referenceType

string

The referenceType of the attribute value name

public update($data, $valueId, $lang, $referenceType):Plenty\Modules\Item\Attribute\Models\AttributeValueMarketName
Return type: AttributeValueMarketName

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

Parameters

Name

Type

Description

$data

array

The attribute value market name data as associative array

$valueId

int

The ID of the attribute value

$lang

string

The lang of the attribute value market name

$referenceType

string

The referenceType of the attribute value name

public findOne($valueId, $lang, $referenceType):Plenty\Modules\Item\Attribute\Models\AttributeValueMarketName
Return type: AttributeValueMarketName

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

Parameters

Name

Type

Description

$valueId

int

The ID of the attribute value

$lang

string

The lang of the attribute value name

$referenceType

string

The referenceType of the attribute value name

public findByAttributeId($valueId, $lang):array

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

Parameters

Name

Type

Description

$valueId

int

The ID of the attribute

$lang

string

The lang of the attribute value name

Return type: PaginatedResult

Search attribute value market names.

Parameters

Name

Type

Description

$page

int

$itemsPerPage

int

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

AttributeValueNameRepositoryContract

The contract for the attribute value name repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods
public create($data, $valueId):Plenty\Modules\Item\Attribute\Models\AttributeValueName
Return type: AttributeValueName

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

Parameters

Name

Type

Description

$data

array

The attribute value name data as associative array

$valueId

int

The ID of the attribute value

public delete($valueId, $lang):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$valueId

int

The ID of the attribute value

$lang

string

The lang of the attribute value name

public update($data, $valueId, $lang):Plenty\Modules\Item\Attribute\Models\AttributeValueName
Return type: AttributeValueName

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

Parameters

Name

Type

Description

$data

array

The attribute value name data as associative array

$valueId

int

The ID of the attribute value

$lang

string

The lang of the attribute value name

public findOne($valueId, $lang):Plenty\Modules\Item\Attribute\Models\AttributeValueName
Return type: AttributeValueName

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

Parameters

Name

Type

Description

$valueId

int

The ID of the attribute value

$lang

string

The lang of the attribute value name

public findByValueId($valueId):Plenty\Modules\Item\Attribute\Models\AttributeValueName
Return type: AttributeValueName

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

Parameters

Name

Type

Description

$valueId

int

The ID of the attribute value

AttributeValueRepositoryContract

The contract for the attribute value repository

Namespace

Plenty\Modules\Item\Attribute\Contracts

Methods
public create($data, $attributeId):Plenty\Modules\Item\Attribute\Models\AttributeValue
Return type: AttributeValue

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

Parameters

Name

Type

Description

$data

array

The attribute value data as associative array

$attributeId

int

The ID of the attribute

public update($data, $attributeId, $id):Plenty\Modules\Item\Attribute\Models\AttributeValue
Return type: AttributeValue

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

Parameters

Name

Type

Description

$data

array

The attribute value data as associative array

$attributeId

int

The ID of the attribute

$id

int

The ID of the value

public delete($attributeId, $id):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$attributeId

int

The ID of the attribute

$id

int

The ID of the value

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

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

Parameters

Name

Type

Description

$attributeId

int

The ID of the attribute

$page

int

The shown page. Default value is 1.

$perPage

int

The amount of attribute values shown per page. Default value is 50

$columns

array

An array of the shown columns. All columns are returned by default.

$filter

array

$with

array

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

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

Parameters

Name

Type

Description

$attributeId

int

The ID of the attribute

$id

int

The ID of the value

$with

array

An array of the with params

public findOne($valueId):Plenty\Modules\Item\Attribute\Models\AttributeValue
Return type: AttributeValue

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

Parameters

Name

Type

Description

$valueId

int

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

Lists all attribute values.

Parameters

Name

Type

Description

$columns

array

An array of the shown columns. All columns are returned by default.

$perPage

int

The amount of attribute values shown per page. Default value is 50.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

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
Return type: Collection

List attribute value sets

Parameters

Name

Type

Description

$filters

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.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Attribute

The Attribute model including AttributeName and AttributeValue

Namespace

Plenty\Modules\Item\Attribute\Models

Properties
Name Type Description

id

int

The unique ID of the attribute.

backendName

string

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.

position

int

The position of the attribute. Attributes are displayed in the attribute overview in ascending order by position.

isSurchargePercental

bool

Flag that indicates if the surcharge is percental.

isLinkableToImage

bool

Flag that indicates if an image can be linked to the attribute.

amazonAttribute

string

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.

fruugoAttribute

string

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.

pixmaniaAttribute

int

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.

ottoAttribute

string

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.

googleShoppingAttribute

string

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.

neckermannAtEpAttribute

int

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.

typeOfSelectionInOnlineStore

string

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.

laRedouteAttribute

int

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.

isGroupable

bool

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.

attributeNames

array

values

array

maps

array

Methods
public toArray()

Returns this model as an array.

AttributeEbayCorrelation

The AttributeEbayCorrelation model

Namespace

Plenty\Modules\Item\Attribute\Models

Properties
Name Type Description

id

int

The unique ID of the ebay attribute correlation.

attributeId

int

The ID of the attribute.

ebaySiteId

int

The ID of the ebay site the attribute correlation is for.

ebayCategoryId

int

The ID of the ebay category of an ebay site the attribute correlation is for.

ebayAttributeName

string

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.

useForPictures

int

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
Name Type Description

marketId

float

The unique ID of the market.

attributeId

int

The unique ID of the attribute.

name

string

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.

marketInformation1

string

The information regarding the marketplace.

marketInformation2

string

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
Name Type Description

attributeId

int

The id of the attribute.

lang

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">language</a> of the attribute.

name

string

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
Name Type Description

id

int

The unique ID of the attribute value.

attributeId

int

The unique ID of the attribute associated with the attribute value.

backendName

string

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.

position

int

The position of the attribute value. Attribute values are sorted in ascending order by position.

image

string

The name of the image associated with the attribute value; naming pattern is attr\_{valueId}.

comment

string

Optional comment on the attribute value. Comments are not visible in the plentymarkets front end.

amazonValue

string

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.

ottoValue

string

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.

neckermannAtEpValue

string

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.

laRedouteValue

string

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.

tracdelightValue

string

percentageDistribution

int

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

valueNames

array

valueMarketNames

array

valueMaps

array

Methods
public toArray()

Returns this model as an array.

AttributeValueImage

The AttributeValueImage model

Namespace

Plenty\Modules\Item\Attribute\Models

Properties
Name Type Description

imageId

int

The unique ID of the image

itemId

int

The unique ID of the item

attributeId

int

The unique ID of the attribute

valueId

int

The unique ID of the attribute value

Methods
public toArray()

Returns this model as an array.

AttributeValueMap

The AttributeValueMap model

Namespace

Plenty\Modules\Item\Attribute\Models

Properties
Name Type Description

marketId

float

The unique ID of the market.

attributeId

int

The unique ID of the attribute.

attributeValueId

int

The unique ID of the attribute value.

name

string

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.

marketInformation1

string

The information regarding the marketplace.

marketInformation2

string

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
Name Type Description

valueId

int

The unique ID of the attribute value.

lang

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">language</a> of the attribute value market.

name

string

The name of the attribute value market.

name2

string

The name2 of the attribute value market.

attributeId

int

referenceType

string

attributeValue

AttributeValue

Methods
public toArray()

Returns this model as an array.

AttributeValueName

The AttributeValueName model including AttributeValue

Namespace

Plenty\Modules\Item\Attribute\Models

Properties
Name Type Description

valueId

int

The unique ID of the attribute value.

lang

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">language</a> of the attribute value.

name

string

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
Name Type Description

attributeValueSetId

int

The ID of the attribute value set

attributeId

int

The ID of the attribute

valueId

int

The ID of the attribute value

isLinkableToImage

int

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
Name Type Description

id

int

The ID of the attribute value set id

hash

int

a hash

amazon_variation_set

string

size

int

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($id):Plenty\Modules\Item\Availability\Models\Availability
Deprecated!

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

Return type: Availability

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

Parameters

Name

Type

Description

$id

int

The ID of the item availability

public find($id):Plenty\Modules\Item\Availability\Models\Availability
Return type: Availability

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

Parameters

Name

Type

Description

$id

int

The ID of the item availability

public update($data):Plenty\Modules\Item\Availability\Models\Availability
Return type: Availability

Updates an item availability.

Parameters

Name

Type

Description

$data

array

public all():array

Lists all item availabilities.

Models

Availability

The item availability model

Namespace

Plenty\Modules\Item\Availability\Models

Properties
Name Type Description

id

int

The ID of this availability

icon

string

The icon of this availability

averageDays

int

The average delivery time in days for this availability

names

array

Methods
public toArray()

Returns this model as an array.

AvailabilityName

The item availability name model

Namespace

Plenty\Modules\Item\Availability\Models

Properties
Name Type Description

availabilityId

int

The ID of the availability that the name belongs to

lang

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language code</a> of the availability name

name

string

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($barcodeId):Plenty\Modules\Item\Barcode\Models\Barcode
Return type: Barcode

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

Parameters

Name

Type

Description

$barcodeId

int

The ID of the barcode.

public createBarcode($data):Plenty\Modules\Item\Barcode\Models\Barcode
Return type: Barcode

Creates a barcode.

Parameters

Name

Type

Description

$data

array

The barcode data as associative array

public updateBarcode($data, $barcodeId):Plenty\Modules\Item\Barcode\Models\Barcode
Return type: Barcode

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

Parameters

Name

Type

Description

$data

array

The barcode data as associative array

$barcodeId

int

The ID of the barcode.

public deleteBarcode($barcodeId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$barcodeId

int

The unique ID of the barcode

public findBarcodeById($barcodeId):Plenty\Modules\Item\Barcode\Models\Barcode
Return type: Barcode

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

Parameters

Name

Type

Description

$barcodeId

int

The unique ID of the barcode

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

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

Parameters

Name

Type

Description

$barcodeType

string

The type of the barcode

$perPage

int

The number of barcodes shown per page. Default value is 50.

public allBarcodes($columns = [], $perPage = 50, $page = 1):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult

Lists all barcodes.

Parameters

Name

Type

Description

$columns

array

An array of the shown columns. All columns are returned by default.

$perPage

int

The number of barcodes shown per page. Default value is 50.

$page

int

The shown page. Default value is 1.

public createBarcodeReferrerRelation($data, $barcodeId):Plenty\Modules\Item\Barcode\Models\BarcodeLinkReferrer
Return type: BarcodeLinkReferrer

Creates new barcode referrer for specified referrer.

Parameters

Name

Type

Description

$data

array

The barcode data as associative array

$barcodeId

int

The unique ID of the barcode

public deleteBarcodeReferrerRelation($referrer, $barcodeId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

Deletes barcode referrer with specified referrer.

Parameters

Name

Type

Description

$referrer

float

The float value of the referrer

$barcodeId

int

The unique ID of the barcode

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

Gets barcode referrer by specified referrer.

Parameters

Name

Type

Description

$referrer

float

The float value of the referrer

$perPage

int

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($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Barcode

The barcode model including barcode referrer

Namespace

Plenty\Modules\Item\Barcode\Models

Properties
Name Type Description

id

int

The unique ID of the barcode

name

string

The name of the barcode

type

string

The type of the barcode. Possible values: GTIN_8, GTIN_13, GTIN_14, GTIN_128, ISBN, QR, CODE_128, UPC

createdAt

string

The time the code was created.

referrers

array

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
Name Type Description

barcodeId

int

The unique ID of the barcode

referrerId

float

The unique ID of the referrer. To activate all referrers, the value <strong>-1</strong> must be specified. This value activates all referrers in the system by default, including any referrers added at a later stage.

createdAt

string

The time the barcode was created.

updatedAt

string

The time the barcode was last updated.

barcode

Barcode

Methods
public toArray()

Returns this model as an array.

Builders

Item

ItemBelongsToAtLeastOneAmazonFlatFile

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

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item

Methods
public setFilterData($filterData):void

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

Parameters

Name

Type

Description

$filterData

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

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

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public getKey():string
public setAmazonFlatFiles($flatFiles):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item
Return type: Item
Parameters

Name

Type

Description

$flatFiles

string

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

Name

Type

Description

$flatFile

string

public setAmazonFlatFilesRef($flatFilesRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item
Return type: Item
Parameters

Name

Type

Description

$flatFilesRef

string

public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

ItemHasFlagOne

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

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item

Methods
public setFilterData($filterData):void

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

Parameters

Name

Type

Description

$filterData

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

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

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public getKey():string
public setFlag($flag):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item
Return type: Item
Parameters

Name

Type

Description

$flag

int

public setFlagRef($flagRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item
Return type: Item
Parameters

Name

Type

Description

$flagRef

string

public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

ItemHasFlagTwo

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

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item

Methods
public setFilterData($filterData):void

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

Parameters

Name

Type

Description

$filterData

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

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

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public getKey():string
public setFlag($flag):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item
Return type: Item
Parameters

Name

Type

Description

$flag

int

public setFlagRef($flagRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item
Return type: Item
Parameters

Name

Type

Description

$flagRef

string

public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

ItemHasIds

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

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item

Methods
public setFilterData($filterData):void

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

Parameters

Name

Type

Description

$filterData

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

Will return a ItemFilter if at least one item id is provided. Otherwise null is returned.

Parameters

Name

Type

Description

$settings

array

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

Name

Type

Description

$itemIds

int

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

Name

Type

Description

$itemId

int

public getKey():string
public setItemIdsRef($itemIdsRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item
Return type: Item
Parameters

Name

Type

Description

$itemIdsRef

string

public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Sku

VariationHasSku

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

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku

Methods
public setFilterData($filterData):void

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

Parameters

Name

Type

Description

$filterData

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

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

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public getKey():string
public setMarketId($marketId):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku
Return type: Sku
Parameters

Name

Type

Description

$marketId

float

public setAccountId($accountId):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku
Return type: Sku
Parameters

Name

Type

Description

$accountId

int

public setStatus($status):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku
Return type: Sku
Parameters

Name

Type

Description

$status

string

public setMarketIdRef($marketIdRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku
Return type: Sku
Parameters

Name

Type

Description

$marketIdRef

string

public setAccountIdRef($accountIdRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku
Return type: Sku
Parameters

Name

Type

Description

$accountIdRef

string

public setStatusRef($statusRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku
Return type: Sku
Parameters

Name

Type

Description

$statusRef

string

public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Tag

VariationHasTags

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

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Tag

Methods
public setFilterData($filterData):void

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

Parameters

Name

Type

Description

$filterData

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

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

Parameters

Name

Type

Description

$settings

array

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

Name

Type

Description

$tagIds

int

public addTagId($tagId):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Tag
Return type: Tag
Parameters

Name

Type

Description

$tagId

int

public getKey():string
public setTagIdsRef($tagIdsRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Tag
Return type: Tag
Parameters

Name

Type

Description

$tagIdsRef

string

public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationBase

VariationHasAtLeastOneAvailability

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

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase

Methods
public setFilterData($filterData):void

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

Parameters

Name

Type

Description

$filterData

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

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

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public getKey():string
public setAvailabilities($availabilities):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase
Return type: VariationBase
Parameters

Name

Type

Description

$availabilities

int

public addAvailability($availability):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase
Return type: VariationBase
Parameters

Name

Type

Description

$availability

int

public setAvailabilitiesRef($availabilitiesRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase
Return type: VariationBase
Parameters

Name

Type

Description

$availabilitiesRef

string

public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationIsActive

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

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase

Methods
public setShouldBeActive($shouldBeActive):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase
Return type: VariationBase
Parameters

Name

Type

Description

$shouldBeActive

bool

public setShouldBeActiveRef($shouldBeActiveRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase
Return type: VariationBase
Parameters

Name

Type

Description

$shouldBeActiveRef

string

public setFilterData($filterData):void

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

Parameters

Name

Type

Description

$filterData

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

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

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public getKey():string
public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationClient

VariationIsVisibleForAtLeastOneClient

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

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationClient

Methods
public setFilterData($filterData):void

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

Parameters

Name

Type

Description

$filterData

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

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

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public getKey():string
public setClients($clients):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationClient
Return type: VariationClient
Parameters

Name

Type

Description

$clients

int

public addClient($client):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationClient
Return type: VariationClient
Parameters

Name

Type

Description

$client

int

public setClientsRef($clientsRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationClient
Return type: VariationClient
Parameters

Name

Type

Description

$clientsRef

string

public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationMarket

VariationIsVisibleForAtLeastOneMarket

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

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationMarket

Methods
public setFilterData($filterData):void

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

Parameters

Name

Type

Description

$filterData

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

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

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public getKey():string
public setMarketIds($marketIds):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationMarket
Return type: VariationMarket
Parameters

Name

Type

Description

$marketIds

float

public addMarketId($marketId):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationMarket
Return type: VariationMarket
Parameters

Name

Type

Description

$marketId

float

public setMarketIdsRef($marketIdsRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationMarket
Return type: VariationMarket
Parameters

Name

Type

Description

$marketIdsRef

string

public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

VariationProperty

VariationHasAtLeastOnePropertySelection

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

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationProperty

Methods
public setFilterData($filterData):void

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

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):Plenty\Modules\Item\Search\Filter\VariationPropertyFilter
Return type: VariationPropertyFilter

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

Parameters

Name

Type

Description

$settings

array

public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilter
Return type: CatalogUiFilter
public getKey():string
public setPropertySelectionIds($propertySelectionIds):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationProperty
Return type: VariationProperty
Parameters

Name

Type

Description

$propertySelectionIds

int

public addPropertySelectionId($propertySelectionId):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationProperty
Return type: VariationProperty
Parameters

Name

Type

Description

$propertySelectionId

int

public setPropertySelectionIdsRef($propertySelectionIdsRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationProperty
Return type: VariationProperty

Links a key in the settings as source of the value for $propertySelectionIds.

Parameters

Name

Type

Description

$propertySelectionIdsRef

string

public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

Filters

Builders

VariationCatalogExportFilterBuilder

Base class for filters that are used in catalog variation exports.

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders

Methods
public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$required

bool

public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders
Return type: Builders

Fluent setter

Parameters

Name

Type

Description

$isVisible

bool

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

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

Parameters

Name

Type

Description

$filterData

public getFilter($settings = []):void

Returns the filter that will be given to the export

Parameters

Name

Type

Description

$settings

array

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

Returns the UI representation of the filter

VariationFilterBuilderFactory

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

Namespace

Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders

Methods
public variationIsActive():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase\VariationIsActive
Return type: VariationIsActive
public variationHasSku():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku\VariationHasSku
Return type: VariationHasSku
public itemBelongsToAmazonFlatFile():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemBelongsToAtLeastOneAmazonFlatFile
Return type: ItemBelongsToAtLeastOneAmazonFlatFile
public itemHasFlagOne():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasFlagOne
Return type: ItemHasFlagOne
public itemHasFlagTwo():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasFlagTwo
Return type: ItemHasFlagTwo
public itemHasIds():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasIds
Return type: ItemHasIds
public variationHasTags():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Tag\VariationHasTags
Return type: VariationHasTags
public variationHasAtLeastOneAvailability():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase\VariationHasAtLeastOneAvailability
Return type: VariationHasAtLeastOneAvailability
public variationIsVisibleForAtLeastOneClient():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationClient\VariationIsVisibleForAtLeastOneClient
Return type: VariationIsVisibleForAtLeastOneClient
public variationIsVisibleForAtLeastOneMarket():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationMarket\VariationIsVisibleForAtLeastOneMarket
Return type: VariationIsVisibleForAtLeastOneMarket
public variationHasAtLeastOnePropertySelection():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationProperty\VariationHasAtLeastOnePropertySelection

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

Name

Type

Description

$columns

array

$filter

array

$params

array

public lookup($filter = [], $params = [], $calculateNumberOfRows = false):Plenty\Modules\Item\DataLayer\Services\ItemDataLayerResultLookup
Return type: ItemDataLayerResultLookup
Parameters

Name

Type

Description

$filter

array

$params

array

$calculateNumberOfRows

bool

public searchWithPagination($columns, $filter = [], $params = []):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult
Parameters

Name

Type

Description

$columns

array

$filter

array

$params

array

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
Name Type Description

abo

int

addCmsPage

int

amazonFba

int

amazonProductType

int

apiCondition

int

storeSpecial

int

bestofferAutoDeclinePrice

float

condition

int

crossSellingCharacter

int

customsTariffNumber

string

defaultShippingCost

float

directCrossArticle

int

ebayCategory

int

ebayCategory2

int

ebayPreset

int

ebayStoreCategory

int

ebayStoreCategory2

int

epid

string

fedas

string

markingOne

int

markingTwo

int

flashFile

string

flashHeight

int

flashWidth

int

free1

string

free2

string

free3

string

free4

string

free5

string

free6

string

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

int

hasAttribute

string

id

int

inactive

int

createDate

string

isPacket

int

marketStockBuffer

int

noCoupon

int

producingCountryId

int

position

int

priceOnly4orderby

int

producer

string

producerId

int

rating

int

ratingCount

int

revenueAccount

int

scoActive

int

scoMinPrice

float

scoMinStockNet

int

serialNumber

int

shippingWithAmazonFba

string

sitemapPublished

int

storingPosition

string

lastUpdateTimestamp

string

type

int

votes

int

variationCount

int

tradoriaCategory

int

Methods
public toArray()

Returns this model as an array.

ItemCrossSelling

ItemCrossSelling

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

itemId

int

crossItemId

relationship

dynamic

Methods
public toArray()

Returns this model as an array.

ItemDescription

ItemDescription

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

itemId

int

characterCache

string

characterCacheXml

string

characterUpdate

int

description

string

id

int

keywords

string

lang

string

metaDescription

string

name1

string

name2

string

name3

string

shortDescription

string

technicalData

string

urlContent

string

Methods
public toArray()

Returns this model as an array.

ItemProperty

ItemProperty

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

itemPropertyId

int

propertyId

int

propertyValue

propertyValueType

string

isOrderProperty

bool

propertyOrderMarkup

float

Methods
public toArray()

Returns this model as an array.

ItemSetConfig

ItemSetConfig

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

id

int

rebate

float

Methods
public toArray()

Returns this model as an array.

ItemShippingProfiles

ItemShippingProfiles

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

id

int

name

string

backendName

string

tags

array

Methods
public toArray()

Returns this model as an array.

Record

Record

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

itemBase

ItemBase

itemPropertyList

array

itemCrossSellingList

array

itemDescription

ItemDescription

itemShippingProfilesList

array

variationAttributeValueList

array

variationBarcode

VariationBarcode

variationBarcodeList

array

variationBase

VariationBase

variationBundleComponentList

array

variationCategoryList

array

variationImageList

array

variationLinkMarketplace

array

variationLinkWebstore

array

variationMarketStatus

VariationMarketStatus

variationRecommendedRetailPrice

VariationRetailPrice

variationRecommendedRetailPriceList

array

variationRetailPrice

VariationRetailPrice

variationRetailPriceList

array

variationSetRetailPrice

VariationSetRetailPrice

variationStandardCategory

VariationStandardCategory

variationStock

VariationStock

variationStockBuffer

VariationStockBuffer

variationStockList

array

variationSupplierList

array

variationWarehouse

VariationWarehouse

variationWarehouseList

array

variationSpecialOfferRetailPrice

VariationSpecialOfferRetailPrice

variationSpecialOfferRetailPriceList

array

itemSetConfig

ItemSetConfig

Methods
public toArray()

Returns this model as an array.

RecordList

RecordList

Namespace

Plenty\Modules\Item\DataLayer\Models

Methods
public toArray()

Returns this model as an array.

VariationAttributeValue

VariationAttributeValue

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

attributeId

int

attributeValueId

int

Methods
public toArray()

Returns this model as an array.

VariationBarcode

VariationBarcode

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

code

int

createdTimestamp

string

barcodeId

int

barcodeType

string

Methods
public toArray()

Returns this model as an array.

VariationBase

VariationBase

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

active

int

attributeValueSetId

int

autoStockInvisible

string

bundleTyp

string

autoStockNoStockIcon

string

autoStockPositiveStockIcon

string

autoStockVisible

string

availability

int

averageOrderQuantity

string

content

string

unitCombinationId

int

createdTimestamp

string

customNumber

string

estimatedAvailability

string

externalId

string

extraShippingCharge1

float

extraShippingCharge2

float

heightMm

int

id

int

itemId

int

lastUpdateTimestamp

string

lengthMm

int

limitOrderByStockSelect

int

mainWarehouse

int

model

string

operatingCostsPercent

float

packingUnits

int

packingUnitType

int

parentVariationId

int

parentItemVariationQuantity

float

picking

string

customsPercent

float

position

int

priceCalculationId

int

primaryVariation

string

primaryVariationId

int

purchasePrice

float

storageCosts

float

transportationCosts

float

unitId

unitLoadDevice

int

unitsContained

int

vatId

int

variationName

string

weightG

int

weightNetG

int

maximumOrderQuantity

float

minimumOrderQuantity

float

intervalOrderQuantity

float

availableUntil

string

releaseDate

int

widthMm

int

propertyVariationId

int

Methods
public toArray()

Returns this model as an array.

VariationBundleComponent

VariationBundleComponent

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

componentVariationId

int

componentQuantity

float

CreatedTimestamp

string

LastUpdateTimestamp

string

Methods
public toArray()

Returns this model as an array.

VariationCategory

VariationCategory

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

categoryId

int

position

int

neckermannPrimary

Methods
public toArray()

Returns this model as an array.

VariationImage

VariationImage

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

imageId

int

type

int

fileType

string

path

string

position

int

lastUpdateTimestamp

string

createTimestamp

string

cleanImageName

string

attributeValueId

int

Methods
public toArray()

Returns this model as an array.

VariationLinkMarketplace

VariationLinkMarketplace

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

created

string

marketplaceId

float

Methods
public toArray()

Returns this model as an array.

VariationLinkWebstore

VariationLinkWebstore

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

created

string

plentyId

int

Methods
public toArray()

Returns this model as an array.

VariationMarketStatus

VariationMarketStatus

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

id

int

marketId

float

marketAccountId

int

initialSku

sku

parentSku

active

int

createdTimestamp

lastExportTimestamp

deletedTimestamp

marketStatus

additionalInformation

Methods
public toArray()

Returns this model as an array.

VariationRetailPrice

VariationRetailPrice

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

priceId

int

price

float

retailPriceNet

float

basePrice

int

basePriceNet

float

unitPrice

float

unitPriceNet

float

orderParamsMarkup

float

orderParamsMarkupNet

float

classRebatePercent

float

classRebate

float

classRebateNet

float

categoryRebatePercent

float

categoryRebate

float

categoryRebateNet

float

vatId

int

vatValue

float

currency

string

exchangeRatio

float

Methods
public toArray()

Returns this model as an array.

VariationSetRetailPrice

VariationSetRetailPrice

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

priceId

int

price

float

retailPriceNet

float

basePrice

int

basePriceNet

float

unitPrice

float

unitPriceNet

float

orderParamsMarkup

float

orderParamsMarkupNet

float

classRebatePercent

float

classRebate

float

classRebateNet

float

categoryRebatePercent

float

categoryRebate

float

categoryRebateNet

float

vatId

int

vatValue

float

currency

string

exchangeRatio

float

Methods
public toArray()

Returns this model as an array.

VariationSpecialOfferRetailPrice

VariationSpecialOfferRetailPrice

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

retailPriceId

int

retailPrice

float

retailPriceNet

float

basePrice

float

basePriceNet

float

unitPrice

float

unitPriceNet

float

orderParamsMarkup

float

orderParamsMarkupNet

float

vatId

int

vatValue

float

currency

exchangeRatio

float

lastUpdateTimestamp

Methods
public toArray()

Returns this model as an array.

VariationStandardCategory

VariationStandardCategory

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

categoryId

int

plentyId

int

manually

string

Methods
public toArray()

Returns this model as an array.

VariationStock

VariationStock

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

warehouseId

int

stockPhysical

reservedStock

reservedEbay

reorderDelta

stockNet

int

updateAmazon

updatePixmania

warehouseType

reordered

reservedBundle

averagePurchasePrice

warehousePriority

lastUpdateTimestamp

string

lastCalculateTimestamp

reservedOutOfStock

reservedBasket

Methods
public toArray()

Returns this model as an array.

VariationStockBuffer

VariationStockBuffer

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

stockBuffer

int

Methods
public toArray()

Returns this model as an array.

VariationSupplier

VariationSupplier

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

createdTimestamp

string

deliveryTimeInDays

discount

float

discountable

string

id

int

itemNumber

string

itemVariationId

lastPriceQuery

string

lastUpdateTimestamp

string

minimumOrderValue

int

packagingUnit

float

purchasePrice

float

supplierId

int

Methods
public toArray()

Returns this model as an array.

VariationWarehouse

VariationWarehouse

Namespace

Plenty\Modules\Item\DataLayer\Models

Properties
Name Type Description

variationId

int

warehouseId

int

warehouseZoneId

int

storageLocationType

string

reorderLevel

int

maximumStock

int

stockBuffer

int

stockTurnoverInDays

int

storageLocationId

int

lastUpdateTimestamp

string

createdTimestamp

string

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($itemId, $referrerId, $shippingDestinationId, $paymentMethodId):float
Parameters

Name

Type

Description

$itemId

int

The ID of the item

$referrerId

float

The ID of the referrer

$shippingDestinationId

int

The ID of the shipping destination

$paymentMethodId

int

The ID of the payment method

Models

DefaultShippingCost

The default shipping cost model

Namespace

Plenty\Modules\Item\DefaultShippingCost\Models

Properties
Name Type Description

id

int

itemId

int

profileId

int

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($data):void

Creates an item.

Parameters

Name

Type

Description

$data

array

The item data as an associative array

public show($itemId, $columns = [], $lang = &quot;de&quot;, $with = []):void

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

Parameters

Name

Type

Description

$itemId

int

The ID of the item

$columns

array

The array of the shown columns. All columns are returned by default.

$lang

string

The language of the item

$with

array

The relations to be loaded.

Parameters

Name

Type

Description

$columns

The array of the shown columns. All columns are returned by default.

$lang

The language of the item

$page

int

The shown page. Default value is 1.

$itemsPerPage

int

The items shown per page. Default value is 50.

$with

array

The relations to be loaded.

public update($data, $itemId):Plenty\Modules\Item\Item\Models\Item
Return type: Item

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

Parameters

Name

Type

Description

$data

array

$itemId

int

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

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

Parameters

Name

Type

Description

$data

array

public delete($itemId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$itemId

int

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Item

The item model

Namespace

Plenty\Modules\Item\Item\Models

Properties
Name Type Description

id

int

The ID of the item. The ID must be unique.

position

int

The position of the item

itemType

string

The type of the item. Because Set items are managed using a separate route, this value is always Default.

stockType

int

The stock type of the item. Possible values:<ul><li>0 = Stocked item (default)</li><li>1 = Production item</li><li>2 = Colli</li><li>3 = Special order item</li></ul>

storeSpecial

int

Option to present items more prominently in the online store.<ul><li>1 = Special offer</li><li>2 = New items</li><li>3 = Top items</li></ul>

ownerId

int

The plentymarkets user that is assigned as owner of this item.

manufacturerId

int

The ID of the manufacturer of the item

producingCountryId

int

The ID of the country in which the item was manufactured.

mainVariationId

int

The ID of the main variation of the item. The ID must be unique.

revenueAccount

int

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.

couponRestriction

int

Indicates if the item can be purchased using a promotional coupon.<ul><li>0 = Permitted</li><li>1 = Not permitted</li><li>2 = Purchasable with coupon only</li></ul>

condition

int

The condition of the item. Possible values:<ul><li>0 = New</li><li>1 = Used</li><li>2 = Boxed as new</li><li>3 = New with label</li><li>4 = Factory seconds</li></ul>

conditionApi

int

The condition of the item that is transferred to markets via API.<ul><li>0 = New</li><li>1 = Used but as new</li><li>2 = Used but very good</li><li>3 = Used but good</li><li>4 = Used but acceptable</li><li>5 = Factory seconds</li></ul>

createdAt

string

Timestamp of the date and time the item was created.

updatedAt

string

Timestamp of the last date and time the item was updated.

isSubscribable

bool

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.

isSerialNumber

bool

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.

isShippingPackage

bool

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 <b>Settings</b> tab of a variation, the correct shipping package is assigned automatically.

amazonFbaPlatform

int

Indicates the platform used for Fulfilment by Amazon (FBA). <ul><li>0 = Do not use</li><li>1 = AMAZON EU (Europe)</li><li>2 = AMAZON FE (Far East)</li><li>3 = AMAZON NA (North America)</li></ul>

isShippableByAmazon

bool

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.

amazonProductType

int

The Amazon product type of the item. List of IDs: https://www.plentymarkets.co.uk/manual/data-exchange/data-formats/item/

amazonFedas

string

The FEDAS product classification key of the item.

ebayPresetId

int

The eBay preset ID. This plentymarkets ID must be specified to save values for $ebayCategory, $ebayCategory2, $ebayStoreCategory and $ebayStoreCategory2.

ebayCategory

int

The eBay category 1 of the item. This category is used when a new listing is created.

ebayCategory2

int

The eBay category 2 of the item. This category is used when a new listing is created.

ebayStoreCategory

int

The ID of the eBay store category 1 of the item. This value is used for new listings.

ebayStoreCategory2

int

The ID of the eBay store category 2 of the item. This value is used for new listings.

rakutenCategoryId

int

The ID of the Rakuten category of this item.

flagOne

int

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

flagTwo

int

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

ageRestriction

int

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.<ul><li>0 = None available</li><li>3 = Released for ages 3 and up</li><li>6 = Ages 6 and up</li><li>9 = Ages 9 and up</li><li>12 = Ages 12 and up</li><li>14 = Ages 14 and up</li><li>16 = Ages 16 and up</li><li>18 = Ages 18 and up</li><li>50 = Not marked</li><li>88 = Not required</li><li>99 = Unknown</li></ul>

feedback

int

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.

free1

string

The content of the free text field 1. This can be displayed in the online store or on eBay.

free2

string

The content of the free text field 2. This can be displayed in the online store or on eBay.

free3

string

The content of the free text field 3. This can be displayed in the online store or on eBay.

free4

string

The content of the free text field 4. This can be displayed in the online store or on eBay.

free5

string

The content of the free text field 5. This can be displayed in the online store or on eBay.

free6

string

The content of the free text field 6. This can be displayed in the online store or on eBay.

free7

string

The content of the free text field 7. This can be displayed in the online store or on eBay.

free8

string

The content of the free text field 8. This can be displayed in the online store or on eBay.

free9

string

The content of the free text field 9. This can be displayed in the online store or on eBay.

free10

string

The content of the free text field 10. This can be displayed in the online store or on eBay.

free11

string

The content of the free text field 11. This can be displayed in the online store or on eBay.

free12

string

The content of the free text field 12. This can be displayed in the online store or on eBay.

free13

string

The content of the free text field 13. This can be displayed in the online store or on eBay.

free14

string

The content of the free text field 14. This can be displayed in the online store or on eBay.

free15

string

The content of the free text field 15. This can be displayed in the online store or on eBay.

free16

string

The content of the free text field 16. This can be displayed in the online store or on eBay.

free17

string

The content of the free text field 17. This can be displayed in the online store or on eBay.

free18

string

The content of the free text field 18. This can be displayed in the online store or on eBay.

free19

string

The content of the free text field 19. This can be displayed in the online store or on eBay.

free20

string

The content of the free text field 20. This can be displayed in the online store or on eBay.

maximumOrderQuantity

float

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.

manufacturer

Manufacturer

texts

array

ebayTitles

array

itemShippingProfiles

array

itemProperties

array

itemCrossSelling

array

variations

array

An array of the variations of the item.

itemImages

array

An array of the images of the item.

customsTariffNumber

string

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
Name Type Description

title

string

The title.

itemId

int

The unique ID of the item.

id

int

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
Name Type Description

lang

string

The language of the item text.

name1

string

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.

name2

string

Alternative item name that can be used e.g. for markets. The maximum length is 240 characters.

name3

string

Alternative item name that can be used e.g. for markets. The maximum length is 240 characters.

shortDescription

string

The preview text of the item. This short description text can be displayed as a teaser in item lists.

metaDescription

string

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.

description

string

The detailed description of the item.

technicalData

string

Technical data of the item.

keywords

string

HTML meta keywords to tag the item for search engines. More than one keyword can be separated by commas.

urlPath

string

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

CheckItemRestriction

Namespace

Plenty\Modules\Item\ItemCoupon\Hooks

Methods
public handle($basketItemEvent):void
Parameters

Name

Type

Description

$basketItemEvent

BasketItemEvent

ItemCrossSelling

Contracts

DynamicItemCrossSellingRepositoryContract

Repository for dynamic item cross-selling

Namespace

Plenty\Modules\Item\ItemCrossSelling\Contracts

Methods
public create($data):Plenty\Modules\Item\ItemCrossSelling\Models\DynamicItemCrossSelling
Return type: DynamicItemCrossSelling

Create a new dynamic cross-selling link

Parameters

Name

Type

Description

$data

array

public show($itemId, $crossItemId):Plenty\Modules\Item\ItemCrossSelling\Models\DynamicItemCrossSelling
Return type: DynamicItemCrossSelling

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

Parameters

Name

Type

Description

$itemId

int

The unique ID of the item

$crossItemId

int

The unique ID of the linked cross-selling item

public delete($itemId, $crossItemId):Plenty\Repositories\Models\DeleteResponse
Return type: 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

Name

Type

Description

$itemId

int

The unique ID of the item

$crossItemId

int

The unique ID of the linked cross-selling item

public findByItemId($itemId):array

List dynamic cross-selling links by item ID

Parameters

Name

Type

Description

$itemId

int

The unique ID of the item

public findAllByItemId($itemId):array

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

Parameters

Name

Type

Description

$itemId

int

The unique ID of the item

ItemCrossSellingRepositoryContract

Repository for item cross-selling

Namespace

Plenty\Modules\Item\ItemCrossSelling\Contracts

Methods
public create($data):Plenty\Modules\Item\ItemCrossSelling\Models\ItemCrossSelling
Return type: ItemCrossSelling
Parameters

Name

Type

Description

$data

array

public show($itemId):Plenty\Modules\Item\ItemCrossSelling\Models\ItemCrossSelling
Return type: ItemCrossSelling
Parameters

Name

Type

Description

$itemId

int

The unique ID of the item

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

Name

Type

Description

$itemId

int

The unique ID of the item

$crossItemId

int

The unique ID of the linked cross-selling item

public findByItemId($itemId):array
Parameters

Name

Type

Description

$itemId

int

The unique ID of the item

public findAllByItemId($itemId):array

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

Parameters

Name

Type

Description

$itemId

int

The unique ID of the item

Return type: PaginatedResult
Parameters

Name

Type

Description

$itemsPerPage

int

$page

int

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

DynamicItemCrossSelling

The item dynamic cross-selling model including the item

Namespace

Plenty\Modules\Item\ItemCrossSelling\Models

Properties
Name Type Description

itemId

int

The unique ID of the item to which cross-selling items are linked

crossItemId

int

The unique ID of the cross-selling item that is linked to the item

count

int

The count

lastUpdate

int

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
Name Type Description

itemId

int

The unique ID of the item to which cross-selling items are linked

crossItemId

int

The unique ID of the cross-selling item that is linked to the item

relationship

string

The cross-selling relationship between item and cross-selling item. Possible values:<ul><li>Accessory = The cross-selling item is an accessory of the item.</li><li>ReplacementPart = The cross-selling item is a replacement part for the item.</li><li>Similar = The cross-selling item is similar to the item.</li><li>Bundle = The cross-selling item is suitable to be sold as a bundle with the item.</li></ul>

isDynamic

bool

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($data):Plenty\Modules\Item\ItemImage\Models\ItemImageAvailability
Return type: ItemImageAvailability

Creates an image availability

Parameters

Name

Type

Description

$data

array

The image availability data as associative array

public delete($data):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

Deletes an image availability.

Parameters

Name

Type

Description

$data

array

The image availability data as associative array

public findByImageId($imageId):Plenty\Modules\Item\ItemImage\Models\ItemImageAvailability
Return type: ItemImageAvailability

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

Parameters

Name

Type

Description

$imageId

int

The ID of the image

public findByType($imageId, $type):Plenty\Modules\Item\ItemImage\Models\ItemImageAvailability
Return type: ItemImageAvailability

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

Parameters

Name

Type

Description

$imageId

int

The ID of the image

$type

string

The type of the image

ItemImageNameRepositoryContract

The contract for the item image name repository

Namespace

Plenty\Modules\Item\ItemImage\Contracts

Methods
public create($data):Plenty\Modules\Item\ItemImage\Models\ItemImageName
Return type: ItemImageName

Creates an image name

Parameters

Name

Type

Description

$data

array

The image name data as associative array

public update($data, $imageId, $lang):Plenty\Modules\Item\ItemImage\Models\ItemImageName
Return type: ItemImageName

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

Parameters

Name

Type

Description

$data

array

The image name data as associative array

$imageId

int

The ID of the image

$lang

string

The language of the image name

public delete($imageId, $lang):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$imageId

int

The ID of the image

$lang

string

The language of the image name

public findOne($imageId, $lang):Plenty\Modules\Item\ItemImage\Models\ItemImageName
Return type: ItemImageName

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

Parameters

Name

Type

Description

$imageId

int

The ID of the image

$lang

string

The language of the image name

public findByImageId($imageId):array

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

Parameters

Name

Type

Description

$imageId

int

The ID of the image

ItemImageRepositoryContract

The contract for the item image repository

Namespace

Plenty\Modules\Item\ItemImage\Contracts

Methods
public update($data, $imageId):Plenty\Modules\Item\ItemImage\Models\ItemImage
Return type: ItemImage

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

Parameters

Name

Type

Description

$data

array

The image data as associative array

$imageId

int

The ID of the image

public delete($imageId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$imageId

int

The ID of the image

public show($imageId):Plenty\Modules\Item\ItemImage\Models\ItemImage
Return type: ItemImage

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

Parameters

Name

Type

Description

$imageId

int

The ID of the image

public findByItemId($itemId):array

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

Parameters

Name

Type

Description

$itemId

int

The ID of the image

public findByVariationId($variationId):array

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

Parameters

Name

Type

Description

$variationId

int

The ID of the variation

public findByItemIdAndOriginalChecksum($itemId, $checksum):Plenty\Modules\Item\ItemImage\Models\ItemImage
Return type: ItemImage

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

Parameters

Name

Type

Description

$itemId

int

The ID of the item

$checksum

string

The MD5 checksum of the image

public upload($data):Plenty\Modules\Item\ItemImage\Models\ItemImage
Return type: ItemImage

Uploads an item image

Parameters

Name

Type

Description

$data

array

The image data as associative array

public warmup($urls, $queue = &quot;plentymarkets-command&quot;):void

Calls a stack of image urls to prepare cache

Parameters

Name

Type

Description

$urls

array

array of urls to call

$queue

string

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($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

ItemImageSettingsRepositoryContract

Get, update or invalidate item image settings

Namespace

Plenty\Modules\Item\ItemImage\Contracts

Methods
public get():Plenty\Legacy\Models\Item\ItemImageSettings
Return type: ItemImageSettings
public update($data):Plenty\Legacy\Models\Item\ItemImageSettings
Return type: ItemImageSettings
Parameters

Name

Type

Description

$data

public invalidate($path):Plenty\Legacy\Models\Item\ItemImageSettings
Return type: ItemImageSettings
Parameters

Name

Type

Description

$path

string

public invalidateStatus():void

Models

ItemImage

The ItemImage Model

Namespace

Plenty\Modules\Item\ItemImage\Models

Properties
Name Type Description

id

int

The unique ID of the image

itemId

int

The unique ID of the item the image is associated with

fileType

string

The file format of the image. Possible file formats: jpg, jpeg, png, gif, svg

path

string

The path under which the image is saved.

position

int

The position of the image. The position is used for sorting images in the online store.

createdAt

string

The time the image was uploaded.

updatedAt

string

The time the image details were last updated.

md5Checksum

string

The MD5 hash value of the image file

md5ChecksumOriginal

string

The MD5 hash value of the original image file

hasLinkedVariations

int

Indicates if the item is linked with variations. Returns 1 if at least one variation is linked with the image, otherwise 0.

size

int

The size of the image in pixels

width

int

The width of the image in pixels

height

int

The height of the image in pixels

url

string

The URL under which the image can be accessed after the upload.

urlMiddle

string

The URL that points to the medium-sized version of the item image.

urlPreview

string

The URL that points to the first preview version of the item image.

urlSecondPreview

string

The URL that points to the second preview version of the item image.

names

array

Lists the image’s name details as an array.

availabilities

array

Lists the image’s availability details as an array.

attributeValueImages

array

Lists the attribute value image’s details as an array.

Methods
public toArray()

Returns this model as an array.

ItemImageAvailability

ItemImageAvailability

Namespace

Plenty\Modules\Item\ItemImage\Models

Properties
Name Type Description

imageId

int

The ID of the image. The ID must be unique.

type

string

The type of referrer for which the image is available. Possible types: <ul><li>mandant = The image can be made available for clients (stores).</li><li>marketplace = The image can be made available for markets.</li><li>listing = The image can be made available for listings.</li></ul>

value

float

For the type <b>mandant</b>, this is the plentyID of the client (store) for which the image is available. For the types <b>marketplace</b> and <b>listing</b>, this is the ID of the referrer for which the image is available. <ul><li><strong>-1.00</strong> = The image is available for all referrers of this type.</li></ul>

Methods
public toArray()

Returns this model as an array.

ItemImageName

ItemImageName

Namespace

Plenty\Modules\Item\ItemImage\Models

Properties
Name Type Description

imageId

int

The ID of the image. The ID must be unique.

lang

string

The language of the image name

name

string

The name of the image in the specified language

alternate

string

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
Name Type Description

id

int

The ID of the image. The ID must be unique.

itemId

int

The ID of the item the image is associated with

fileType

string

The file format of the image. Possible file formats: JPG, JPEG, PNG, GIF, SVG

path

string

The path under which the image is saved. Permitted characters for file names: alphanumeric (a-z, A-Z, 0-9), hypens (-), underscores (_).

position

int

The position of the image. The position is used for sorting images in the online store.

created

string

The time the image was uploaded.

updated

string

The time the image details were last updated.

uploadImageData

string

The base64 encoded image data of the image

uploadUrl

string

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 (_).

uploadFileName

string

The file name assigned to the uploaded image. Permitted characters for file names: alphanumeric (a-z, A-Z, 0-9), hypens (-), underscores (_).

names

array

names

availabilities

array

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($data):string

Get a variation label

Parameters

Name

Type

Description

$data

array

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($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

ItemLabel

The item label model

Namespace

Plenty\Modules\Item\ItemLabel\Models

Properties
Name Type Description

labelId

int

The unique ID of the label template

itemId

int

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($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

ItemProperty

ItemPropertyValue

Namespace

Plenty\Modules\Item\ItemProperty\Models

Properties
Name Type Description

id

int

The id of the variation property value

itemId

int

The id of the variation

propertyId

int

The id of the property item

propertySelectionId

int

The id of the property selection

valueInt

int

The int value of the variation property value

valueFloat

float

The float value of the variation property value

valueFile

string

The file value of the variation property value

surcharge

float

The surcharge of the variation property value

property

Property

propertySelection

array

valueTexts

array

Methods
public toArray()

Returns this model as an array.

ItemPropertyValueText

The ItemPropertyValueText

Namespace

Plenty\Modules\Item\ItemProperty\Models

Properties
Name Type Description

valueId

int

lang

string

value

string

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($perPage = 100, $page = 1):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult

Lists all serial numbers.

Parameters

Name

Type

Description

$perPage

int

$page

int

public show($id):Plenty\Modules\Item\ItemSerialNumber\Models\ItemSerialNumber
Return type: ItemSerialNumber

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

Parameters

Name

Type

Description

$id

int

public create($data):Plenty\Modules\Item\ItemSerialNumber\Models\ItemSerialNumber
Return type: ItemSerialNumber

Creates a serial number

Parameters

Name

Type

Description

$data

array

public update($id, $data):Plenty\Modules\Item\ItemSerialNumber\Models\ItemSerialNumber
Return type: ItemSerialNumber

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

Parameters

Name

Type

Description

$id

int

$data

array

public delete($id):Plenty\Repositories\Contracts\DeleteResponseContract
Return type: DeleteResponseContract

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

Parameters

Name

Type

Description

$id

int

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

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
Name Type Description

id

int

The ID of the serial number

orderId

int

The ID of the order

orderItemId

int

The ID of the order item

itemId

int

The ID of the item

serialNumber

string

The serial number

createdAt

string

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($id):Plenty\Modules\Item\ItemShippingProfiles\Models\ItemShippingProfiles
Return type: ItemShippingProfiles

Finds a shipping profile link by ID

Parameters

Name

Type

Description

$id

int

The unique ID of the link between shipping profile and item

public findByItemId($itemId):array

Lists all shipping profiles activated for an item

Parameters

Name

Type

Description

$itemId

int

The unique ID of the item

public create($data):Plenty\Modules\Item\ItemShippingProfiles\Models\ItemShippingProfiles
Return type: ItemShippingProfiles

Activates a shipping profile for an item

Parameters

Name

Type

Description

$data

array

public delete($id):array

Deactivates a shipping profile for an item

Parameters

Name

Type

Description

$id

int

The unique ID of the link between shipping profile and item

public getItemShippingProfiles($itemsPerPage, $page):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult

Lists all shipping profiles of all items

Parameters

Name

Type

Description

$itemsPerPage

int

$page

int

public createBulk($data):array

Activates up to 50 shipping profiles for items

Parameters

Name

Type

Description

$data

array

public deleteBulk($itemId):void

Deactivates all shipping profiles for an item

Parameters

Name

Type

Description

$itemId

int

public deleteOne($shippingProfileId, $itemId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

Delete the link between the specified shipping profile and item

Parameters

Name

Type

Description

$shippingProfileId

int

$itemId

int

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

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
Name Type Description

id

int

The unique ID of the link between item and shipping profile

itemId

int

The unique ID of the item

profileId

int

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($id):Plenty\Modules\Item\Manufacturer\Models\ManufacturerCommission
Return type: ManufacturerCommission

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

Parameters

Name

Type

Description

$id

int

The ID of the manufacturer

public create($data):Plenty\Modules\Item\Manufacturer\Models\ManufacturerCommission
Return type: ManufacturerCommission

Creates a manufacturer commission.

Parameters

Name

Type

Description

$data

array

The manufacturer commission data as an associative array

public update($data, $id):Plenty\Modules\Item\Manufacturer\Models\ManufacturerCommission
Return type: ManufacturerCommission

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

Parameters

Name

Type

Description

$data

array

The manufacturer commission data as an associative array

$id

int

The ID of the manufacturer

public delete($id):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$id

int

The ID of the manufacturer

public findByManufacturerId($manufacturerId):array

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

Parameters

Name

Type

Description

$manufacturerId

int

The ID of the manufacturer

ManufacturerExternalRepositoryContract

The contract for the manufacturer external repository

Namespace

Plenty\Modules\Item\Manufacturer\Contracts

Methods
public find($manufacturerId, $marketId):Plenty\Modules\Item\Manufacturer\Models\ManufacturerExternal
Return type: ManufacturerExternal

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

Parameters

Name

Type

Description

$manufacturerId

int

The ID of the manufacturer

$marketId

int

The ID of the market

public create($data):Plenty\Modules\Item\Manufacturer\Models\ManufacturerExternal
Return type: ManufacturerExternal

Creates a manufacturer external.

Parameters

Name

Type

Description

$data

array

The manufacturer external data as an associative array

public update($data, $manufacturerId, $marketId):Plenty\Modules\Item\Manufacturer\Models\ManufacturerExternal
Return type: ManufacturerExternal

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

Parameters

Name

Type

Description

$data

array

The manufacturer external data as an associative array

$manufacturerId

int

The ID of the manufacturer

$marketId

int

The ID of the market

public delete($manufacturerId, $marketId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$manufacturerId

int

The ID of the manufacturer

$marketId

int

The ID of the market

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($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

ManufacturerRepositoryContract

The contract for the manufacturer repository

Namespace

Plenty\Modules\Item\Manufacturer\Contracts

Methods
public create($data):Plenty\Modules\Item\Manufacturer\Models\Manufacturer
Return type: Manufacturer

Creates a manufacturer.

Parameters

Name

Type

Description

$data

array

The manufacturer data as an associative array

public update($data, $manufacturerId):Plenty\Modules\Item\Manufacturer\Models\Manufacturer
Return type: Manufacturer

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

Parameters

Name

Type

Description

$data

array

The manufacturer data as an associative array

$manufacturerId

int

The ID of the manufacturer

public delete($manufacturerId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$manufacturerId

int

The ID of the manufacturer

public findById($manufacturerId, $with = []):Plenty\Modules\Item\Manufacturer\Models\Manufacturer
Return type: Manufacturer

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

Parameters

Name

Type

Description

$manufacturerId

int

The ID of the manufacturer

$with

array

public all($columns = [], $perPage = 50, $page = 1, $with = []):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult

Lists all manufacturers.

Parameters

Name

Type

Description

$columns

array

An array of the shown columns. All columns are returned by default.

$perPage

int

The amount of manufacturers shown per page. Default value is 50.

$page

int

The shown page. Default value is 1.

$with

array

Return type: PaginatedResult

Lists manufacturers by filter

Parameters

Name

Type

Description

$params

array

The filter array

$columns

array

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($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Manufacturer

The item manufacturer model

Namespace

Plenty\Modules\Item\Manufacturer\Models

Properties
Name Type Description

id

int

The unique ID of the manufacturer.

name

string

The name of the manufacturer

externalName

string

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.

logo

string

The URL of the manufacturer’s logo

url

string

The URL of the manufacturer’s website

street

string

The street of the manufacturer’s address

houseNo

string

The house number of the manufacturer’s address

postcode

string

The postal code of the manufacturer’s address

town

string

The town of the manufacturer’s address

phoneNumber

string

The phone number of the manufacturer

faxNumber

string

The fax number of the manufacturer

email

string

The email address of the manufacturer

countryId

int

The ID of the <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">country</a> in which the manufacturer is based; 0 = unknown.

pixmaniaBrandId

int

The manufacturer’s ID on the market Pixmania

neckermannAtEpBrandId

int

The manufacturer’s ID on the market Neckermann Austria, Enterprise version

laRedouteBrandId

int

The manufacturer’s ID on the market La Redoute

position

int

The position of the manufacturer

comment

string

Internal comments about the manufacturer (optional)

updatedAt

string

The time the manufacturer information was last updated.

commissions

array

externals

array

Methods
public toArray()

Returns this model as an array.

ManufacturerCommission

The item manufacturer commission model

Namespace

Plenty\Modules\Item\Manufacturer\Models

Properties
Name Type Description

id

int

The unique ID of the manufacturer commission

manufacturerId

int

The unique ID of the manufacturer

plentyId

int

The unique ID of the client (store) that the commission applies to. The route /rest/webstores provides access to clients (stores).

referrerId

float

The unique ID of the referrer that the commission applies to. The route /rest/orders/referrers provides access to referrers.

commission

float

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
Name Type Description

manufacturerId

int

The unique ID of the manufacturer

marketId

int

The unique ID of the market

value

string

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($language):array

Get the item variation packing units

Parameters

Name

Type

Description

$language

string

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

public getPackingUnitsById($id, $language = &quot;all&quot;, $isUnitId = false):Plenty\Modules\Item\PackingUnit\Models\PackingUnit
Return type: PackingUnit

Get the item variation packing unit for a specific given id

Parameters

Name

Type

Description

$id

int

The id of the packing unit

$language

string

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

$isUnitId

bool

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
Name Type Description

id

int

The id of the packing unit entry. Primary key auto-increment

unitId

int

The id of the packing unit as it was until now (from 0 to 39 without 33)

unitNameEN

string

The name of the packing unit in English

unitNameDE

string

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($data, $propertyGroupId):Plenty\Modules\Item\Property\Models\PropertyGroupName
Return type: PropertyGroupName

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

Parameters

Name

Type

Description

$data

array

The property group name data as an associative array

$propertyGroupId

int

The ID of the property group

public delete($propertyGroupId, $lang):bool

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

Parameters

Name

Type

Description

$propertyGroupId

int

The ID of the property group

$lang

string

The specific language of the property group name

public update($data, $propertyGroupId, $lang):Plenty\Modules\Item\Property\Models\PropertyGroupName
Return type: PropertyGroupName

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

Parameters

Name

Type

Description

$data

array

The property group name data as an associative array

$propertyGroupId

int

The ID of the property group

$lang

string

The specific language of the property group name

public findOne($propertyGroupId, $lang):Plenty\Modules\Item\Property\Models\PropertyGroupName
Return type: PropertyGroupName

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

Parameters

Name

Type

Description

$propertyGroupId

int

The ID of the property group

$lang

string

The specific language of the property group name

public findByPropertyGroupId($propertyGroupId):array

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

Parameters

Name

Type

Description

$propertyGroupId

int

The ID of the property group

PropertyGroupRepositoryContract

The contract for the property group repository

Namespace

Plenty\Modules\Item\Property\Contracts

Methods
public create($data):Plenty\Modules\Item\Property\Models\PropertyGroup
Return type: PropertyGroup

Creates a property group.

Parameters

Name

Type

Description

$data

array

The property group data as an associative array

public show($id):Plenty\Modules\Item\Property\Models\PropertyGroup
Return type: PropertyGroup

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

Parameters

Name

Type

Description

$id

int

The ID of the property group

public update($data, $id):Plenty\Modules\Item\Property\Models\PropertyGroup
Return type: PropertyGroup

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

Parameters

Name

Type

Description

$data

array

The property group data as an associative array

$id

int

The ID of the property group

public delete($id):bool

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

Parameters

Name

Type

Description

$id

int

The ID of the property group

public findById($id):Plenty\Modules\Item\Property\Models\PropertyGroup
Return type: PropertyGroup

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

Parameters

Name

Type

Description

$id

int

The ID of the property group

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

Lists all property groups.

Parameters

Name

Type

Description

$columns

array

An array of the shown columns. All columns are returned by default.

$perPage

int

The amount of shown property groups per page. Default value is 50.

$page

int

The shown page. Default value is 1.

$with

array

public findByBackendName($backendName):Plenty\Modules\Item\Property\Models\PropertyGroup
Return type: PropertyGroup

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

Parameters

Name

Type

Description

$backendName

string

PropertyMarketReferenceRepositoryContract

The contract for the property market reference repository

Namespace

Plenty\Modules\Item\Property\Contracts

Methods
public create($data, $propertyId):Plenty\Modules\Item\Property\Models\PropertyMarketReference
Return type: PropertyMarketReference

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

Parameters

Name

Type

Description

$data

array

The property market component data as an associative array

$propertyId

int

The ID of the property

public delete($propertyId, $marketReference):bool

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

Parameters

Name

Type

Description

$propertyId

int

The ID of the property

$marketReference

float

The market reference value

public update($data, $propertyId, $marketReference):Plenty\Modules\Item\Property\Models\PropertyMarketReference
Return type: PropertyMarketReference

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

Parameters

Name

Type

Description

$data

array

The property market component data as an associative array

$propertyId

int

The ID of the property

$marketReference

float

The market reference value

public findOne($propertyId, $marketReference):Plenty\Modules\Item\Property\Models\PropertyMarketReference
Return type: PropertyMarketReference

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

Parameters

Name

Type

Description

$propertyId

int

The ID of the property

$marketReference

float

The market reference value

public findByPropertyId($propertyId):Plenty\Modules\Item\Property\Models\PropertyMarketReference
Return type: PropertyMarketReference

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

Parameters

Name

Type

Description

$propertyId

int

The ID of the property

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

Lists all property market references.

Parameters

Name

Type

Description

$referrerId

float

The ID of the referrer

$componentId

int

The ID of the component

$filters

array

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($data, $propertyId):Plenty\Modules\Item\Property\Models\PropertyName
Return type: PropertyName

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

Parameters

Name

Type

Description

$data

array

The property name data as an associative array

$propertyId

int

The ID of the property

public delete($propertyId, $lang):bool

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

Parameters

Name

Type

Description

$propertyId

int

The ID of the property

$lang

string

The language of the property name

public update($data, $propertyId, $lang):Plenty\Modules\Item\Property\Models\PropertyName
Return type: PropertyName

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

Parameters

Name

Type

Description

$data

array

The property name data as an associative array

$propertyId

int

The ID of the property

$lang

string

The language of the property name

public findOne($propertyId, $lang):Plenty\Modules\Item\Property\Models\PropertyName
Return type: PropertyName

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

Parameters

Name

Type

Description

$propertyId

int

The ID of the property

$lang

string

The language of the property name

public findBypropertyId($propertyId):Plenty\Modules\Item\Property\Models\PropertyName
Return type: PropertyName

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

Parameters

Name

Type

Description

$propertyId

int

The ID of the property

PropertyRepositoryContract

The contract for the property repository

Namespace

Plenty\Modules\Item\Property\Contracts

Methods
public create($data):Plenty\Modules\Item\Property\Models\Property
Return type: Property

Creates a property.

Parameters

Name

Type

Description

$data

array

The property data as an associative array

public show($id):Plenty\Modules\Item\Property\Models\Property
Return type: Property

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

Parameters

Name

Type

Description

$id

int

The ID of the property

public update($data, $id):Plenty\Modules\Item\Property\Models\Property
Return type: Property

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

Parameters

Name

Type

Description

$data

array

The property data as an associative array

$id

int

The ID of the property

public delete($id):bool

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

Parameters

Name

Type

Description

$id

int

The ID of the property

public findById($id):Plenty\Modules\Item\Property\Models\Property
Return type: Property

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

Parameters

Name

Type

Description

$id

int

The ID of the property

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

Lists all properties.

Parameters

Name

Type

Description

$columns

array

An array of the shown columns. All columns are returned by default.

$perPage

int

The amount of attribute values shown per page. Default value is 50

$page

int

The shown page. Default value is 1.

Return type: PaginatedResult

Search properties.

Parameters

Name

Type

Description

$columns

array

An array of the shown columns. All columns are returned by default.

$perPage

int

The amount of attribute values shown per page. Default value is 50

$page

int

The shown page. Default value is 1.

$with

array

$filter

array

public findByBackendName($backendName):Plenty\Modules\Item\Property\Models\Property
Return type: Property

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

Parameters

Name

Type

Description

$backendName

string

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertySelectionRepositoryContract

The contract for the property selection repository

Namespace

Plenty\Modules\Item\Property\Contracts

Methods
public create($data, $propertyId):Plenty\Modules\Item\Property\Models\PropertySelection
Return type: PropertySelection

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

Parameters

Name

Type

Description

$data

array

The property selection data as an associative array

$propertyId

int

The ID of the property

public createLang($data, $propertyId, $id):Plenty\Modules\Item\Property\Models\PropertySelection
Return type: PropertySelection

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

Parameters

Name

Type

Description

$data

array

The property selection data as an associative array

$propertyId

int

The ID of the property

$id

int

The ID of the property selection

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

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

Parameters

Name

Type

Description

$propertyId

int

$lang

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language</a> of the property selection

public findByPropertyId($propertyId):Plenty\Modules\Item\Property\Models\PropertySelection
Deprecated!

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

Return type: PropertySelection

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

Parameters

Name

Type

Description

$propertyId

int

The ID of the property

public deleteSelection($id):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$id

int

The ID of the property selection

public delete($id, $lang):bool

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

Parameters

Name

Type

Description

$id

int

The ID of the property selection

$lang

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language</a> of the property selection

public findOne($id, $lang):Plenty\Modules\Item\Property\Models\PropertySelection
Return type: PropertySelection

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

Parameters

Name

Type

Description

$id

int

The ID of the property selection

$lang

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language</a> of the property selection

public findSelection($id):array

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

Parameters

Name

Type

Description

$id

int

The ID of the property selection

public update($data, $id, $lang):Plenty\Modules\Item\Property\Models\PropertySelection
Return type: PropertySelection

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

Parameters

Name

Type

Description

$data

array

The property selection data as an associative array

$id

int

The ID of the property selection

$lang

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language</a> of the property selection

Models

Property

The property including Property name and property market reference

Namespace

Plenty\Modules\Item\Property\Models

Properties
Name Type Description

id

int

The ID of the property

position

int

The position of the property

propertyGroupId

int

The ID of the property group the property is assigned to. Value is null if property is not assigned to a property group.

unit

string

The unit of measurement of the property. Value is null if no unit is associated.

backendName

string

The backend name of the property. The back end name is not visible to customers.

comment

string

Internal comment/note saved for the property. Internal comments are not visible to customers.

valueType

string

Permitted property values are: <ul><li>empty = No property type</li><li>int = A whole number can be saved for an item, e.g. a size.</li><li>float = A number with decimal places can be saved for an item, e.g. a measurement.</li><li>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.</li><li>text = Text can be saved for an item.</li><li>file = A file can be saved for an item.</li></ul>

isSearchable

bool

Flag that indicates if items can be found by entering the property name as a search term.

isOderProperty

bool

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.

isShownOnItemPage

bool

Flag that indicates if the property will be shown on the item’s page in the online store-

isShownOnItemList

bool

Flag that indicates if the property will be shown in the item listing in the online store.

isShownAtCheckout

bool

Flag that indicates if the property will be shown in the order process.

isShownInPdf

bool

Flag that indicates if the property will be shown in PDF documents.

isShownAsAdditionalCosts

bool

Display as additional costs

surcharge

float

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.

updatedAt

string

The time the property was last updated.

names

array

marketComponents

array

group

array

selections

array

Methods
public toArray()

Returns this model as an array.

PropertyGroup

The PropertyGroup including PropertyGroupName

Namespace

Plenty\Modules\Item\Property\Models

Properties
Name Type Description

id

int

The unique ID of the property group

backendName

string

The back end name of the property group. This name is not visible to customers.

orderPropertyGroupingType

string

Indicates how order properties are grouped for selection in the order process. This parameter is applicable to order properties of the type None only.<ul><li>none = Order properties are not grouped.</li><li>single = One of the grouped order properties can be selected from the drop-down list.</li><li>multi = Multiple order properties can be selected.</li></ul>

isSurchargePercental

bool

Flag that indicates if surcharge values are calculated in percent.

ottoComponentId

int

updatedAt

string

The time the property group was last updated.

names

array

properties

array

Methods
public toArray()

Returns this model as an array.

PropertyGroupName

The PropertyGroupName including PropertyGroup

Namespace

Plenty\Modules\Item\Property\Models

Properties
Name Type Description

propertyGroupId

int

lang

string

name

string

description

string

propertyGroup

PropertyGroup

Methods
public toArray()

Returns this model as an array.

PropertyMarketReference

The PropertyMarketReference including Property

Namespace

Plenty\Modules\Item\Property\Models

Properties
Name Type Description

propertyId

int

The unique ID of the property

componentId

int

The unique ID of the reference for the market

marketId

float

The unique ID of the market

externalComponent

string

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
Name Type Description

propertyId

int

The unique ID of the property

lang

string

The language code of the property name

name

string

The name of the property. The property name is displayed in the online store.

description

string

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
Name Type Description

id

int

The unique ID of the selection

propertyId

int

The unique ID of the property

lang

string

The code of the language for which name and description of the selection were saved.

name

string

The name of the selection. The name is displayed in the online store.

description

string

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($data, $salesPriceId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceAccount
Return type: SalesPriceAccount

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

Parameters

Name

Type

Description

$data

array

The account data as an associative array

$salesPriceId

int

The unique ID of the sales price

public delete($salesPriceId, $accountType, $accountId):Plenty\Repositories\Models\DeleteResponse
Return type: 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

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

$accountType

int

The type of the referrer account linked to the sales price

$accountId

int

The ID of the referrer account linked to the sales price

public findOne($salesPriceId, $accountType, $accountId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceAccount
Return type: 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

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

$accountType

int

The type of the referrer account linked to the sales price

$accountId

int

The ID of the referrer account linked to the sales price

public findByPriceId($salesPriceId):array

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

Parameters

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

public deleteByPriceId($salesPriceId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$salesPriceId

int

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($data, $salesPriceId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceCountry
Return type: SalesPriceCountry

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

Parameters

Name

Type

Description

$data

array

The sales price country data as an associative array.

$salesPriceId

int

The unique ID of the sales price

public delete($salesPriceId, $countryId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$salesPriceId

int

The ID of the sales price

$countryId

int

The unique ID of the <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">country</a>; -1 = all countries.

public findOne($salesPriceId, $countryId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceCountry
Return type: SalesPriceCountry

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

Parameters

Name

Type

Description

$salesPriceId

int

The ID of the sales price

$countryId

int

The unique ID of the <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">country</a>.

public findByPriceId($salesPriceId):array

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

Parameters

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

public deleteByPriceId($salesPriceId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$salesPriceId

int

The ID of the sales price

SalesPriceCurrencyRepositoryContract

The contract for the sales price currency repository

Namespace

Plenty\Modules\Item\SalesPrice\Contracts

Methods
public create($data, $salesPriceId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceCurrency
Return type: SalesPriceCurrency

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

Parameters

Name

Type

Description

$data

array

The sales price currency data as an associative array

$salesPriceId

int

The unique ID of the sales price

public delete($salesPriceId, $currency):Plenty\Repositories\Models\DeleteResponse
Return type: 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

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

$currency

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#currencies" target="_blank">ISO</a> code of the currency; -1 = all currencies.

public findOne($salesPriceId, $currency):Plenty\Modules\Item\SalesPrice\Models\SalesPriceCurrency
Return type: SalesPriceCurrency

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

Parameters

Name

Type

Description

$salesPriceId

int

The ID of the sales price

$currency

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#currencies" target="_blank">ISO</a> code of the currency; -1 = all currencies.

public findByPriceId($salesPriceId):array

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

Parameters

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

public deleteByPriceId($salesPriceId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$salesPriceId

int

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($data, $salesPriceId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceCustomerClass
Return type: SalesPriceCustomerClass

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

Parameters

Name

Type

Description

$data

array

The customer class data as an associative array

$salesPriceId

int

The unique ID of the sales price

public delete($salesPriceId, $customerClassId):Plenty\Repositories\Models\DeleteResponse
Return type: 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

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

$customerClassId

int

The unique ID of the customer class

public findOne($salesPriceId, $customerClassId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceCustomerClass
Return type: 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

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

$customerClassId

int

The unique ID of the customer class

public findByPriceId($salesPriceId):array

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

Parameters

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

public deleteByPriceId($salesPriceId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$salesPriceId

int

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($data, $salesPriceId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceName
Return type: SalesPriceName

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

Parameters

Name

Type

Description

$data

array

The sales price name data as an associative array

$salesPriceId

int

The unique ID of the sales price

public update($data, $salesPriceId, $lang):Plenty\Modules\Item\SalesPrice\Models\SalesPriceName
Return type: SalesPriceName

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

Parameters

Name

Type

Description

$data

array

The sales price name data as an associative array

$salesPriceId

int

The unique ID of the sales price

$lang

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language code</a> of the sales price name

public delete($salesPriceId, $lang):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

$lang

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language code</a> of the sales price name

public findOne($salesPriceId, $lang):Plenty\Modules\Item\SalesPrice\Models\SalesPriceName
Return type: SalesPriceName

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

Parameters

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

$lang

string

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language code</a> of the sales price name

public findByPriceId($salesPriceId):array

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

Parameters

Name

Type

Description

$salesPriceId

int

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($data, $salesPriceId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceOnlineStore
Return type: SalesPriceOnlineStore

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

Parameters

Name

Type

Description

$data

array

The client (store) data as an associative array

$salesPriceId

int

The unique ID of the sales price

public delete($salesPriceId, $onlineStoreId):Plenty\Repositories\Models\DeleteResponse
Return type: 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

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

$onlineStoreId

int

The unique ID of the client (store)

public deleteByPriceId($salesPriceId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

public findOne($salesPriceId, $onlineStoreId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceOnlineStore
Return type: 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

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

$onlineStoreId

int

The ID of the online store

public findByPriceId($salesPriceId):array

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

Parameters

Name

Type

Description

$salesPriceId

int

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($data, $salesPriceId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceReferrer
Return type: SalesPriceReferrer

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

Parameters

Name

Type

Description

$data

array

The sales price referrer data as an associative array

$salesPriceId

int

The unique ID of the sales price

public delete($salesPriceId, $referrerId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

$referrerId

int

The ID of the referrer

public findOne($salesPriceId, $referrerId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceReferrer
Return type: SalesPriceReferrer

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

Parameters

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

$referrerId

int

The ID of the referrer

public findByPriceId($salesPriceId):array

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

Parameters

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

public deleteByPriceId($salesPriceId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$salesPriceId

int

The unique ID of the sales price

SalesPriceRepositoryContract

The contract for the sales price repository

Namespace

Plenty\Modules\Item\SalesPrice\Contracts

Methods
public show($salesPriceId):Plenty\Modules\Item\SalesPrice\Models\SalesPrice
Return type: SalesPrice

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

Parameters

Name

Type

Description

$salesPriceId

int

The ID of the sales price

public create($data):Plenty\Modules\Item\SalesPrice\Models\SalesPrice
Return type: SalesPrice

Creates a sales price.

Parameters

Name

Type

Description

$data

array

The sales price data as an associative array

public update($data, $salesPriceId):Plenty\Modules\Item\SalesPrice\Models\SalesPrice
Return type: SalesPrice

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

Parameters

Name

Type

Description

$data

array

The sales price data as an associative array

$salesPriceId

int

The ID of the sales price

public delete($salesPriceId):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

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

Parameters

Name

Type

Description

$salesPriceId

int

The ID of the sales price

public findById($salesPriceId):Plenty\Modules\Item\SalesPrice\Models\SalesPrice
Return type: SalesPrice

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

Parameters

Name

Type

Description

$salesPriceId

int

The ID of the sales price

public all($columns = [], $perPage = 50, $page = 1):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult

Lists all sales prices.

Parameters

Name

Type

Description

$columns

array

An array of the shown columns. All columns are returned by default.

$perPage

int

The amount of sales prices shown per page. Default value is 50

$page

int

The shown page. Default value is 1

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

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

Name

Type

Description

$request

SalesPriceSearchRequest

public searchAll($request):array
Parameters

Name

Type

Description

$request

SalesPriceSearchRequest

Models

SalesPrice

The item sales price model.

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties
Name Type Description

id

int

The unique ID of the sales price

position

int

The position of the sales price

minimumOrderQuantity

float

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.

type

string

The price type of the sales price.<ul><li>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.</li><li>Special offer = Sales price as a special offer. Special offers are used for markets, e.g. Amazon and Hitmeister.</li></ul>

isCustomerPrice

bool

Flag that indicates if the sales price is a customer price. Currently, this setting is not in use.

isDisplayedByDefault

bool

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.

isLiveConversion

bool

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.

interval

string

The interval of the price. Possible values are: daily, weekly, monthly, quarterly, semi-annual and annual.

createdAt

string

The time the sales price was created.

updatedAt

string

The time the sales price was last updated.

names

array

names

accounts

array

accounts

countries

array

countries

currencies

array

currencies

customerClasses

array

customerClasses

referrers

array

referrer

clients

array

clients

Methods
public toArray()

Returns this model as an array.

SalesPriceAccount

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties
Name Type Description

salesPriceId

int

The unique ID of the sales price

referrerId

int

The ID of the referrer linked to the sales price

accountId

int

The ID of the referrer account linked to the sales price

createdAt

string

The time the referrer account was linked to the sales price.

updatedAt

string

The time the link was last updated.

Methods
public toArray()

Returns this model as an array.

SalesPriceCountry

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties
Name Type Description

salesPriceId

int

The unique ID of the sales price

countryId

int

The unique ID of the <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">country</a>

createdAt

string

The time the country was activated.

updatedAt

string

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
Name Type Description

salesPriceId

int

The unique ID of the sales price

currency

string

The ISO code of the <a href="https://developers.plentymarkets.com/rest-doc/introduction#currencies" target="_blank">currency</a>; -1 = all currencies.

createdAt

string

The time the currency was activated.

updatedAt

string

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
Name Type Description

salesPriceId

int

The unique ID of the sales price

customerClassId

int

The unique ID of the customer class

createdAt

string

The time the customer class was activated.

updatedAt

string

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
Name Type Description

salesPriceId

int

The unique ID of the sales price

lang

string

The <a href='https://developers.plentymarkets.com/rest-doc/introduction#languages' target='_blank'>language code</a> of the sales price name

nameInternal

string

The internal name of the sales price. The internal name is used in the plentymarkets back end only.

nameExternal

string

The external name of the sales price. The external name is displayed in the online store and as such is visible for customers.

createdAt

string

The time the name was created.

updatedAt

string

The time the name was last updated.

Methods
public toArray()

Returns this model as an array.

SalesPriceOnlineStore

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties
Name Type Description

salesPriceId

int

The unique ID of the sales price

plentyId

int

The unique ID of the client (store)

createdAt

string

The time the client (store) was activated.

updatedAt

string

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
Name Type Description

salesPriceId

int

The unique ID of the sales price

referrerId

float

The unique ID of the referrer

createdAt

string

The time the referrer was activated.

updatedAt

string

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
Name Type Description

variationId

int

type

string

plentyId

int

customerClassId

int

countryId

int

currency

string

accountId

int

accountType

string

referrerId

int

quantity

int

ignoreType

bool

vatId

int

customsTariffNumber

string

defaultPriceOnly

bool

Methods
public toArray()

Returns this model as an array.

SalesPriceSearchResponse

SalesPriceSearchResponse

Namespace

Plenty\Modules\Item\SalesPrice\Models

Properties
Name Type Description

salesPriceId

int

price

float

priceNet

float

basePrice

float

basePriceNet

float

unitPrice

float

unitPriceNet

float

customerClassDiscountPercent

float

customerClassDiscount

float

customerClassDiscountNet

float

categoryDiscountPercent

float

categoryDiscount

float

categoryDiscountNet

float

vatId

int

vatValue

float

currency

string

interval

string

conversionFactor

float

minimumOrderQuantity

float

updatedAt

string

type

string

Methods
public toArray()

Returns this model as an array.

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($data):array
Parameters

Name

Type

Description

$data

array

public toArray():array
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

AttributeValueListAggregationProcessor

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods
public process($data):array
Parameters

Name

Type

Description

$data

array

public getName():string
public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

AvailabilityAggregation

aggregation for item availabilities

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods
public getName():string
public getField():string
public getAggregation():array
public setInclude($string):void
Parameters

Name

Type

Description

$string

string

public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

AvailabilityAggregationProcessor

aggregation processor for item availabilities

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods
public process($data):array
Parameters

Name

Type

Description

$data

array

public getName():void
public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

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($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

CategoryAllTermsAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods
public getName():string
public getField():void
public setSize($size = 10):void
Parameters

Name

Type

Description

$size

public getAggregation():array
public setInclude($string):void
Parameters

Name

Type

Description

$string

string

public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

CategoryBranchTermsAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods
public getName():string
public getField():void
public getAggregation():array
public setInclude($string):void
Parameters

Name

Type

Description

$string

string

public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

CategoryProcessor

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods
public process($data):array
Parameters

Name

Type

Description

$data

array

public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

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($data):array
Parameters

Name

Type

Description

$data

array

public toArray():array
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$page

int

$rowsPerPage

int

public getSources():void

FacetAggregationProcessor

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods
public process($data):array
Parameters

Name

Type

Description

$data

array

public getName():string
public getDependencies():array
public addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$mutator

MutatorInterface

public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor
Return type: Processor
Parameters

Name

Type

Description

$conditions

ConditionInterface

FacetFacetTermsAggregation

To be written

Namespace

Plenty\Modules\Item\Search\Aggregations

Methods
public getName():string
public getField():void
public getAggregation():array
public setInclude($string):void
Parameters

Name

Type

Description

$string

string

public toArray():array
public process($data):array
Parameters

Name

Type

Description

$data

array

public addAggregation($aggregation):void
Parameters

Name

Type

Description

$aggregation

AggregationInterface

public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type

Description

$source

SourceInterface

public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterface
Return type: AggregationInterface
Parameters

Name

Type