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\AttributeEbayCorrelationReturn type: AttributeEbayCorrelation
Creates new ebay attribute correlation
Name |
Type |
Description |
|
public show($id, $with = []):Plenty\Modules\Item\Attribute\Models\AttributeEbayCorrelationReturn type: AttributeEbayCorrelation
Gets an ebay attribute correlation. The ID of the attribute correlation must be specified.
Name |
Type |
Description |
|
The ID of the ebay attribute correlation |
|
|
public update($id, $data):Plenty\Modules\Item\Attribute\Models\AttributeEbayCorrelationReturn type: AttributeEbayCorrelation
Updates an ebay attribute correlation. The ID of the attribute correlation must be specified.
Name |
Type |
Description |
|
The ID of the ebay attribute correlation |
|
|
public delete($id):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes an ebay attribute correlation. The ID of the attribute correlation must be specified.
Name |
Type |
Description |
|
The ID of the ebay attribute correlation |
public get($id):Plenty\Modules\Item\Attribute\Models\AttributeEbayCorrelationReturn type: AttributeEbayCorrelation
Gets an ebay attribute correlation. The ID of the attribute correlation must be specified.
Name |
Type |
Description |
|
The ID of the ebay attribute correlation |
public search($perPage = 50, $page = 1, $filters = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Lists ebay attribute correlations by filters.
Name |
Type |
Description |
|
||
|
||
|
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies 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\AttributeMapReturn type: AttributeMap
Creates a new attribute map.
Name |
Type |
Description |
|
public find($attributeId, $marketId):Plenty\Modules\Item\Attribute\Models\AttributeMapReturn type: AttributeMap
Gets an attribute map. The ID of the attribute and the ID of the market must be specified.
Name |
Type |
Description |
|
||
|
public all($columns = [], $perPage = 50, $page = 1, $filter = [], $with = []):arrayLists all attribute maps.
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
public update($data, $attributeId, $marketId):Plenty\Modules\Item\Attribute\Models\AttributeMapReturn type: AttributeMap
Updates an attribute map. The ID of the attribute and the ID of the market must be specified.
Name |
Type |
Description |
|
||
|
||
|
public delete($attributeId, $marketId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes an attribute map. The ID of the attribute and the ID of the market must be specified.
Name |
Type |
Description |
|
||
|
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
AttributeNameRepositoryContract
The contract for the attribute name repository
Namespace
Plenty\Modules\Item\Attribute\Contracts
Methods
public create($data, $attributeId):Plenty\Modules\Item\Attribute\Models\AttributeNameReturn type: AttributeName
Creates an attribute name. The ID of the attribute must be specified.
Name |
Type |
Description |
|
The attribute name data as associative array |
|
|
The ID of the attribute ID |
public delete($attributeId, $lang):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes an attribute name. The ID of the attribute and the language must be specified.
Name |
Type |
Description |
|
The ID of the attribute |
|
|
The lang of the attribute name |
public update($data, $attributeId, $lang):Plenty\Modules\Item\Attribute\Models\AttributeNameReturn type: AttributeName
Updates an attribute name. The ID of the attribute and the language must be specified.
Name |
Type |
Description |
|
The attribute name data as associative array |
|
|
The ID of the attribute |
|
|
The lang of the attribute name |
public findOne($attributeId, $lang):Plenty\Modules\Item\Attribute\Models\AttributeNameReturn type: AttributeName
Gets an attribute name. The ID of the attribute and the language must be specified.
Name |
Type |
Description |
|
The ID of the attribute |
|
|
The lang of the attribute name |
public findByAttributeId($attributeId):Plenty\Modules\Item\Attribute\Models\AttributeNameReturn type: AttributeName
Lists attribute names. The ID of the attribute must be specified.
Name |
Type |
Description |
|
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\AttributeReturn type: Attribute
Creates new attribute
Name |
Type |
Description |
|
The attribute data as associative array |
public show($id, $with = []):Plenty\Modules\Item\Attribute\Models\AttributeReturn type: Attribute
Gets an attribute. The ID of the attribute must be specified.
Name |
Type |
Description |
|
The ID of the attribute |
|
|
An array of the with params |
public update($data, $id):Plenty\Modules\Item\Attribute\Models\AttributeReturn type: Attribute
Updates an attribute. The ID of the attribute must be specified.
Name |
Type |
Description |
|
The attribute data as associative array |
|
|
The ID of the attribute |
public delete($id):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes an attribute. The ID of the attribute must be specified.
Name |
Type |
Description |
|
The ID of the attribute |
public findById($id):Plenty\Modules\Item\Attribute\Models\AttributeReturn type: Attribute
Gets an attribute. The ID of the attribute must be specified.
Name |
Type |
Description |
|
The ID of the attribute |
public findByBackendName($backendName):Plenty\Modules\Item\Attribute\Models\AttributeReturn type: Attribute
Gets an attribute. The backend name of the attribute must be specified.
Name |
Type |
Description |
|
public all($columns = [], $perPage = 50, $page = 1, $filter = [], $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Lists all attributes.
Name |
Type |
Description |
|
An array of the shown columns. All columns are returned by default. |
|
|
The attributes shown per page. Default value is 50. |
|
|
The shown page. Default value is 1. |
|
|
||
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
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\AttributeValueImageReturn type: AttributeValueImage
Get an attribute value image link
Name |
Type |
Description |
|
The unique ID of the item ID |
|
|
The unique ID of the image |
|
|
The unique ID of the attribute value |
public create($data):Plenty\Modules\Item\Attribute\Models\AttributeValueImageReturn type: AttributeValueImage
Create an attribute value image link
Name |
Type |
Description |
|
The attribute value image data as an associative array |
public delete($itemId, $imageId, $valueId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Delete an attribute value image link
Name |
Type |
Description |
|
The ID of the item |
|
|
The ID of the image |
|
|
The ID of the attribute value |
public update($data, $itemId, $imageId, $valueId):Plenty\Modules\Item\Attribute\Models\AttributeValueImageReturn type: AttributeValueImage
Updates an attribute value image link
Name |
Type |
Description |
|
The attribute value image data as an associative array |
|
|
The unique ID of the item |
|
|
The unique ID of the image |
|
|
The unique ID of the attribute value |
public search():Illuminate\Support\CollectionReturn type: Collection
List attribute value image links
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
AttributeValueMapRepositoryContract
The contract for the attribute value map repository
Namespace
Plenty\Modules\Item\Attribute\Contracts
Methods
public create($data):Plenty\Modules\Item\Attribute\Models\AttributeValueMapReturn type: AttributeValueMap
Creates a new attribute value map.
Name |
Type |
Description |
|
public find($attributeId, $attributeValueId, $marketId):Plenty\Modules\Item\Attribute\Models\AttributeValueMapReturn 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.
Name |
Type |
Description |
|
||
|
||
|
public all($columns = [], $perPage = 50, $page = 1, $filter = [], $with = []):arrayLists all attribute value maps.
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
public update($data, $attributeId, $attributeValueId, $marketId):Plenty\Modules\Item\Attribute\Models\AttributeValueMapReturn 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.
Name |
Type |
Description |
|
||
|
||
|
||
|
public delete($attributeId, $attributeValueId, $marketId):Plenty\Repositories\Models\DeleteResponseReturn 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.
Name |
Type |
Description |
|
||
|
||
|
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
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\AttributeValueMarketNameReturn type: AttributeValueMarketName
Creates an attribute value market name. The ID of the attribute value must be specified.
Name |
Type |
Description |
|
The attribute value market name data as associative array |
public delete($valueId, $lang, $referenceType):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes an attribute value market name. The ID of the attribute value and the language must be specified.
Name |
Type |
Description |
|
The ID of the attribute value |
|
|
The lang of the attribute value name |
|
|
The referenceType of the attribute value name |
public update($data, $valueId, $lang, $referenceType):Plenty\Modules\Item\Attribute\Models\AttributeValueMarketNameReturn type: AttributeValueMarketName
Updates an attribute value market name. The ID of the attribute value and the language must be specified.
Name |
Type |
Description |
|
The attribute value market name data as associative array |
|
|
The ID of the attribute value |
|
|
The lang of the attribute value market name |
|
|
The referenceType of the attribute value name |
public findOne($valueId, $lang, $referenceType):Plenty\Modules\Item\Attribute\Models\AttributeValueMarketNameReturn type: AttributeValueMarketName
Gets an attribute value market name. The ID of the attribute value and the language must be specified.
Name |
Type |
Description |
|
The ID of the attribute value |
|
|
The lang of the attribute value name |
|
|
The referenceType of the attribute value name |
public findByAttributeId($valueId, $lang):arrayLists attribute value market names. The ID of the attribute and the language must be specified.
Name |
Type |
Description |
|
The ID of the attribute |
|
|
The lang of the attribute value name |
public search($page, $itemsPerPage):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Search attribute value market names.
Name |
Type |
Description |
|
||
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
AttributeValueNameRepositoryContract
The contract for the attribute value name repository
Namespace
Plenty\Modules\Item\Attribute\Contracts
Methods
public create($data, $valueId):Plenty\Modules\Item\Attribute\Models\AttributeValueNameReturn type: AttributeValueName
Creates an attribute value name. The ID of the attribute value must be specified.
Name |
Type |
Description |
|
The attribute value name data as associative array |
|
|
The ID of the attribute value |
public delete($valueId, $lang):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes an attribute value name. The ID of the attribute value and the language must be specified.
Name |
Type |
Description |
|
The ID of the attribute value |
|
|
The lang of the attribute value name |
public update($data, $valueId, $lang):Plenty\Modules\Item\Attribute\Models\AttributeValueNameReturn type: AttributeValueName
Updates an attribute value name. The ID of the attribute value and the language must be specified.
Name |
Type |
Description |
|
The attribute value name data as associative array |
|
|
The ID of the attribute value |
|
|
The lang of the attribute value name |
public findOne($valueId, $lang):Plenty\Modules\Item\Attribute\Models\AttributeValueNameReturn type: AttributeValueName
Gets an attribute value name. The ID of the attribute value and the language must be specified.
Name |
Type |
Description |
|
The ID of the attribute value |
|
|
The lang of the attribute value name |
public findByValueId($valueId):Plenty\Modules\Item\Attribute\Models\AttributeValueNameReturn type: AttributeValueName
Lists attribute value names. The ID of the attribute value must be specified.
Name |
Type |
Description |
|
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\AttributeValueReturn type: AttributeValue
Creates an attribute value. The ID of the attribute must be specified.
Name |
Type |
Description |
|
The attribute value data as associative array |
|
|
The ID of the attribute |
public update($data, $attributeId, $id):Plenty\Modules\Item\Attribute\Models\AttributeValueReturn type: AttributeValue
Updates an attribute value. The ID of the attribute and the ID of the value must be specified.
Name |
Type |
Description |
|
The attribute value data as associative array |
|
|
The ID of the attribute |
|
|
The ID of the value |
public delete($attributeId, $id):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes an attribute value. The ID of the attribute and the ID of the value must be specified.
Name |
Type |
Description |
|
The ID of the attribute |
|
|
The ID of the value |
public findByAttributeId($attributeId, $page = 1, $perPage = 50, $columns = [], $filter = [], $with = []):arrayLists attribute values. The ID of the attribute must be specified.
Name |
Type |
Description |
|
The ID of the attribute |
|
|
The shown page. Default value is 1. |
|
|
The amount of attribute values shown per page. Default value is 50 |
|
|
An array of the shown columns. All columns are returned by default. |
|
|
||
|
public findById($attributeId, $id, $with = []):Plenty\Modules\Item\Attribute\Models\AttributeValueReturn type: AttributeValue
Gets a attribute value. The ID of the attribute and the ID of the value must be specified.
Name |
Type |
Description |
|
The ID of the attribute |
|
|
The ID of the value |
|
|
An array of the with params |
public findOne($valueId):Plenty\Modules\Item\Attribute\Models\AttributeValueReturn type: AttributeValue
Gets a attribute value. The ID of the value must be specified.
Name |
Type |
Description |
|
public all($columns = [], $perPage = 50):arrayLists all attribute values.
Name |
Type |
Description |
|
An array of the shown columns. All columns are returned by default. |
|
|
The amount of attribute values shown per page. Default value is 50. |
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
AttributeValueSetRepositoryContract
The contract for the attribute value set repository
Namespace
Plenty\Modules\Item\Attribute\Contracts
Methods
public search($filters = []):Illuminate\Support\CollectionReturn type: Collection
List attribute value sets
Name |
Type |
Description |
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
Attribute
The Attribute model including AttributeName and AttributeValue
Namespace
Plenty\Modules\Item\Attribute\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the attribute. |
|
backendName |
The back end name of the attribute. The name must be unique and must not contain commas, colons, semicolons or quotation marks. It is not visible in the plentymarkets front end. |
|
position |
The position of the attribute. Attributes are displayed in the attribute overview in ascending order by position. |
|
isSurchargePercental |
Flag that indicates if the surcharge is percental. |
|
isLinkableToImage |
Flag that indicates if an image can be linked to the attribute. |
|
amazonAttribute |
The attribute of the market Amazon that this attribute is liked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. Check documentation of the market for permitted values. |
|
fruugoAttribute |
The attribute of the market Fruugo that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. |
|
pixmaniaAttribute |
The attribute of the market PIXmania that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. Check documentation of the market for permitted values. |
|
ottoAttribute |
The attribute of the market OTTO that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. |
|
googleShoppingAttribute |
The attribute of the market Google Shopping that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. |
|
neckermannAtEpAttribute |
The component of the market neckermann AT EP that this attribute is linked to. To list variations on this market, attributes must be linked to one of the components specified by the market. Check documentation of the market for permitted values. |
|
typeOfSelectionInOnlineStore |
How customers can select the attribute in the front end of a client. To allow attribute selection by check mark, attribute availability must be checked on the client side. |
|
laRedouteAttribute |
The attribute of the market La Redoute that this attribute is linked to. To list variations on this market, attributes must be linked to one of the attributes specified by the market. Check documentation of the market for permitted values. |
|
isGroupable |
Flag that indicates if the attribute can be grouped in item lists. If yes, variations with this attribute can be shown in the ItemViewCategoriesList template first. Other attributes are nested and can only be selected after this attribute has been selected. |
|
attributeNames |
||
values |
||
maps |
Methods
public toArray()Returns this model as an array.
AttributeEbayCorrelation
The AttributeEbayCorrelation model
Namespace
Plenty\Modules\Item\Attribute\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the ebay attribute correlation. |
|
attributeId |
The ID of the attribute. |
|
ebaySiteId |
The ID of the ebay site the attribute correlation is for. |
|
ebayCategoryId |
The ID of the ebay category of an ebay site the attribute correlation is for. |
|
ebayAttributeName |
The attribute of the market eBay that this attribute is linked to. Attributes can be linked to a ebay property or can have a separate correlation. |
|
useForPictures |
Flag that indicates if the ebay attribute correlation is used for pictures. |
Methods
public toArray()Returns this model as an array.
AttributeMap
The AttributeMap model
Namespace
Plenty\Modules\Item\Attribute\Models
| Name | Type | Description |
|---|---|---|
marketId |
The unique ID of the market. |
|
attributeId |
The unique ID of the attribute. |
|
name |
The name of the attribute map. The name must be unique and must not contain commas, colons, semicolons or quotation marks. It is not visible in the plentymarkets front end. |
|
marketInformation1 |
The information regarding the marketplace. |
|
marketInformation2 |
The information regarding the marketplace. |
Methods
public toArray()Returns this model as an array.
AttributeName
The AttributeName model including Attribute
Namespace
Plenty\Modules\Item\Attribute\Models
| Name | Type | Description |
|---|---|---|
attributeId |
The id of the attribute. |
|
lang |
The <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">language</a> of the attribute. |
|
name |
The name of the attribute. This attribute name is displayed in the online store. |
|
attribute |
Methods
public toArray()Returns this model as an array.
AttributeValue
The AttributeValue model including Attribute and AttributeValueName
Namespace
Plenty\Modules\Item\Attribute\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the attribute value. |
|
attributeId |
The unique ID of the attribute associated with the attribute value. |
|
backendName |
The back end name of the attribute value. This name can only be assigned once per attribute. It is not visible in the plentymarkets front end. |
|
position |
The position of the attribute value. Attribute values are sorted in ascending order by position. |
|
image |
The name of the image associated with the attribute value; naming pattern is attr\_{valueId}. |
|
comment |
Optional comment on the attribute value. Comments are not visible in the plentymarkets front end. |
|
amazonValue |
The attribute value of the market Amazon that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the values specified by the market. Check documentation of the market for permitted values. |
|
ottoValue |
The attribute value of the market OTTO that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the attribute values specified by the market. |
|
neckermannAtEpValue |
The attribute value of the market Neckermann AT EP that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the attribute values specified by the market. Check documentation of the market for permitted values. |
|
laRedouteValue |
The attribute value of the market La Redoute that this attribute value maps to. To list variations on this market, attribute values must be linked to one of the attribute values specified by the market. Check documentation of the market for permitted values. |
|
tracdelightValue |
||
percentageDistribution |
The percentage for automatic stock distribution of attribute values. When reordering an item, the quantities of attribute values is automatically distributed among the total quantity. |
|
attribute |
||
valueNames |
||
valueMarketNames |
||
valueMaps |
Methods
public toArray()Returns this model as an array.
AttributeValueImage
The AttributeValueImage model
Namespace
Plenty\Modules\Item\Attribute\Models
| Name | Type | Description |
|---|---|---|
imageId |
The unique ID of the image |
|
itemId |
The unique ID of the item |
|
attributeId |
The unique ID of the attribute |
|
valueId |
The unique ID of the attribute value |
Methods
public toArray()Returns this model as an array.
AttributeValueMap
The AttributeValueMap model
Namespace
Plenty\Modules\Item\Attribute\Models
| Name | Type | Description |
|---|---|---|
marketId |
The unique ID of the market. |
|
attributeId |
The unique ID of the attribute. |
|
attributeValueId |
The unique ID of the attribute value. |
|
name |
The name of the attribute value map. The name must be unique and must not contain commas, colons, semicolons or quotation marks. It is not visible in the plentymarkets front end. |
|
marketInformation1 |
The information regarding the marketplace. |
|
marketInformation2 |
The information regarding the marketplace. |
Methods
public toArray()Returns this model as an array.
AttributeValueMarketName
The AttributeValueMarketName model including AttributeValue
Namespace
Plenty\Modules\Item\Attribute\Models
| Name | Type | Description |
|---|---|---|
valueId |
The unique ID of the attribute value. |
|
lang |
The <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">language</a> of the attribute value market. |
|
name |
The name of the attribute value market. |
|
name2 |
The name2 of the attribute value market. |
|
attributeId |
||
referenceType |
||
attributeValue |
Methods
public toArray()Returns this model as an array.
AttributeValueName
The AttributeValueName model including AttributeValue
Namespace
Plenty\Modules\Item\Attribute\Models
| Name | Type | Description |
|---|---|---|
valueId |
The unique ID of the attribute value. |
|
lang |
The <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">language</a> of the attribute value. |
|
name |
The name of the attribute value. This attribute value name is displayed in the online store. |
|
attributeValue |
Methods
public toArray()Returns this model as an array.
AttributeValueSet
The AttributeValueSet model
Namespace
Plenty\Modules\Item\Attribute\Models
| Name | Type | Description |
|---|---|---|
attributeValueSetId |
The ID of the attribute value set |
|
attributeId |
The ID of the attribute |
|
valueId |
The ID of the attribute value |
|
isLinkableToImage |
Flag that indicates if an image can be linked to the attribute. |
|
attributeValue |
||
attribute |
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.
Name |
Type |
Description |
|
The ID of the item availability |
public find($id):Plenty\Modules\Item\Availability\Models\AvailabilityReturn type: Availability
Gets an item availability. The ID of the availability must be specified.
Name |
Type |
Description |
|
The ID of the item availability |
public update($data):Plenty\Modules\Item\Availability\Models\AvailabilityReturn type: Availability
Updates an item availability.
Name |
Type |
Description |
|
public all():arrayLists all item availabilities.
Models
Availability
The item availability model
Namespace
Plenty\Modules\Item\Availability\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of this availability |
|
icon |
The icon of this availability |
|
averageDays |
The average delivery time in days for this availability |
|
names |
Methods
public toArray()Returns this model as an array.
AvailabilityName
The item availability name model
Namespace
Plenty\Modules\Item\Availability\Models
| Name | Type | Description |
|---|---|---|
availabilityId |
The ID of the availability that the name belongs to |
|
lang |
The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language code</a> of the availability name |
|
name |
The name of the item availability in the specified language |
Methods
public toArray()Returns this model as an array.
Barcode
Contracts
BarcodeRepositoryContract
The contract for the barcode repository
Namespace
Plenty\Modules\Item\Barcode\Contracts
Methods
public showBarcode($barcodeId):Plenty\Modules\Item\Barcode\Models\BarcodeReturn type: Barcode
Gets a barcode. The ID of the barcode must be specified.
Name |
Type |
Description |
|
The ID of the barcode. |
public createBarcode($data):Plenty\Modules\Item\Barcode\Models\BarcodeReturn type: Barcode
Creates a barcode.
Name |
Type |
Description |
|
The barcode data as associative array |
public updateBarcode($data, $barcodeId):Plenty\Modules\Item\Barcode\Models\BarcodeReturn type: Barcode
Updates a barcode. The ID of the barcode must be specified.
Name |
Type |
Description |
|
The barcode data as associative array |
|
|
The ID of the barcode. |
public deleteBarcode($barcodeId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a barcode. The ID of the barcode must be specified.
Name |
Type |
Description |
|
The unique ID of the barcode |
public findBarcodeById($barcodeId):Plenty\Modules\Item\Barcode\Models\BarcodeReturn type: Barcode
Gets a barcode. The ID of the barcode must be specified.
Name |
Type |
Description |
|
The unique ID of the barcode |
public findBarcodesByType($barcodeType, $perPage = 50):arrayLists barcodes. The type of the barcode must be specified.
Name |
Type |
Description |
|
The type of the barcode |
|
|
The number of barcodes shown per page. Default value is 50. |
public allBarcodes($columns = [], $perPage = 50, $page = 1):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Lists all barcodes.
Name |
Type |
Description |
|
An array of the shown columns. All columns are returned by default. |
|
|
The number of barcodes shown per page. Default value is 50. |
|
|
The shown page. Default value is 1. |
public createBarcodeReferrerRelation($data, $barcodeId):Plenty\Modules\Item\Barcode\Models\BarcodeLinkReferrerReturn type: BarcodeLinkReferrer
Creates new barcode referrer for specified referrer.
Name |
Type |
Description |
|
The barcode data as associative array |
|
|
The unique ID of the barcode |
public deleteBarcodeReferrerRelation($referrer, $barcodeId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes barcode referrer with specified referrer.
Name |
Type |
Description |
|
The float value of the referrer |
|
|
The unique ID of the barcode |
public findBarcodesByReferrerRelation($referrer, $perPage = 50):arrayGets barcode referrer by specified referrer.
Name |
Type |
Description |
|
The float value of the referrer |
|
|
The number of barcodes shown per page. Default value is 50. |
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
Barcode
The barcode model including barcode referrer
Namespace
Plenty\Modules\Item\Barcode\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the barcode |
|
name |
The name of the barcode |
|
type |
The type of the barcode. Possible values: GTIN_8, GTIN_13, GTIN_14, GTIN_128, ISBN, QR, CODE_128, UPC |
|
createdAt |
The time the code was created. |
|
referrers |
Methods
public toArray()Returns this model as an array.
BarcodeLinkReferrer
The barcode link referrer model including the barcode
Namespace
Plenty\Modules\Item\Barcode\Models
| Name | Type | Description |
|---|---|---|
barcodeId |
The unique ID of the barcode |
|
referrerId |
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 |
The time the barcode was created. |
|
updatedAt |
The time the barcode was last updated. |
|
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):voidThis method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Item\Search\Filter\AmazonFilterReturn type: AmazonFilter
Will return a TypeInterface filter if at least one flat file is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public getKey():stringpublic setAmazonFlatFiles($flatFiles):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemBelongsToAtLeastOneAmazonFlatFileReturn type: ItemBelongsToAtLeastOneAmazonFlatFile
Name |
Type |
Description |
|
public addAmazonFlatFile($flatFile):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemBelongsToAtLeastOneAmazonFlatFileReturn type: ItemBelongsToAtLeastOneAmazonFlatFile
Name |
Type |
Description |
|
public setAmazonFlatFilesRef($flatFilesRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemBelongsToAtLeastOneAmazonFlatFileReturn type: ItemBelongsToAtLeastOneAmazonFlatFile
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
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):voidThis method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Item\Search\Filter\ItemFilterReturn type: ItemFilter
Will return a ItemFilter if a flag is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public getKey():stringpublic setFlag($flag):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasFlagOneReturn type: ItemHasFlagOne
Name |
Type |
Description |
|
public setFlagRef($flagRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasFlagOneReturn type: ItemHasFlagOne
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
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):voidThis method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Item\Search\Filter\ItemFilterReturn type: ItemFilter
Will return a ItemFilter if a flag is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public getKey():stringpublic setFlag($flag):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasFlagTwoReturn type: ItemHasFlagTwo
Name |
Type |
Description |
|
public setFlagRef($flagRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasFlagTwoReturn type: ItemHasFlagTwo
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
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):voidThis method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Item\Search\Filter\ItemFilterReturn type: ItemFilter
Will return a ItemFilter if at least one item id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setItemIds($itemIds):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasIdsReturn type: ItemHasIds
Name |
Type |
Description |
|
public addItemId($itemId):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasIdsReturn type: ItemHasIds
Name |
Type |
Description |
|
public getKey():stringpublic setItemIdsRef($itemIdsRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasIdsReturn type: ItemHasIds
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
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):voidThis method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Item\Search\Filter\SkuFilterReturn type: SkuFilter
Will return a SkuFilter if at least accountId, marketId or status are provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public getKey():stringpublic setMarketId($marketId):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku\VariationHasSkuReturn type: VariationHasSku
Name |
Type |
Description |
|
public setAccountId($accountId):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku\VariationHasSkuReturn type: VariationHasSku
Name |
Type |
Description |
|
public setStatus($status):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku\VariationHasSkuReturn type: VariationHasSku
Name |
Type |
Description |
|
public setMarketIdRef($marketIdRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku\VariationHasSkuReturn type: VariationHasSku
Name |
Type |
Description |
|
public setAccountIdRef($accountIdRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku\VariationHasSkuReturn type: VariationHasSku
Name |
Type |
Description |
|
public setStatusRef($statusRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku\VariationHasSkuReturn type: VariationHasSku
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
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):voidThis method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Item\Search\Filter\TagFilterReturn type: TagFilter
Will return a TagFilter if at least one tag id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public setTagIds($tagIds):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Tag\VariationHasTagsReturn type: VariationHasTags
Name |
Type |
Description |
|
public addTagId($tagId):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Tag\VariationHasTagsReturn type: VariationHasTags
Name |
Type |
Description |
|
public getKey():stringpublic setTagIdsRef($tagIdsRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Tag\VariationHasTagsReturn type: VariationHasTags
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
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):voidThis method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Item\Search\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Will return a VariationBaseFilter if at least one availability is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public getKey():stringpublic setAvailabilities($availabilities):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase\VariationHasAtLeastOneAvailabilityReturn type: VariationHasAtLeastOneAvailability
Name |
Type |
Description |
|
public addAvailability($availability):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase\VariationHasAtLeastOneAvailabilityReturn type: VariationHasAtLeastOneAvailability
Name |
Type |
Description |
|
public setAvailabilitiesRef($availabilitiesRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase\VariationHasAtLeastOneAvailabilityReturn type: VariationHasAtLeastOneAvailability
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
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\VariationIsActiveReturn type: VariationIsActive
Name |
Type |
Description |
|
public setShouldBeActiveRef($shouldBeActiveRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase\VariationIsActiveReturn type: VariationIsActive
Name |
Type |
Description |
|
public setFilterData($filterData):voidThis method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Item\Search\Filter\VariationBaseFilterReturn type: VariationBaseFilter
Will return a VariationBaseFilter if shouldBeActive is defined. Otherwise null will be returned
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public getKey():stringpublic setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
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):voidThis method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Item\Search\Filter\ClientFilterReturn type: ClientFilter
Will return a ClientFilter if at least one client id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public getKey():stringpublic setClients($clients):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationClient\VariationIsVisibleForAtLeastOneClientReturn type: VariationIsVisibleForAtLeastOneClient
Name |
Type |
Description |
|
public addClient($client):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationClient\VariationIsVisibleForAtLeastOneClientReturn type: VariationIsVisibleForAtLeastOneClient
Name |
Type |
Description |
|
public setClientsRef($clientsRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationClient\VariationIsVisibleForAtLeastOneClientReturn type: VariationIsVisibleForAtLeastOneClient
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
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):voidThis method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Item\Search\Filter\MarketFilterReturn type: MarketFilter
Will return a MarketFilter if at least one market id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public getKey():stringpublic setMarketIds($marketIds):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationMarket\VariationIsVisibleForAtLeastOneMarketReturn type: VariationIsVisibleForAtLeastOneMarket
Name |
Type |
Description |
|
public addMarketId($marketId):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationMarket\VariationIsVisibleForAtLeastOneMarketReturn type: VariationIsVisibleForAtLeastOneMarket
Name |
Type |
Description |
|
public setMarketIdsRef($marketIdsRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationMarket\VariationIsVisibleForAtLeastOneMarketReturn type: VariationIsVisibleForAtLeastOneMarket
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
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):voidThis method will be called in the export process if the filter was registered as a custom filter. In the template definition this should not be called. Use the specific setter methods instead.
Name |
Type |
Description |
|
public getFilter($settings = []):Plenty\Modules\Item\Search\Filter\VariationPropertyFilterReturn type: VariationPropertyFilter
Will return a VariationPropertyFilter if at least property selection id is provided. Otherwise null is returned.
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
public getKey():stringpublic setPropertySelectionIds($propertySelectionIds):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationProperty\VariationHasAtLeastOnePropertySelectionReturn type: VariationHasAtLeastOnePropertySelection
Name |
Type |
Description |
|
public addPropertySelectionId($propertySelectionId):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationProperty\VariationHasAtLeastOnePropertySelectionReturn type: VariationHasAtLeastOnePropertySelection
Name |
Type |
Description |
|
public setPropertySelectionIdsRef($propertySelectionIdsRef):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationProperty\VariationHasAtLeastOnePropertySelectionReturn type: VariationHasAtLeastOnePropertySelection
Links a key in the settings as source of the value for $propertySelectionIds.
Name |
Type |
Description |
|
public setRequired($required):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
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\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public setIsVisible($isVisible):Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationCatalogExportFilterBuilderReturn type: VariationCatalogExportFilterBuilder
Fluent setter
Name |
Type |
Description |
|
public getKey():stringpublic setFilterData($filterData):voidThis method will be filled by the specified values in a catalog. It should be used to provide the necessary manipulation so the filter that is returned by getFilter can be consumed by the export.
Name |
Type |
Description |
|
public getFilter($settings = []):voidReturns the filter that will be given to the export
Name |
Type |
Description |
|
public getUiFilter():Plenty\Modules\Catalog\Models\Filters\CatalogUiFilterReturn type: CatalogUiFilter
Returns the UI representation of the filter
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\VariationIsActiveReturn type: VariationIsActive
public variationHasSku():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Sku\VariationHasSkuReturn type: VariationHasSku
public itemBelongsToAmazonFlatFile():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemBelongsToAtLeastOneAmazonFlatFileReturn type: ItemBelongsToAtLeastOneAmazonFlatFile
public itemHasFlagOne():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasFlagOneReturn type: ItemHasFlagOne
public itemHasFlagTwo():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasFlagTwoReturn type: ItemHasFlagTwo
public itemHasIds():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\Item\ItemHasIdsReturn type: ItemHasIds
Return type: VariationHasTags
public variationHasAtLeastOneAvailability():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationBase\VariationHasAtLeastOneAvailabilityReturn type: VariationHasAtLeastOneAvailability
public variationIsVisibleForAtLeastOneClient():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationClient\VariationIsVisibleForAtLeastOneClientReturn type: VariationIsVisibleForAtLeastOneClient
public variationIsVisibleForAtLeastOneMarket():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationMarket\VariationIsVisibleForAtLeastOneMarketReturn type: VariationIsVisibleForAtLeastOneMarket
public variationHasAtLeastOnePropertySelection():Plenty\Modules\Item\Catalog\ExportTypes\Variation\Filters\Builders\VariationProperty\VariationHasAtLeastOnePropertySelectionReturn type: 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
public search($columns, $filter = [], $params = []):Plenty\Modules\Item\DataLayer\Models\RecordListReturn type: RecordList
Name |
Type |
Description |
|
||
|
||
|
public lookup($filter = [], $params = [], $calculateNumberOfRows = false):Plenty\Modules\Item\DataLayer\Services\ItemDataLayerResultLookupReturn type: ItemDataLayerResultLookup
Name |
Type |
Description |
|
||
|
||
|
public searchWithPagination($columns, $filter = [], $params = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Name |
Type |
Description |
|
||
|
||
|
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
| Name | Type | Description |
|---|---|---|
abo |
||
addCmsPage |
||
amazonFba |
||
amazonProductType |
||
apiCondition |
||
storeSpecial |
||
bestofferAutoDeclinePrice |
||
condition |
||
crossSellingCharacter |
||
customsTariffNumber |
||
defaultShippingCost |
||
directCrossArticle |
||
ebayCategory |
||
ebayCategory2 |
||
ebayPreset |
||
ebayStoreCategory |
||
ebayStoreCategory2 |
||
epid |
||
fedas |
||
markingOne |
||
markingTwo |
||
flashFile |
||
flashHeight |
||
flashWidth |
||
free1 |
||
free2 |
||
free3 |
||
free4 |
||
free5 |
||
free6 |
||
free7 |
||
free8 |
||
free9 |
||
free10 |
||
free11 |
||
free12 |
||
free13 |
||
free14 |
||
free15 |
||
free16 |
||
free17 |
||
free18 |
||
free19 |
||
free20 |
||
ageRestriction |
||
hasAttribute |
||
id |
||
inactive |
||
createDate |
||
isPacket |
||
marketStockBuffer |
||
noCoupon |
||
producingCountryId |
||
position |
||
priceOnly4orderby |
||
producer |
||
producerId |
||
rating |
||
ratingCount |
||
revenueAccount |
||
scoActive |
||
scoMinPrice |
||
scoMinStockNet |
||
serialNumber |
||
shippingWithAmazonFba |
||
sitemapPublished |
||
storingPosition |
||
lastUpdateTimestamp |
||
type |
||
votes |
||
variationCount |
||
tradoriaCategory |
Methods
public toArray()Returns this model as an array.
ItemCrossSelling
ItemCrossSelling
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
itemId |
||
crossItemId |
||
relationship |
||
dynamic |
Methods
public toArray()Returns this model as an array.
ItemDescription
ItemDescription
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
itemId |
||
characterCache |
||
characterCacheXml |
||
characterUpdate |
||
description |
||
id |
||
keywords |
||
lang |
||
metaDescription |
||
name1 |
||
name2 |
||
name3 |
||
shortDescription |
||
technicalData |
||
urlContent |
Methods
public toArray()Returns this model as an array.
ItemProperty
ItemProperty
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
itemPropertyId |
||
propertyId |
||
propertyValue |
||
propertyValueType |
||
isOrderProperty |
||
propertyOrderMarkup |
Methods
public toArray()Returns this model as an array.
ItemShippingProfiles
ItemShippingProfiles
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
id |
||
name |
||
backendName |
||
tags |
Methods
public toArray()Returns this model as an array.
Record
Record
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
itemBase |
||
itemPropertyList |
||
itemCrossSellingList |
||
itemDescription |
||
itemShippingProfilesList |
||
variationAttributeValueList |
||
variationBarcode |
||
variationBarcodeList |
||
variationBase |
||
variationBundleComponentList |
||
variationCategoryList |
||
variationImageList |
||
variationLinkMarketplace |
||
variationLinkWebstore |
||
variationMarketStatus |
||
variationRecommendedRetailPrice |
||
variationRecommendedRetailPriceList |
||
variationRetailPrice |
||
variationRetailPriceList |
||
variationSetRetailPrice |
||
variationStandardCategory |
||
variationStock |
||
variationStockBuffer |
||
variationStockList |
||
variationSupplierList |
||
variationWarehouse |
||
variationWarehouseList |
||
variationSpecialOfferRetailPrice |
||
variationSpecialOfferRetailPriceList |
||
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
| Name | Type | Description |
|---|---|---|
attributeId |
||
attributeValueId |
Methods
public toArray()Returns this model as an array.
VariationBarcode
VariationBarcode
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
code |
||
createdTimestamp |
||
barcodeId |
||
barcodeType |
Methods
public toArray()Returns this model as an array.
VariationBase
VariationBase
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
active |
||
attributeValueSetId |
||
autoStockInvisible |
||
bundleTyp |
||
autoStockNoStockIcon |
||
autoStockPositiveStockIcon |
||
autoStockVisible |
||
availability |
||
averageOrderQuantity |
||
content |
||
unitCombinationId |
||
createdTimestamp |
||
customNumber |
||
estimatedAvailability |
||
externalId |
||
extraShippingCharge1 |
||
extraShippingCharge2 |
||
heightMm |
||
id |
||
itemId |
||
lastUpdateTimestamp |
||
lengthMm |
||
limitOrderByStockSelect |
||
mainWarehouse |
||
model |
||
operatingCostsPercent |
||
packingUnits |
||
packingUnitType |
||
parentVariationId |
||
parentItemVariationQuantity |
||
picking |
||
customsPercent |
||
position |
||
priceCalculationId |
||
primaryVariation |
||
primaryVariationId |
||
purchasePrice |
||
storageCosts |
||
transportationCosts |
||
unitId |
||
unitLoadDevice |
||
unitsContained |
||
vatId |
||
variationName |
||
weightG |
||
weightNetG |
||
maximumOrderQuantity |
||
minimumOrderQuantity |
||
intervalOrderQuantity |
||
availableUntil |
||
releaseDate |
||
widthMm |
||
propertyVariationId |
Methods
public toArray()Returns this model as an array.
VariationBundleComponent
VariationBundleComponent
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
componentVariationId |
||
componentQuantity |
||
CreatedTimestamp |
||
LastUpdateTimestamp |
Methods
public toArray()Returns this model as an array.
VariationCategory
VariationCategory
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
categoryId |
||
position |
||
neckermannPrimary |
Methods
public toArray()Returns this model as an array.
VariationImage
VariationImage
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
imageId |
||
type |
||
fileType |
||
path |
||
position |
||
lastUpdateTimestamp |
||
createTimestamp |
||
cleanImageName |
||
attributeValueId |
Methods
public toArray()Returns this model as an array.
VariationLinkMarketplace
VariationLinkMarketplace
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
created |
||
marketplaceId |
Methods
public toArray()Returns this model as an array.
VariationLinkWebstore
VariationLinkWebstore
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
created |
||
plentyId |
Methods
public toArray()Returns this model as an array.
VariationMarketStatus
VariationMarketStatus
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
id |
||
marketId |
||
marketAccountId |
||
initialSku |
||
sku |
||
parentSku |
||
active |
||
createdTimestamp |
||
lastExportTimestamp |
||
deletedTimestamp |
||
marketStatus |
||
additionalInformation |
Methods
public toArray()Returns this model as an array.
VariationRetailPrice
VariationRetailPrice
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
priceId |
||
price |
||
retailPriceNet |
||
basePrice |
||
basePriceNet |
||
unitPrice |
||
unitPriceNet |
||
orderParamsMarkup |
||
orderParamsMarkupNet |
||
classRebatePercent |
||
classRebate |
||
classRebateNet |
||
categoryRebatePercent |
||
categoryRebate |
||
categoryRebateNet |
||
vatId |
||
vatValue |
||
currency |
||
exchangeRatio |
Methods
public toArray()Returns this model as an array.
VariationSetRetailPrice
VariationSetRetailPrice
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
priceId |
||
price |
||
retailPriceNet |
||
basePrice |
||
basePriceNet |
||
unitPrice |
||
unitPriceNet |
||
orderParamsMarkup |
||
orderParamsMarkupNet |
||
classRebatePercent |
||
classRebate |
||
classRebateNet |
||
categoryRebatePercent |
||
categoryRebate |
||
categoryRebateNet |
||
vatId |
||
vatValue |
||
currency |
||
exchangeRatio |
Methods
public toArray()Returns this model as an array.
VariationSpecialOfferRetailPrice
VariationSpecialOfferRetailPrice
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
retailPriceId |
||
retailPrice |
||
retailPriceNet |
||
basePrice |
||
basePriceNet |
||
unitPrice |
||
unitPriceNet |
||
orderParamsMarkup |
||
orderParamsMarkupNet |
||
vatId |
||
vatValue |
||
currency |
||
exchangeRatio |
||
lastUpdateTimestamp |
Methods
public toArray()Returns this model as an array.
VariationStandardCategory
VariationStandardCategory
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
categoryId |
||
plentyId |
||
manually |
Methods
public toArray()Returns this model as an array.
VariationStock
VariationStock
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
warehouseId |
||
stockPhysical |
||
reservedStock |
||
reservedEbay |
||
reorderDelta |
||
stockNet |
||
updateAmazon |
||
updatePixmania |
||
warehouseType |
||
reordered |
||
reservedBundle |
||
averagePurchasePrice |
||
warehousePriority |
||
lastUpdateTimestamp |
||
lastCalculateTimestamp |
||
reservedOutOfStock |
||
reservedBasket |
Methods
public toArray()Returns this model as an array.
VariationSupplier
VariationSupplier
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
createdTimestamp |
||
deliveryTimeInDays |
||
discount |
||
discountable |
||
id |
||
itemNumber |
||
itemVariationId |
||
lastPriceQuery |
||
lastUpdateTimestamp |
||
minimumOrderValue |
||
packagingUnit |
||
purchasePrice |
||
supplierId |
Methods
public toArray()Returns this model as an array.
VariationWarehouse
VariationWarehouse
Namespace
Plenty\Modules\Item\DataLayer\Models
| Name | Type | Description |
|---|---|---|
variationId |
||
warehouseId |
||
warehouseZoneId |
||
storageLocationType |
||
reorderLevel |
||
maximumStock |
||
stockBuffer |
||
stockTurnoverInDays |
||
storageLocationId |
||
lastUpdateTimestamp |
||
createdTimestamp |
Methods
public toArray()Returns this model as an 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):floatName |
Type |
Description |
|
The ID of the item |
|
|
The ID of the referrer |
|
|
The ID of the shipping destination |
|
|
The ID of the payment method |
Item
Contracts
ItemRepositoryContract
The contract for the item repository
Namespace
Plenty\Modules\Item\Item\Contracts
Methods
public add($data):voidCreates an item.
Name |
Type |
Description |
|
The item data as an associative array |
public show($itemId, $columns = [], $lang = "de", $with = []):voidGet an item. The ID of the item must be specified.
Name |
Type |
Description |
|
The ID of the item |
|
|
The array of the shown columns. All columns are returned by default. |
|
|
The language of the item |
|
|
The relations to be loaded. |
public search($columns = [], $lang = [], $page = 1, $itemsPerPage = 50, $with = []):voidName |
Type |
Description |
|
The array of the shown columns. All columns are returned by default. |
|
|
The language of the item |
|
|
The shown page. Default value is 1. |
|
|
The items shown per page. Default value is 50. |
|
|
The relations to be loaded. |
public update($data, $itemId):Plenty\Modules\Item\Item\Models\ItemReturn type: Item
Update a item. The ID of the item must be specified.
Name |
Type |
Description |
|
||
|
public bulkUpdate($data):Illuminate\Support\CollectionReturn type: Collection
Update up to 50 items. The ID of the item must be specified.
Name |
Type |
Description |
|
public delete($itemId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Delete an item. The ID of the item must be specified.
Name |
Type |
Description |
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
Item
The item model
Namespace
Plenty\Modules\Item\Item\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of the item. The ID must be unique. |
|
position |
The position of the item |
|
itemType |
The type of the item. Because Set items are managed using a separate route, this value is always Default. |
|
stockType |
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 |
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 |
The plentymarkets user that is assigned as owner of this item. |
|
manufacturerId |
The ID of the manufacturer of the item |
|
producingCountryId |
The ID of the country in which the item was manufactured. |
|
mainVariationId |
The ID of the main variation of the item. The ID must be unique. |
|
revenueAccount |
The revenue account the item is linked to. An individual revenue account can be saved for each item in plentymarkets. If this is not done, plentymarkets automatically determines a revenue account based on the VAT rate. |
|
couponRestriction |
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 |
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 |
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 |
Timestamp of the date and time the item was created. |
|
updatedAt |
Timestamp of the last date and time the item was updated. |
|
isSubscribable |
Flag that indicates if the item can be ordered as a subscription item. If yes, the item can be ordered for delivery at regular intervals. |
|
isSerialNumber |
Flag that indicates if serial numbers are to be assigned to variations of this item to uniquely identify every item sold. Serial numbers ensure traceability of an item in case of errors or problems. |
|
isShippingPackage |
Flag that indicates if a shipping package is to be used for this item. If yes and the variation’s dimensions are entered in the <b>Settings</b> tab of a variation, the correct shipping package is assigned automatically. |
|
amazonFbaPlatform |
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 |
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 |
The Amazon product type of the item. List of IDs: https://www.plentymarkets.co.uk/manual/data-exchange/data-formats/item/ |
|
amazonFedas |
The FEDAS product classification key of the item. |
|
ebayPresetId |
The eBay preset ID. This plentymarkets ID must be specified to save values for $ebayCategory, $ebayCategory2, $ebayStoreCategory and $ebayStoreCategory2. |
|
ebayCategory |
The eBay category 1 of the item. This category is used when a new listing is created. |
|
ebayCategory2 |
The eBay category 2 of the item. This category is used when a new listing is created. |
|
ebayStoreCategory |
The ID of the eBay store category 1 of the item. This value is used for new listings. |
|
ebayStoreCategory2 |
The ID of the eBay store category 2 of the item. This value is used for new listings. |
|
rakutenCategoryId |
The ID of the Rakuten category of this item. |
|
flagOne |
Flag 1 of the item. Flags can be used to organise and filter items. Each item can be assigned up to two flags. Possible values: 1 to 31, 0 = no flag |
|
flagTwo |
Flag 2 of the item. Flags can be used to organise and filter items. Each item can be assigned up to two flags. Possible values: 1 to 11, 0 = no flag |
|
ageRestriction |
The age customers must be to purchase the item. Items with an age rating of 18+ must be linked to a shipping profile for which the PostIdent option is activated. <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 |
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 |
The content of the free text field 1. This can be displayed in the online store or on eBay. |
|
free2 |
The content of the free text field 2. This can be displayed in the online store or on eBay. |
|
free3 |
The content of the free text field 3. This can be displayed in the online store or on eBay. |
|
free4 |
The content of the free text field 4. This can be displayed in the online store or on eBay. |
|
free5 |
The content of the free text field 5. This can be displayed in the online store or on eBay. |
|
free6 |
The content of the free text field 6. This can be displayed in the online store or on eBay. |
|
free7 |
The content of the free text field 7. This can be displayed in the online store or on eBay. |
|
free8 |
The content of the free text field 8. This can be displayed in the online store or on eBay. |
|
free9 |
The content of the free text field 9. This can be displayed in the online store or on eBay. |
|
free10 |
The content of the free text field 10. This can be displayed in the online store or on eBay. |
|
free11 |
The content of the free text field 11. This can be displayed in the online store or on eBay. |
|
free12 |
The content of the free text field 12. This can be displayed in the online store or on eBay. |
|
free13 |
The content of the free text field 13. This can be displayed in the online store or on eBay. |
|
free14 |
The content of the free text field 14. This can be displayed in the online store or on eBay. |
|
free15 |
The content of the free text field 15. This can be displayed in the online store or on eBay. |
|
free16 |
The content of the free text field 16. This can be displayed in the online store or on eBay. |
|
free17 |
The content of the free text field 17. This can be displayed in the online store or on eBay. |
|
free18 |
The content of the free text field 18. This can be displayed in the online store or on eBay. |
|
free19 |
The content of the free text field 19. This can be displayed in the online store or on eBay. |
|
free20 |
The content of the free text field 20. This can be displayed in the online store or on eBay. |
|
maximumOrderQuantity |
The maximum order quantity of an item permitted per order. If a maximum order quantity is specified, no more than this quantity of any combination of the variations of the item can be ordered. Decimal values are possible to allow orders by weight or length. Default value is 0. If value is 0, the maximum order quantity is unlimited. |
|
manufacturer |
||
producingCountry |
||
texts |
||
ebayTitles |
||
itemShippingProfiles |
||
itemProperties |
||
itemCrossSelling |
||
variations |
An array of the variations of the item. |
|
itemImages |
An array of the images of the item. |
|
customsTariffNumber |
Deprecated: The customs tariff number of the item; usually a 11 digit code number based on the Harmonised System |
Methods
public toArray()Returns this model as an array.
ItemEbayTitle
The item ebay title model
Namespace
Plenty\Modules\Item\Item\Models
| Name | Type | Description |
|---|---|---|
title |
The title. |
|
itemId |
The unique ID of the item. |
|
id |
The unique ID of the ebay title. |
Methods
public toArray()Returns this model as an array.
ItemText
The item text model
Namespace
Plenty\Modules\Item\Item\Models
| Name | Type | Description |
|---|---|---|
lang |
The language of the item text. |
|
name1 |
Default name of the item displayed in the online store and used for markets. The maximum length is 240 characters. The item name is also used for structuring the item URL. |
|
name2 |
Alternative item name that can be used e.g. for markets. The maximum length is 240 characters. |
|
name3 |
Alternative item name that can be used e.g. for markets. The maximum length is 240 characters. |
|
shortDescription |
The preview text of the item. This short description text can be displayed as a teaser in item lists. |
|
metaDescription |
The meta description of the item. This description is analysed by search engines and displayed in search results. This text should be treated as an advertising text to maximise click-through from search engine result pages. Current recommended limit is 156 characters. |
|
description |
The detailed description of the item. |
|
technicalData |
Technical data of the item. |
|
keywords |
HTML meta keywords to tag the item for search engines. More than one keyword can be separated by commas. |
|
urlPath |
The item’s URL path in the online store. By default, the URL path consists of the categories and the item name. The path is assigned automatically when the item is created and is displayed as part of the URL when the item is selected in the online store. |
Methods
public toArray()Returns this model as an array.
ItemCoupon
ItemCrossSelling
Contracts
DynamicItemCrossSellingRepositoryContract
Repository for dynamic item cross-selling
Namespace
Plenty\Modules\Item\ItemCrossSelling\Contracts
Methods
public create($data):Plenty\Modules\Item\ItemCrossSelling\Models\DynamicItemCrossSellingReturn type: DynamicItemCrossSelling
Create a new dynamic cross-selling link
Name |
Type |
Description |
|
public show($itemId, $crossItemId):Plenty\Modules\Item\ItemCrossSelling\Models\DynamicItemCrossSellingReturn type: DynamicItemCrossSelling
Get one dynamic cross-selling link of an item by item ID and cross-selling item ID
Name |
Type |
Description |
|
The unique ID of the item |
|
|
The unique ID of the linked cross-selling item |
public delete($itemId, $crossItemId):Plenty\Repositories\Models\DeleteResponseReturn 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.
Name |
Type |
Description |
|
The unique ID of the item |
|
|
The unique ID of the linked cross-selling item |
public findByItemId($itemId):arrayList dynamic cross-selling links by item ID
Name |
Type |
Description |
|
The unique ID of the item |
public findAllByItemId($itemId):arrayList all dynamic cross-selling links where the given item ID occurs
Name |
Type |
Description |
|
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\ItemCrossSellingReturn type: ItemCrossSelling
Name |
Type |
Description |
|
public update($itemId, $crossItemId, $data):Plenty\Modules\Item\ItemCrossSelling\Models\ItemCrossSellingReturn type: ItemCrossSelling
Update an item cross-selling. The item ID and the cross item ID must be specified.
Name |
Type |
Description |
|
||
|
||
|
public show($itemId):Plenty\Modules\Item\ItemCrossSelling\Models\ItemCrossSellingReturn type: ItemCrossSelling
Name |
Type |
Description |
|
The unique ID of the item |
public delete($itemId, $crossItemId):boolName |
Type |
Description |
|
The unique ID of the item |
|
|
The unique ID of the linked cross-selling item |
public findByItemId($itemId):arrayName |
Type |
Description |
|
The unique ID of the item |
public findAllByItemId($itemId):arrayList all cross-selling links where the given item ID occurs
Name |
Type |
Description |
|
The unique ID of the item |
public search($itemsPerPage = 50, $page = 1):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Name |
Type |
Description |
|
||
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
DynamicItemCrossSelling
The item dynamic cross-selling model including the item
Namespace
Plenty\Modules\Item\ItemCrossSelling\Models
| Name | Type | Description |
|---|---|---|
itemId |
The unique ID of the item to which cross-selling items are linked |
|
crossItemId |
The unique ID of the cross-selling item that is linked to the item |
|
count |
The count |
|
lastUpdate |
Last update integer |
|
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
| Name | Type | Description |
|---|---|---|
itemId |
The unique ID of the item to which cross-selling items are linked |
|
crossItemId |
The unique ID of the cross-selling item that is linked to the item |
|
relationship |
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 |
Flag that indicates if the cross-selling link was generated automatically. |
|
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\ItemImageAvailabilityReturn type: ItemImageAvailability
Creates an image availability
Name |
Type |
Description |
|
The image availability data as associative array |
public delete($data):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes an image availability.
Name |
Type |
Description |
|
The image availability data as associative array |
public findByImageId($imageId):Plenty\Modules\Item\ItemImage\Models\ItemImageAvailabilityReturn type: ItemImageAvailability
Lists image availabilities. The ID of the image must be specified.
Name |
Type |
Description |
|
The ID of the image |
public findByType($imageId, $type):Plenty\Modules\Item\ItemImage\Models\ItemImageAvailabilityReturn type: ItemImageAvailability
Lists image availabilities. The ID of the image and the type must be specified.
Name |
Type |
Description |
|
The ID of the image |
|
|
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\ItemImageNameReturn type: ItemImageName
Creates an image name
Name |
Type |
Description |
|
The image name data as associative array |
public update($data, $imageId, $lang):Plenty\Modules\Item\ItemImage\Models\ItemImageNameReturn type: ItemImageName
Updates an image name. The ID of the image and the language must be specified.
Name |
Type |
Description |
|
The image name data as associative array |
|
|
The ID of the image |
|
|
The language of the image name |
public delete($imageId, $lang):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes an image name. The ID of the image and the language must be specified.
Name |
Type |
Description |
|
The ID of the image |
|
|
The language of the image name |
public findOne($imageId, $lang):Plenty\Modules\Item\ItemImage\Models\ItemImageNameReturn type: ItemImageName
Gets an image name. The ID of the image and the language must be specified.
Name |
Type |
Description |
|
The ID of the image |
|
|
The language of the image name |
public findByImageId($imageId):arrayLists all image names. The ID of the image must be specified.
Name |
Type |
Description |
|
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\ItemImageReturn type: ItemImage
Updates an image. The ID of the image must be specified.
Name |
Type |
Description |
|
The image data as associative array |
|
|
The ID of the image |
public delete($imageId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes an image. The ID of the item must be specified.
Name |
Type |
Description |
|
The ID of the image |
public show($imageId):Plenty\Modules\Item\ItemImage\Models\ItemImageReturn type: ItemImage
Shows an image. The ID of the item must be specified.
Name |
Type |
Description |
|
The ID of the image |
public findByItemId($itemId):arrayLists images. The ID of the item must be specified.
Name |
Type |
Description |
|
The ID of the image |
public findByVariationId($variationId):arrayLists images. The ID of the variation must be specified.
Name |
Type |
Description |
|
The ID of the variation |
public findByItemIdAndOriginalChecksum($itemId, $checksum):Plenty\Modules\Item\ItemImage\Models\ItemImageReturn type: ItemImage
Shows an image. The ID of the item and hash must be specified.
Name |
Type |
Description |
|
The ID of the item |
|
|
The MD5 checksum of the image |
public upload($data):Plenty\Modules\Item\ItemImage\Models\ItemImageReturn type: ItemImage
Uploads an item image
Name |
Type |
Description |
|
The image data as associative array |
public warmup($urls, $queue = "plentymarkets-command"):voidCalls a stack of image urls to prepare cache
Name |
Type |
Description |
|
array of urls to call |
|
|
name of queue |
public syncOldImagesToCDN():voidpublic clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
ItemImageSettingsRepositoryContract
Get, update or invalidate item image settings
Namespace
Plenty\Modules\Item\ItemImage\Contracts
Methods
public get():Plenty\Legacy\Models\Item\ItemImageSettingsReturn type: ItemImageSettings
public update($data):Plenty\Legacy\Models\Item\ItemImageSettingsReturn type: ItemImageSettings
Name |
Type |
Description |
|
public invalidate($path):Plenty\Legacy\Models\Item\ItemImageSettingsReturn type: ItemImageSettings
Name |
Type |
Description |
|
public invalidateStatus():voidModels
ItemImage
The ItemImage Model
Namespace
Plenty\Modules\Item\ItemImage\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the image |
|
itemId |
The unique ID of the item the image is associated with |
|
fileType |
The file format of the image. Possible file formats: jpg, jpeg, png, gif, svg |
|
path |
The path under which the image is saved. |
|
position |
The position of the image. The position is used for sorting images in the online store. |
|
createdAt |
The time the image was uploaded. |
|
updatedAt |
The time the image details were last updated. |
|
md5Checksum |
The MD5 hash value of the image file |
|
md5ChecksumOriginal |
The MD5 hash value of the original image file |
|
hasLinkedVariations |
Indicates if the item is linked with variations. Returns 1 if at least one variation is linked with the image, otherwise 0. |
|
size |
The size of the image in pixels |
|
width |
The width of the image in pixels |
|
height |
The height of the image in pixels |
|
url |
The URL under which the image can be accessed after the upload. |
|
urlMiddle |
The URL that points to the medium-sized version of the item image. |
|
urlPreview |
The URL that points to the first preview version of the item image. |
|
urlSecondPreview |
The URL that points to the second preview version of the item image. |
|
names |
Lists the image’s name details as an array. |
|
availabilities |
Lists the image’s availability details as an array. |
|
attributeValueImages |
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
| Name | Type | Description |
|---|---|---|
imageId |
The ID of the image. The ID must be unique. |
|
type |
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 |
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
| Name | Type | Description |
|---|---|---|
imageId |
The ID of the image. The ID must be unique. |
|
lang |
The language of the image name |
|
name |
The name of the image in the specified language |
|
alternate |
The alternative name of the image in the specified language |
Methods
public toArray()Returns this model as an array.
ItemImageUpload
ItemImage
Namespace
Plenty\Modules\Item\ItemImage\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of the image. The ID must be unique. |
|
itemId |
The ID of the item the image is associated with |
|
fileType |
The file format of the image. Possible file formats: JPG, JPEG, PNG, GIF, SVG |
|
path |
The path under which the image is saved. Permitted characters for file names: alphanumeric (a-z, A-Z, 0-9), hypens (-), underscores (_). |
|
position |
The position of the image. The position is used for sorting images in the online store. |
|
created |
The time the image was uploaded. |
|
updated |
The time the image details were last updated. |
|
uploadImageData |
The base64 encoded image data of the image |
|
uploadUrl |
The URL under which the image can be accessed for uploading. Permitted characters for file names: alphanumeric (a-z, A-Z, 0-9), hypens (-), underscores (_). |
|
uploadFileName |
The file name assigned to the uploaded image. Permitted characters for file names: alphanumeric (a-z, A-Z, 0-9), hypens (-), underscores (_). |
|
names |
names |
|
availabilities |
availabilities |
Methods
public toArray()Returns this model as an array.
ItemLabel
Contracts
ItemLabelRepositoryContract
The contract for the item label repository
Namespace
Plenty\Modules\Item\ItemLabel\Contracts
Methods
public generateLabel($data):stringGet a variation label
Name |
Type |
Description |
|
The required data to generate the item label |
public generateItemLabel($data):stringGet a item label
Name |
Type |
Description |
|
The required data to generate the item label |
public listTemplates():arrayList item label templates
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
ItemListingCategory
Contracts
ItemListingCategoryRepositoryContract
Search for item listing categories
Namespace
Plenty\Modules\Item\ItemListingCategory\Contracts
Methods
public search():Illuminate\Support\CollectionReturn type: Collection
Search for item listing categories
public get($id):voidGets one item listing category
Name |
Type |
Description |
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
ItemListingShopCategoryRepositoryContract
Get item listing shop categories
Namespace
Plenty\Modules\Item\ItemListingCategory\Contracts
Methods
public get($ebayAccountId):Illuminate\Support\CollectionReturn type: Collection
Get a list of listing shop categories
Name |
Type |
Description |
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
ItemProperty
Contracts
ItemPropertyRepositoryContract
The contract for the item property repository
Namespace
Plenty\Modules\Item\ItemProperty\Contracts
Methods
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
ItemProperty
ItemPropertyValue
Namespace
Plenty\Modules\Item\ItemProperty\Models
| Name | Type | Description |
|---|---|---|
id |
The id of the variation property value |
|
itemId |
The id of the variation |
|
propertyId |
The id of the property item |
|
propertySelectionId |
The id of the property selection |
|
valueInt |
The int value of the variation property value |
|
valueFloat |
The float value of the variation property value |
|
valueFile |
The file value of the variation property value |
|
surcharge |
The surcharge of the variation property value |
|
property |
||
propertySelection |
||
valueTexts |
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\PaginatedResultReturn type: PaginatedResult
Lists all serial numbers.
Name |
Type |
Description |
|
||
|
public show($id):Plenty\Modules\Item\ItemSerialNumber\Models\ItemSerialNumberReturn type: ItemSerialNumber
Gets a serial number. The ID of the serial number must be specified.
Name |
Type |
Description |
|
public create($data):Plenty\Modules\Item\ItemSerialNumber\Models\ItemSerialNumberReturn type: ItemSerialNumber
Creates a serial number
Name |
Type |
Description |
|
public update($id, $data):Plenty\Modules\Item\ItemSerialNumber\Models\ItemSerialNumberReturn type: ItemSerialNumber
Updates a serial number. The ID of the serial number must be specified.
Name |
Type |
Description |
|
||
|
public delete($id):Plenty\Repositories\Contracts\DeleteResponseContractReturn type: DeleteResponseContract
Deletes a serial number. The ID of the serial number must be specified.
Name |
Type |
Description |
|
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
Models
ItemSerialNumber
The item serial number model
Namespace
Plenty\Modules\Item\ItemSerialNumber\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of the serial number |
|
orderId |
The ID of the order |
|
orderItemId |
The ID of the order item |
|
itemId |
The ID of the item |
|
serialNumber |
The serial number |
|
createdAt |
The date the serial number was created |
Methods
public toArray()Returns this model as an array.
ItemShippingProfiles
Contracts
ItemShippingProfilesRepositoryContract
Repository for ItemShippingProfiles
Namespace
Plenty\Modules\Item\ItemShippingProfiles\Contracts
Methods
public find($id):Plenty\Modules\Item\ItemShippingProfiles\Models\ItemShippingProfilesReturn type: ItemShippingProfiles
Finds a shipping profile link by ID
Name |
Type |
Description |
|
The unique ID of the link between shipping profile and item |
public findByItemId($itemId):arrayLists all shipping profiles activated for an item
Name |
Type |
Description |
|
The unique ID of the item |
public create($data):Plenty\Modules\Item\ItemShippingProfiles\Models\ItemShippingProfilesReturn type: ItemShippingProfiles
Activates a shipping profile for an item
Name |
Type |
Description |
|
public delete($id):arrayDeactivates a shipping profile for an item
Name |
Type |
Description |
|
The unique ID of the link between shipping profile and item |
public getItemShippingProfiles($itemsPerPage, $page):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Lists all shipping profiles of all items
Name |
Type |
Description |
|
||
|
public createBulk($data):arrayActivates up to 50 shipping profiles for items
Name |
Type |
Description |
|
public deleteBulk($itemId):voidDeactivates all shipping profiles for an item
Name |
Type |
Description |
|
public deleteOne($shippingProfileId, $itemId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Delete the link between the specified shipping profile and item
Name |
Type |
Description |
|
||
|
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
Models
ItemShippingProfiles
The shipping profile model
Namespace
Plenty\Modules\Item\ItemShippingProfiles\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the link between item and shipping profile |
|
itemId |
The unique ID of the item |
|
profileId |
The unique ID of the shipping profile |
Methods
public toArray()Returns this model as an array.
Manufacturer
Contracts
ManufacturerCommissionRepositoryContract
The contract for the manufacturer commission repository
Namespace
Plenty\Modules\Item\Manufacturer\Contracts
Methods
public find($id):Plenty\Modules\Item\Manufacturer\Models\ManufacturerCommissionReturn type: ManufacturerCommission
Gets a manufacturer commission. The ID of the manufacturer commission must be specified.
Name |
Type |
Description |
|
The ID of the manufacturer |
public create($data):Plenty\Modules\Item\Manufacturer\Models\ManufacturerCommissionReturn type: ManufacturerCommission
Creates a manufacturer commission.
Name |
Type |
Description |
|
The manufacturer commission data as an associative array |
public update($data, $id):Plenty\Modules\Item\Manufacturer\Models\ManufacturerCommissionReturn type: ManufacturerCommission
Updates a manufacturer commission. The ID of the manufacturer commission must be specified.
Name |
Type |
Description |
|
The manufacturer commission data as an associative array |
|
|
The ID of the manufacturer |
public delete($id):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a manufacturer commission. The ID of the manufacturer commission must be specified.
Name |
Type |
Description |
|
The ID of the manufacturer |
public findByManufacturerId($manufacturerId):arrayLists manufacturer commissions. The ID of the manufacturer must be specified.
Name |
Type |
Description |
|
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\ManufacturerExternalReturn type: ManufacturerExternal
Gets a manufacturer external. The ID of the manufacturer and the ID of the market must be specified.
Name |
Type |
Description |
|
The ID of the manufacturer |
|
|
The ID of the market |
public create($data):Plenty\Modules\Item\Manufacturer\Models\ManufacturerExternalReturn type: ManufacturerExternal
Creates a manufacturer external.
Name |
Type |
Description |
|
The manufacturer external data as an associative array |
public update($data, $manufacturerId, $marketId):Plenty\Modules\Item\Manufacturer\Models\ManufacturerExternalReturn type: ManufacturerExternal
Updates a manufacturer external. The ID of the manufacturer and the ID of the market must be specified.
Name |
Type |
Description |
|
The manufacturer external data as an associative array |
|
|
The ID of the manufacturer |
|
|
The ID of the market |
public delete($manufacturerId, $marketId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a manufacturer external. The ID of the manufacturer and the ID of the market must be specified.
Name |
Type |
Description |
|
The ID of the manufacturer |
|
|
The ID of the market |
public search():arrayLists manufacturer externals.
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
ManufacturerRepositoryContract
The contract for the manufacturer repository
Namespace
Plenty\Modules\Item\Manufacturer\Contracts
Methods
public create($data):Plenty\Modules\Item\Manufacturer\Models\ManufacturerReturn type: Manufacturer
Creates a manufacturer.
Name |
Type |
Description |
|
The manufacturer data as an associative array |
public update($data, $manufacturerId):Plenty\Modules\Item\Manufacturer\Models\ManufacturerReturn type: Manufacturer
Updates a manufacturer. The ID of the manufacturer must be specified.
Name |
Type |
Description |
|
The manufacturer data as an associative array |
|
|
The ID of the manufacturer |
public delete($manufacturerId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a manufacturer. The ID of the manufacturer must be specified.
Name |
Type |
Description |
|
The ID of the manufacturer |
public findById($manufacturerId, $with = []):Plenty\Modules\Item\Manufacturer\Models\ManufacturerReturn type: Manufacturer
Gets a manufacturer. The ID of the manufacturer must be specified.
Name |
Type |
Description |
|
The ID of the manufacturer |
|
|
public all($columns = [], $perPage = 50, $page = 1, $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Lists all manufacturers.
Name |
Type |
Description |
|
An array of the shown columns. All columns are returned by default. |
|
|
The amount of manufacturers shown per page. Default value is 50. |
|
|
The shown page. Default value is 1. |
|
|
public search($params = [], $columns = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Lists manufacturers by filter
Name |
Type |
Description |
|
The filter array |
|
|
An array of the shown columns. All columns are returned by default. |
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
Manufacturer
The item manufacturer model
Namespace
Plenty\Modules\Item\Manufacturer\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the manufacturer. |
|
name |
The name of the manufacturer |
|
externalName |
The external name of the manufacturer. The external name is used for the item export to external markets. If no external name is saved, the Name will be used. The external name will also be transferred to FINDOLOGIC and will be indexed for item searches. |
|
logo |
The URL of the manufacturer’s logo |
|
url |
The URL of the manufacturer’s website |
|
street |
The street of the manufacturer’s address |
|
houseNo |
The house number of the manufacturer’s address |
|
postcode |
The postal code of the manufacturer’s address |
|
town |
The town of the manufacturer’s address |
|
phoneNumber |
The phone number of the manufacturer |
|
faxNumber |
The fax number of the manufacturer |
|
The email address of the manufacturer |
||
countryId |
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 |
The manufacturer’s ID on the market Pixmania |
|
neckermannAtEpBrandId |
The manufacturer’s ID on the market Neckermann Austria, Enterprise version |
|
laRedouteBrandId |
The manufacturer’s ID on the market La Redoute |
|
position |
The position of the manufacturer |
|
comment |
Internal comments about the manufacturer (optional) |
|
updatedAt |
The time the manufacturer information was last updated. |
|
commissions |
||
externals |
Methods
public toArray()Returns this model as an array.
ManufacturerCommission
The item manufacturer commission model
Namespace
Plenty\Modules\Item\Manufacturer\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the manufacturer commission |
|
manufacturerId |
The unique ID of the manufacturer |
|
plentyId |
The unique ID of the client (store) that the commission applies to. The route /rest/webstores provides access to clients (stores). |
|
referrerId |
The unique ID of the referrer that the commission applies to. The route /rest/orders/referrers provides access to referrers. |
|
commission |
The manufacturer commission value in percent |
|
manufacturer |
Methods
public toArray()Returns this model as an array.
ManufacturerExternal
The item manufacturer external model
Namespace
Plenty\Modules\Item\Manufacturer\Models
| Name | Type | Description |
|---|---|---|
manufacturerId |
The unique ID of the manufacturer |
|
marketId |
The unique ID of the market |
|
value |
The external value |
|
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):arrayGet the item variation packing units
Name |
Type |
Description |
|
Optional. The language of the packing units. If no language will be provided, all of them will be returned |
public getPackingUnitsById($id, $language = "all", $isUnitId = false):Plenty\Modules\Item\PackingUnit\Models\PackingUnitReturn type: PackingUnit
Get the item variation packing unit for a specific given id
Name |
Type |
Description |
|
The id of the packing unit |
|
|
Optional. The language of the packing units. If no language will be provided, all of them will be returned |
|
|
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
| Name | Type | Description |
|---|---|---|
id |
The id of the packing unit entry. Primary key auto-increment |
|
unitId |
The id of the packing unit as it was until now (from 0 to 39 without 33) |
|
unitNameEN |
The name of the packing unit in English |
|
unitNameDE |
The name of the packing unit in German |
Methods
public toArray()Returns this model as an array.
Property
Contracts
PropertyGroupNameRepositoryContract
The contract for the property group name repository
Namespace
Plenty\Modules\Item\Property\Contracts
Methods
public create($data, $propertyGroupId):Plenty\Modules\Item\Property\Models\PropertyGroupNameReturn type: PropertyGroupName
Creates a property group name. The ID of the property group must be specified.
Name |
Type |
Description |
|
The property group name data as an associative array |
|
|
The ID of the property group |
public delete($propertyGroupId, $lang):boolDeletes a property group name. The ID of the property group and the language must be specified.
Name |
Type |
Description |
|
The ID of the property group |
|
|
The specific language of the property group name |
public update($data, $propertyGroupId, $lang):Plenty\Modules\Item\Property\Models\PropertyGroupNameReturn type: PropertyGroupName
Updates a property group name. The ID of the property group and the language must be specified.
Name |
Type |
Description |
|
The property group name data as an associative array |
|
|
The ID of the property group |
|
|
The specific language of the property group name |
public findOne($propertyGroupId, $lang):Plenty\Modules\Item\Property\Models\PropertyGroupNameReturn type: PropertyGroupName
Gets a property group name. The ID of the property group and the language must be specified.
Name |
Type |
Description |
|
The ID of the property group |
|
|
The specific language of the property group name |
public findByPropertyGroupId($propertyGroupId):arrayLists property group names. The ID of the property group must be specified.
Name |
Type |
Description |
|
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\PropertyGroupReturn type: PropertyGroup
Creates a property group.
Name |
Type |
Description |
|
The property group data as an associative array |
public show($id):Plenty\Modules\Item\Property\Models\PropertyGroupReturn type: PropertyGroup
Gets a property group. The ID of the property group must be specified.
Name |
Type |
Description |
|
The ID of the property group |
public update($data, $id):Plenty\Modules\Item\Property\Models\PropertyGroupReturn type: PropertyGroup
Updates a property group. The ID of the property group must be specified.
Name |
Type |
Description |
|
The property group data as an associative array |
|
|
The ID of the property group |
public delete($id):boolDeletes a property group. The ID of the property group must be specified.
Name |
Type |
Description |
|
The ID of the property group |
public findById($id):Plenty\Modules\Item\Property\Models\PropertyGroupReturn type: PropertyGroup
Gets a property group. The ID of the property group must be specified.
Name |
Type |
Description |
|
The ID of the property group |
public all($columns = [], $perPage = 50, $page = 1, $with = []):arrayLists all property groups.
Name |
Type |
Description |
|
An array of the shown columns. All columns are returned by default. |
|
|
The amount of shown property groups per page. Default value is 50. |
|
|
The shown page. Default value is 1. |
|
|
public findByBackendName($backendName):Plenty\Modules\Item\Property\Models\PropertyGroupReturn type: PropertyGroup
Gets a property group. The backend name of the property group must be specified.
Name |
Type |
Description |
|
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\PropertyMarketReferenceReturn type: PropertyMarketReference
Creates a property market reference. The ID of the property must be specified.
Name |
Type |
Description |
|
The property market component data as an associative array |
|
|
The ID of the property |
public delete($propertyId, $marketReference):boolDeletes a property market reference. The ID of the property and the language must be specified.
Name |
Type |
Description |
|
The ID of the property |
|
|
The market reference value |
public update($data, $propertyId, $marketReference):Plenty\Modules\Item\Property\Models\PropertyMarketReferenceReturn type: PropertyMarketReference
Updates a property market reference. The ID of the property and the language must be specified.
Name |
Type |
Description |
|
The property market component data as an associative array |
|
|
The ID of the property |
|
|
The market reference value |
public findOne($propertyId, $marketReference):Plenty\Modules\Item\Property\Models\PropertyMarketReferenceReturn type: PropertyMarketReference
Gets a property market reference. The ID of the property and the language must be specified.
Name |
Type |
Description |
|
The ID of the property |
|
|
The market reference value |
public findByPropertyId($propertyId):Plenty\Modules\Item\Property\Models\PropertyMarketReferenceReturn type: PropertyMarketReference
List of property market references. The ID of the property must be specified.
Name |
Type |
Description |
|
The ID of the property |
public getPropertyMarketReferences($referrerId, $componentId = null, $filters = []):arrayLists all property market references.
Name |
Type |
Description |
|
The ID of the referrer |
|
|
The ID of the component |
|
|
You can pass here multiple filters. Available:
|
PropertyNameRepositoryContract
The contract for the property name repository
Namespace
Plenty\Modules\Item\Property\Contracts
Methods
public create($data, $propertyId):Plenty\Modules\Item\Property\Models\PropertyNameReturn type: PropertyName
Creates a property name. The ID of the property must be specified.
Name |
Type |
Description |
|
The property name data as an associative array |
|
|
The ID of the property |
public delete($propertyId, $lang):boolDeletes a property name. The ID of the property and the language must be specified.
Name |
Type |
Description |
|
The ID of the property |
|
|
The language of the property name |
public update($data, $propertyId, $lang):Plenty\Modules\Item\Property\Models\PropertyNameReturn type: PropertyName
Updates a property name. The ID of the property and the language must be specified.
Name |
Type |
Description |
|
The property name data as an associative array |
|
|
The ID of the property |
|
|
The language of the property name |
public findOne($propertyId, $lang):Plenty\Modules\Item\Property\Models\PropertyNameReturn type: PropertyName
Gets a property name. The ID of the property and the language must be specified.
Name |
Type |
Description |
|
The ID of the property |
|
|
The language of the property name |
public findBypropertyId($propertyId):Plenty\Modules\Item\Property\Models\PropertyNameReturn type: PropertyName
Lists property names. The ID of the property must be specified.
Name |
Type |
Description |
|
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\PropertyReturn type: Property
Creates a property.
Name |
Type |
Description |
|
The property data as an associative array |
public show($id):Plenty\Modules\Item\Property\Models\PropertyReturn type: Property
Gets a property. The ID of the property must be specified.
Name |
Type |
Description |
|
The ID of the property |
public update($data, $id):Plenty\Modules\Item\Property\Models\PropertyReturn type: Property
Updates a property. The ID of the property must be specified.
Name |
Type |
Description |
|
The property data as an associative array |
|
|
The ID of the property |
public delete($id):boolDeletes a property. The ID of the property must be specified.
Name |
Type |
Description |
|
The ID of the property |
public findById($id):Plenty\Modules\Item\Property\Models\PropertyReturn type: Property
Gets a property. The ID of the property must be specified.
Name |
Type |
Description |
|
The ID of the property |
public all($columns = [], $perPage = 50, $page = 1):arrayLists all properties.
Name |
Type |
Description |
|
An array of the shown columns. All columns are returned by default. |
|
|
The amount of attribute values shown per page. Default value is 50 |
|
|
The shown page. Default value is 1. |
public search($columns = [], $perPage = 50, $page = 1, $with = [], $filter = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Search properties.
Name |
Type |
Description |
|
An array of the shown columns. All columns are returned by default. |
|
|
The amount of attribute values shown per page. Default value is 50 |
|
|
The shown page. Default value is 1. |
|
|
||
|
public findByBackendName($backendName):Plenty\Modules\Item\Property\Models\PropertyReturn type: Property
Gets an property. The backend name of the property must be specified.
Name |
Type |
Description |
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
PropertySelectionRepositoryContract
The contract for the property selection repository
Namespace
Plenty\Modules\Item\Property\Contracts
Methods
public create($data, $propertyId):Plenty\Modules\Item\Property\Models\PropertySelectionReturn type: PropertySelection
Creates a property selection. The ID of the property must be specified.
Name |
Type |
Description |
|
The property selection data as an associative array |
|
|
The ID of the property |
public createLang($data, $propertyId, $id):Plenty\Modules\Item\Property\Models\PropertySelectionReturn type: PropertySelection
Creates a property selection lang. The ID of the property selection must be specified.
Name |
Type |
Description |
|
The property selection data as an associative array |
|
|
The ID of the property |
|
|
The ID of the property selection |
public findByProperty($propertyId, $lang = null):arrayList of property selections. The ID of the property must be specified.
Name |
Type |
Description |
|
||
|
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.
Name |
Type |
Description |
|
The ID of the property |
public deleteSelection($id):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a property selection. The ID of the property selection must be specified.
Name |
Type |
Description |
|
The ID of the property selection |
public delete($id, $lang):boolDeletes a property selection in a specified language. The ID of the property selection and the language must be specified.
Name |
Type |
Description |
|
The ID of the property selection |
|
|
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\PropertySelectionReturn type: PropertySelection
Get a property selection in the specified language. The ID of the property selection and the language must be specified.
Name |
Type |
Description |
|
The ID of the property selection |
|
|
The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language</a> of the property selection |
public findSelection($id):arrayGet a property selection. The ID of the property selection must be specified.
Name |
Type |
Description |
|
The ID of the property selection |
public update($data, $id, $lang):Plenty\Modules\Item\Property\Models\PropertySelectionReturn type: PropertySelection
Updates a property selection. The ID of the property selection and the language must be specified.
Name |
Type |
Description |
|
The property selection data as an associative array |
|
|
The ID of the property selection |
|
|
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
| Name | Type | Description |
|---|---|---|
id |
The ID of the property |
|
position |
The position of the property |
|
propertyGroupId |
The ID of the property group the property is assigned to. Value is null if property is not assigned to a property group. |
|
unit |
The unit of measurement of the property. Value is null if no unit is associated. |
|
backendName |
The backend name of the property. The back end name is not visible to customers. |
|
comment |
Internal comment/note saved for the property. Internal comments are not visible to customers. |
|
valueType |
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 |
Flag that indicates if items can be found by entering the property name as a search term. |
|
isOderProperty |
Flag that indicates if the property is available in the order process. Depending on the property type, customers e.g. can enter a text or value or select an option from a drop-down list. |
|
isShownOnItemPage |
Flag that indicates if the property will be shown on the item’s page in the online store- |
|
isShownOnItemList |
Flag that indicates if the property will be shown in the item listing in the online store. |
|
isShownAtCheckout |
Flag that indicates if the property will be shown in the order process. |
|
isShownInPdf |
Flag that indicates if the property will be shown in PDF documents. |
|
isShownAsAdditionalCosts |
Display as additional costs |
|
surcharge |
The surcharge for the property. Surcharges will automatically be added to the item price in the detailed view of an item and in the order process. The default value is 0.00, i.e. no surcharge. In the plentymarkets front end, the template variable PriceDynamic displays the price of a variation including the surcharge. |
|
updatedAt |
The time the property was last updated. |
|
names |
||
marketComponents |
||
group |
||
selections |
Methods
public toArray()Returns this model as an array.
PropertyGroup
The PropertyGroup including PropertyGroupName
Namespace
Plenty\Modules\Item\Property\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the property group |
|
backendName |
The back end name of the property group. This name is not visible to customers. |
|
orderPropertyGroupingType |
Indicates how order properties are grouped for selection in the order process. This parameter is applicable to order properties of the type None only.<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 |
Flag that indicates if surcharge values are calculated in percent. |
|
ottoComponentId |
||
updatedAt |
The time the property group was last updated. |
|
names |
||
properties |
Methods
public toArray()Returns this model as an array.
PropertyGroupName
The PropertyGroupName including PropertyGroup
Namespace
Plenty\Modules\Item\Property\Models
| Name | Type | Description |
|---|---|---|
propertyGroupId |
||
lang |
||
name |
||
description |
||
propertyGroup |
Methods
public toArray()Returns this model as an array.
PropertyMarketReference
The PropertyMarketReference including Property
Namespace
Plenty\Modules\Item\Property\Models
| Name | Type | Description |
|---|---|---|
propertyId |
The unique ID of the property |
|
componentId |
The unique ID of the reference for the market |
|
marketId |
The unique ID of the market |
|
externalComponent |
The external reference of the property |
|
property |
Methods
public toArray()Returns this model as an array.
PropertyName
The PropertyName including Property
Namespace
Plenty\Modules\Item\Property\Models
| Name | Type | Description |
|---|---|---|
propertyId |
The unique ID of the property |
|
lang |
The language code of the property name |
|
name |
The name of the property. The property name is displayed in the online store. |
|
description |
The description of the property. The property description is displayed in the online store. |
|
property |
Methods
public toArray()Returns this model as an array.
PropertySelection
The property selection including the property
Namespace
Plenty\Modules\Item\Property\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the selection |
|
propertyId |
The unique ID of the property |
|
lang |
The code of the language for which name and description of the selection were saved. |
|
name |
The name of the selection. The name is displayed in the online store. |
|
description |
The description of the selection. This description is displayed in the online store. |
|
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\SalesPriceAccountReturn type: SalesPriceAccount
Activates a referrer account for a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The account data as an associative array |
|
|
The unique ID of the sales price |
public delete($salesPriceId, $accountType, $accountId):Plenty\Repositories\Models\DeleteResponseReturn 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.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
The type of the referrer account linked to the sales price |
|
|
The ID of the referrer account linked to the sales price |
public findOne($salesPriceId, $accountType, $accountId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceAccountReturn 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.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
The type of the referrer account linked to the sales price |
|
|
The ID of the referrer account linked to the sales price |
public findByPriceId($salesPriceId):arrayLists the activated referrer accounts of a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The unique ID of the sales price |
public deleteByPriceId($salesPriceId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deactivates the referrer accounts for a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
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\SalesPriceCountryReturn type: SalesPriceCountry
Activates a country for a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The sales price country data as an associative array. |
|
|
The unique ID of the sales price |
public delete($salesPriceId, $countryId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deactivates a country for a sales price. The ID of the sales price and the ID of the country must be specified.
Name |
Type |
Description |
|
The ID of the sales price |
|
|
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\SalesPriceCountryReturn type: SalesPriceCountry
Gets a country for a sales price. The ID of the sales price and the ID of the country must be specified.
Name |
Type |
Description |
|
The ID of the sales price |
|
|
The unique ID of the <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">country</a>. |
public findByPriceId($salesPriceId):arrayLists the countries for a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The unique ID of the sales price |
public deleteByPriceId($salesPriceId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes countries from a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
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\SalesPriceCurrencyReturn type: SalesPriceCurrency
Activates a currency for a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The sales price currency data as an associative array |
|
|
The unique ID of the sales price |
public delete($salesPriceId, $currency):Plenty\Repositories\Models\DeleteResponseReturn 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.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
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\SalesPriceCurrencyReturn type: SalesPriceCurrency
Gets a sales price currency. The ID of the sales price and the ISO code of the currency must be specified.
Name |
Type |
Description |
|
The ID of the sales price |
|
|
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):arrayLists the active currencies of a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The unique ID of the sales price |
public deleteByPriceId($salesPriceId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deactivates the currencies of a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
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\SalesPriceCustomerClassReturn type: SalesPriceCustomerClass
Activates a customer class for a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The customer class data as an associative array |
|
|
The unique ID of the sales price |
public delete($salesPriceId, $customerClassId):Plenty\Repositories\Models\DeleteResponseReturn 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.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
The unique ID of the customer class |
public findOne($salesPriceId, $customerClassId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceCustomerClassReturn 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.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
The unique ID of the customer class |
public findByPriceId($salesPriceId):arrayLists the active customer classes of a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The unique ID of the sales price |
public deleteByPriceId($salesPriceId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deactivates the customer classes of a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
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\SalesPriceNameReturn type: SalesPriceName
Creates a sales price name. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The sales price name data as an associative array |
|
|
The unique ID of the sales price |
public update($data, $salesPriceId, $lang):Plenty\Modules\Item\SalesPrice\Models\SalesPriceNameReturn type: SalesPriceName
Updates a sales price name. The ID of the sales price and the language code must be specified.
Name |
Type |
Description |
|
The sales price name data as an associative array |
|
|
The unique ID of the sales price |
|
|
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\DeleteResponseReturn type: DeleteResponse
Deletes a sales price name. The ID of the sales price and the language code must be specified.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
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\SalesPriceNameReturn type: SalesPriceName
Gets a sales price name. The ID of the sales price and the language code must be specified.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language code</a> of the sales price name |
public findByPriceId($salesPriceId):arrayLists all sales price names of a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
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\SalesPriceOnlineStoreReturn type: SalesPriceOnlineStore
Activates a client (store) for a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The client (store) data as an associative array |
|
|
The unique ID of the sales price |
public delete($salesPriceId, $onlineStoreId):Plenty\Repositories\Models\DeleteResponseReturn 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.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
The unique ID of the client (store) |
public deleteByPriceId($salesPriceId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deactivates all clients (stores) for a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The unique ID of the sales price |
public findOne($salesPriceId, $onlineStoreId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceOnlineStoreReturn 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.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
The ID of the online store |
public findByPriceId($salesPriceId):arrayLists the active clients (stores) for a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
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\SalesPriceReferrerReturn type: SalesPriceReferrer
Activates a referrer for a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The sales price referrer data as an associative array |
|
|
The unique ID of the sales price |
public delete($salesPriceId, $referrerId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deactivates a referrer for a sales price. The ID of the sales price and the ID of the referrer must be specified.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
The ID of the referrer |
public findOne($salesPriceId, $referrerId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceReferrerReturn type: SalesPriceReferrer
Gets a referrer. The ID of the sales price and the ID of the referrer must be specified.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
The ID of the referrer |
public findByPriceId($salesPriceId):arrayLists all activated referrers of a sales. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The unique ID of the sales price |
public deleteByPriceId($salesPriceId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deactivates all referrers for a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
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\SalesPriceReturn type: SalesPrice
Gets a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The ID of the sales price |
public create($data):Plenty\Modules\Item\SalesPrice\Models\SalesPriceReturn type: SalesPrice
Creates a sales price.
Name |
Type |
Description |
|
The sales price data as an associative array |
public update($data, $salesPriceId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceReturn type: SalesPrice
Updates a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The sales price data as an associative array |
|
|
The ID of the sales price |
public delete($salesPriceId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The ID of the sales price |
public findById($salesPriceId):Plenty\Modules\Item\SalesPrice\Models\SalesPriceReturn type: SalesPrice
Gets a sales price. The ID of the sales price must be specified.
Name |
Type |
Description |
|
The ID of the sales price |
public all($columns = [], $perPage = 50, $page = 1):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Lists all sales prices.
Name |
Type |
Description |
|
An array of the shown columns. All columns are returned by default. |
|
|
The amount of sales prices shown per page. Default value is 50 |
|
|
The shown page. Default value is 1 |
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
SalesPriceSearchRepositoryContract
The contract for the sales price search repository
Namespace
Plenty\Modules\Item\SalesPrice\Contracts
Methods
public search($request):Plenty\Modules\Item\SalesPrice\Models\SalesPriceSearchResponseReturn type: SalesPriceSearchResponse
Name |
Type |
Description |
|
public searchAll($request):arrayName |
Type |
Description |
|
Models
SalesPrice
The item sales price model.
Namespace
Plenty\Modules\Item\SalesPrice\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the sales price |
|
position |
The position of the sales price |
|
minimumOrderQuantity |
The minimum order quantity of the sales price. Sales prices with different minimum quantities can be used to create a quantity based graduation of prices in plentymarkets. |
|
type |
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 |
Flag that indicates if the sales price is a customer price. Currently, this setting is not in use. |
|
isDisplayedByDefault |
Flag that indicates if the sales price is displayed automatically in the Sales Prices area of the plentymarkets backend when a new item is created. When false, the sales price can still be added manually when a new item is created. |
|
isLiveConversion |
Flag that indicates if the sales price is converted live in the online store. When true, the default currency price will be converted into the active currencies based on the conversion rates saved in plentymarkets. |
|
interval |
The interval of the price. Possible values are: daily, weekly, monthly, quarterly, semi-annual and annual. |
|
createdAt |
The time the sales price was created. |
|
updatedAt |
The time the sales price was last updated. |
|
names |
names |
|
accounts |
accounts |
|
countries |
countries |
|
currencies |
currencies |
|
customerClasses |
customerClasses |
|
referrers |
referrer |
|
clients |
clients |
Methods
public toArray()Returns this model as an array.
SalesPriceAccount
Namespace
Plenty\Modules\Item\SalesPrice\Models
| Name | Type | Description |
|---|---|---|
salesPriceId |
The unique ID of the sales price |
|
referrerId |
The ID of the referrer linked to the sales price |
|
accountId |
The ID of the referrer account linked to the sales price |
|
createdAt |
The time the referrer account was linked to the sales price. |
|
updatedAt |
The time the link was last updated. |
Methods
public toArray()Returns this model as an array.
SalesPriceCountry
Namespace
Plenty\Modules\Item\SalesPrice\Models
| Name | Type | Description |
|---|---|---|
salesPriceId |
The unique ID of the sales price |
|
countryId |
The unique ID of the <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">country</a> |
|
createdAt |
The time the country was activated. |
|
updatedAt |
The time the relationship between country and sales price was last updated. |
Methods
public toArray()Returns this model as an array.
SalesPriceCurrency
Namespace
Plenty\Modules\Item\SalesPrice\Models
| Name | Type | Description |
|---|---|---|
salesPriceId |
The unique ID of the sales price |
|
currency |
The ISO code of the <a href="https://developers.plentymarkets.com/rest-doc/introduction#currencies" target="_blank">currency</a>; -1 = all currencies. |
|
createdAt |
The time the currency was activated. |
|
updatedAt |
The time the relationship between currency and sales price was last updated. |
Methods
public toArray()Returns this model as an array.
SalesPriceCustomerClass
Namespace
Plenty\Modules\Item\SalesPrice\Models
| Name | Type | Description |
|---|---|---|
salesPriceId |
The unique ID of the sales price |
|
customerClassId |
The unique ID of the customer class |
|
createdAt |
The time the customer class was activated. |
|
updatedAt |
The time the relationship between customer class and sales price was last updated. |
Methods
public toArray()Returns this model as an array.
SalesPriceName
Namespace
Plenty\Modules\Item\SalesPrice\Models
| Name | Type | Description |
|---|---|---|
salesPriceId |
The unique ID of the sales price |
|
lang |
The <a href='https://developers.plentymarkets.com/rest-doc/introduction#languages' target='_blank'>language code</a> of the sales price name |
|
nameInternal |
The internal name of the sales price. The internal name is used in the plentymarkets back end only. |
|
nameExternal |
The external name of the sales price. The external name is displayed in the online store and as such is visible for customers. |
|
createdAt |
The time the name was created. |
|
updatedAt |
The time the name was last updated. |
Methods
public toArray()Returns this model as an array.
SalesPriceOnlineStore
Namespace
Plenty\Modules\Item\SalesPrice\Models
| Name | Type | Description |
|---|---|---|
salesPriceId |
The unique ID of the sales price |
|
plentyId |
The unique ID of the client (store) |
|
createdAt |
The time the client (store) was activated. |
|
updatedAt |
The time the relationship between the client (store) and the sales price was last updated. |
Methods
public toArray()Returns this model as an array.
SalesPriceReferrer
Namespace
Plenty\Modules\Item\SalesPrice\Models
| Name | Type | Description |
|---|---|---|
salesPriceId |
The unique ID of the sales price |
|
referrerId |
The unique ID of the referrer |
|
createdAt |
The time the referrer was activated. |
|
updatedAt |
The time the relationship between referrer and sales price was last updated. |
Methods
public toArray()Returns this model as an array.
SalesPriceSearchRequest
SalesPriceSearchRequest DataModel
Namespace
Plenty\Modules\Item\SalesPrice\Models
| Name | Type | Description |
|---|---|---|
variationId |
||
type |
||
plentyId |
||
customerClassId |
||
countryId |
||
currency |
||
accountId |
||
accountType |
||
referrerId |
||
quantity |
||
ignoreType |
||
vatId |
||
customsTariffNumber |
||
defaultPriceOnly |
||
itemQuantityList |
Methods
public toArray()Returns this model as an array.
SalesPriceSearchResponse
SalesPriceSearchResponse
Namespace
Plenty\Modules\Item\SalesPrice\Models
| Name | Type | Description |
|---|---|---|
salesPriceId |
||
price |
||
priceNet |
||
basePrice |
||
basePriceNet |
||
unitPrice |
||
unitPriceNet |
||
lowestPrice |
||
lowestPriceNet |
||
customerClassDiscountPercent |
||
customerClassDiscount |
||
customerClassDiscountNet |
||
categoryDiscountPercent |
||
categoryDiscount |
||
categoryDiscountNet |
||
vatId |
||
vatValue |
||
currency |
||
interval |
||
conversionFactor |
||
minimumOrderQuantity |
||
updatedAt |
||
type |
||
pricePosition |
Methods
public toArray()Returns this model as an array.
Search
Aggregations
AttributeValueListAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getName():stringpublic getField():stringpublic getSize():intpublic getAggregation():arraypublic getPath():stringpublic process($data):arrayName |
Type |
Description |
|
public toArray():arraypublic addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidAttributeValueListAggregationProcessor
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public process($data):arrayName |
Type |
Description |
|
public getName():stringpublic getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
AvailabilityAggregation
aggregation for item availabilities
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getName():stringpublic getField():stringpublic getAggregation():arraypublic setInclude($string):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidAvailabilityAggregationProcessor
aggregation processor for item availabilities
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public process($data):arrayName |
Type |
Description |
|
public getName():voidpublic getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
CardinalityAggregationBase
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getName():stringpublic getAggregation():arraypublic getField():stringpublic toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidCategoryAllTermsAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getName():stringpublic getField():voidpublic setSize($size = 10):voidName |
Type |
Description |
|
public getAggregation():arraypublic setInclude($string):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidCategoryBranchTermsAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getName():stringpublic getField():voidpublic getAggregation():arraypublic setInclude($string):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidCategoryProcessor
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public process($data):arrayName |
Type |
Description |
|
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
FacetAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getName():stringpublic getField():stringpublic getSize():intpublic getAggregation():arraypublic getPath():stringpublic process($data):arrayName |
Type |
Description |
|
public toArray():arraypublic addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidFacetAggregationProcessor
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public process($data):arrayName |
Type |
Description |
|
public getName():stringpublic getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
FacetFacetTermsAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getName():stringpublic getField():voidpublic getAggregation():arraypublic setInclude($string):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidFacetFacetValuesTermsAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getName():stringpublic getField():voidpublic getAggregation():arraypublic setInclude($string):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidFacetFilterAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public setFacetId($facetId):voidName |
Type |
Description |
|
public getName():stringpublic getAggregation():arraypublic addFilter($filter):voidName |
Type |
Description |
|
public setIndex($index):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidFacetTermsAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public setFacetId($facetId):voidName |
Type |
Description |
|
public getName():stringpublic getField():voidpublic getAggregation():arraypublic setInclude($string):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidFeedbackAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getName():stringpublic getField():stringpublic getRanges():voidpublic getAggregation():voidpublic toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidFeedbackAggregationProcessor
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public process($data):arrayName |
Type |
Description |
|
public getName():stringpublic getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
ItemAttributeValueCardinalityAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getField():voidpublic getName():stringpublic getAggregation():arraypublic toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidItemAttributeValueCardinalityAggregationProcessor
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public process($data):voidName |
Type |
Description |
|
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
ItemCardinalityAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getField():voidpublic getName():stringpublic getAggregation():arraypublic toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidItemCardinalityAggregationProcessor
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public process($data):voidName |
Type |
Description |
|
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
OptimizedAttributeValueListAggregationProcessor
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public process($data):arrayName |
Type |
Description |
|
public getName():stringpublic getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
PriceFacetFilterAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public setFacetId($facetId):voidName |
Type |
Description |
|
public getName():stringpublic getAggregation():arraypublic addFilter($filter):voidName |
Type |
Description |
|
public setIndex($index):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidPriceRangeAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getField():voidpublic getName():voidpublic getAggregation():voidpublic toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidPriceRangeAggregationProcessor
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public process($data):arrayName |
Type |
Description |
|
public getName():stringpublic getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
VariationAttributeValueListAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getName():stringpublic getField():stringpublic getSize():intpublic getAggregation():arraypublic setSorting($sorting):voidName |
Type |
Description |
|
public toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidVariationAttributeValueListAggregationProcessor
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public process($data):arrayName |
Type |
Description |
|
public getName():stringpublic getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
VariationCardinalityAggregation
To be written
Namespace
Plenty\Modules\Item\Search\Aggregations
Methods
public getField():voidpublic getName():stringpublic getAggregation():arraypublic toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public addAggregation($aggregation):voidName |
Type |
Description |
|
public addSource($source):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
public setPage($page, $rowsPerPage):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Aggregation\AggregationInterfaceReturn type: AggregationInterface
Name |
Type |
Description |
|
||
|
public getSources():voidContracts
VariationElasticSearchAvailibilityRepositoryContract
VariationElasticSearchAvailibilityRepositoryContract
Namespace
Plenty\Modules\Item\Search\Contracts
Methods
public isReady():boolpublic isAvailable():boolVariationElasticSearchMultiSearchRepositoryContract
deprecated
|
Deprecated! (since 2023-09-01)
Please use Plenty\Modules\Pim\VariationDataInterface\Contracts\VariationDataInterfaceContract instead |
Namespace
Plenty\Modules\Item\Search\Contracts
Methods
public setIndex($index):Plenty\Modules\Cloud\ElasticSearch\Contracts\ElasticSearchMultiSearchRepositoryContractReturn type: ElasticSearchMultiSearchRepositoryContract
Name |
Type |
Description |
|
public addSearch($search):Plenty\Modules\Cloud\ElasticSearch\Contracts\ElasticSearchMultiSearchRepositoryContractReturn type: ElasticSearchMultiSearchRepositoryContract
Name |
Type |
Description |
|
public execute():arrayVariationElasticSearchScrollRepositoryContract
deprecated
|
Deprecated! (since 2023-09-01)
Please use Plenty\Modules\Pim\VariationDataInterface\Contracts\VariationDataInterfaceContract instead |
Namespace
Plenty\Modules\Item\Search\Contracts
Methods
public hasNext():boolpublic setNumberOfDocumentsPerShard($size):voidName |
Type |
Description |
|
public clear():voidpublic setIndex($index):Plenty\Modules\Cloud\ElasticSearch\Contracts\ElasticSearchSearchRepositoryContractReturn type: ElasticSearchSearchRepositoryContract
Name |
Type |
Description |
|
public addSearch($search):Plenty\Modules\Cloud\ElasticSearch\Contracts\ElasticSearchSearchRepositoryContractReturn type: ElasticSearchSearchRepositoryContract
Name |
Type |
Description |
|
public execute():arrayVariationElasticSearchSearchRepositoryContract
deprecated
|
Deprecated! (since 2023-09-01)
Please use Plenty\Modules\Pim\VariationDataInterface\Contracts\VariationDataInterfaceContract instead |
Namespace
Plenty\Modules\Item\Search\Contracts
Methods
public execute():arraypublic setIndex($index):Plenty\Modules\Cloud\ElasticSearch\Contracts\ElasticSearchSearchRepositoryContractReturn type: ElasticSearchSearchRepositoryContract
Name |
Type |
Description |
|
public addSearch($search):Plenty\Modules\Cloud\ElasticSearch\Contracts\ElasticSearchSearchRepositoryContractReturn type: ElasticSearchSearchRepositoryContract
Name |
Type |
Description |
|
VariationElasticSearchSettingsRepositoryContract
Read and update search settings
Namespace
Plenty\Modules\Item\Search\Contracts
Methods
public getLanguages():Plenty\Modules\Item\Search\Models\LanguageSettingsReturn type: LanguageSettings
Get language settings
public saveLanguages($data):Plenty\Modules\Item\Search\Models\LanguageSettingsReturn type: LanguageSettings
Update language settings
Name |
Type |
Description |
|
public getSearchSettings():Plenty\Modules\Item\Search\Models\SearchSettingsReturn type: SearchSettings
Get search settings
public saveSearchSettings($data):Plenty\Modules\Item\Search\Models\SearchSettingsReturn type: SearchSettings
Update search settings
Name |
Type |
Description |
|
public getSuggestSettings():Plenty\Modules\Item\Search\Models\SuggestSettingsReturn type: SuggestSettings
public saveSuggestSettings($data):Plenty\Modules\Item\Search\Models\SuggestSettingsReturn type: SuggestSettings
Name |
Type |
Description |
|
Filter
AmazonFilter
to be written
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public getPimFilter():voidpublic hasAnyFlatFile($flatFiles):Plenty\Modules\Item\Search\Filter\AmazonFilterReturn type: AmazonFilter
Name |
Type |
Description |
|
public hasAnyProductType($productTypes):Plenty\Modules\Item\Search\Filter\AmazonFilterReturn type: AmazonFilter
Name |
Type |
Description |
|
public hasAnyProductTypeId($productTypeIds):Plenty\Modules\Item\Search\Filter\AmazonFilterReturn type: AmazonFilter
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
AttributeFilter
Filters the index by specific attributes or attribute values
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public hasAttribute($attributeId):voidName |
Type |
Description |
|
public hasAnyAttribute($attributeIds):voidName |
Type |
Description |
|
public hasAllAttributes($attributeIds):voidName |
Type |
Description |
|
public hasAttributeValue($attributeValueId):voidName |
Type |
Description |
|
public hasAnyAttributeValue($attributeValueIds):voidName |
Type |
Description |
|
public hasAllAttributeValues($attributeValueIds):voidName |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
BarcodeFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public getPath():stringpublic hasCode($code, $precision):voidName |
Type |
Description |
|
||
|
public hasType($type):voidName |
Type |
Description |
|
public hasId($id):voidName |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
CategoryFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public isInAtLeastOneCategory($categoryIds, $depth = self::DEPTH_ANY):voidName |
Type |
Description |
|
||
|
public static getPathByDepth($depth):stringName |
Type |
Description |
|
public isInEachCategory($categoryIds, $depth = self::DEPTH_ANY):voidName |
Type |
Description |
|
||
|
public isInCategory($categoryId, $depth = self::DEPTH_ANY):voidName |
Type |
Description |
|
||
|
public isInACategory():voidpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
ClientFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public isVisibleForClient($clientId):voidName |
Type |
Description |
|
public isVisibleForAtLeastOneClient($clientIds):voidName |
Type |
Description |
|
public isVisibleForAllClients($clientIds):voidName |
Type |
Description |
|
public hasAutomaticClientVisibility($values):void-1, 0, 1, 2
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
CrossSellingFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public getPath():stringpublic hasRelation($relation):Plenty\Modules\Item\Search\Filter\CrossSellingFilterReturn type: CrossSellingFilter
Name |
Type |
Description |
|
public hasAnyRelation($relations):Plenty\Modules\Item\Search\Filter\CrossSellingFilterReturn type: CrossSellingFilter
Name |
Type |
Description |
|
public isDynamic():Plenty\Modules\Item\Search\Filter\CrossSellingFilterReturn type: CrossSellingFilter
public isManual():Plenty\Modules\Item\Search\Filter\CrossSellingFilterReturn type: CrossSellingFilter
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
FacetFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public hasAtLeastOneFacet($facetIds):voidName |
Type |
Description |
|
public hasEachFacet($facetIds):voidName |
Type |
Description |
|
public hasFacet($facetIds):voidName |
Type |
Description |
|
public hasAFacet():voidpublic hasAtLeastOneFacetValue($facetId, $valueIds):voidName |
Type |
Description |
|
||
|
public hasEachFacetValue($facetId, $valueIds):voidName |
Type |
Description |
|
||
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
FeedbackRangeFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public hasFeedbackGreaterThan($value):voidName |
Type |
Description |
|
public getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
ImageFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public getPath():voidpublic hasMarketId($marketId):voidName |
Type |
Description |
|
public setSection($section):voidName |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
ItemFilter
to bew written
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public hasId($id):voidName |
Type |
Description |
|
public hasIds($ids):voidName |
Type |
Description |
|
public hasAnImage():voidpublic hasFlag1($flagId):voidName |
Type |
Description |
|
public hasFlag2($flagId):voidName |
Type |
Description |
|
public hasManufacturer($manufacturerId):voidName |
Type |
Description |
|
public hasManufacturers($manufacturerIds):voidName |
Type |
Description |
|
public hasAManufacturer():voidpublic isItemType($itemType):voidName |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
MarketFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public isVisibleForMarket($marketId):voidName |
Type |
Description |
|
public isVisibleForAtLeastOneMarket($marketIds):voidName |
Type |
Description |
|
public isVisibleForAllMarkets($marketIds):voidName |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
PriceFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public between($min = null, $max = null):voidName |
Type |
Description |
|
||
|
public betweenByClient($min = null, $max = null, $clientId = null):voidName |
Type |
Description |
|
||
|
||
|
public toArray():arrayDIRTY CHEAT FOR OLD IO TESTS
public getType():stringpublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
PropertyFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public getPath():voidpublic hasAtLeastOneProperty($ids):Plenty\Modules\Item\Search\Filter\PropertyFilterReturn type: PropertyFilter
Name |
Type |
Description |
|
public hasEachProperty($ids):Plenty\Modules\Item\Search\Filter\PropertyFilterReturn type: PropertyFilter
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
SalesPriceFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public hasAtLeastOnePrice($priceIds):voidName |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
SearchFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public setNamesString($string, $lang):voidName |
Type |
Description |
|
||
|
public setSearchString($value, $lang, $precision = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SEARCH_TYPE_EXACT, $operator = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::OR_OPERATOR):voidName |
Type |
Description |
|
||
|
||
|
||
|
public setVariationNumber($value):voidName |
Type |
Description |
|
public toArray():arraypublic setMinimumShouldMatch($minimumShouldMatch):voidName |
Type |
Description |
|
public addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
SkuFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public getPath():voidpublic hasMarketId($marketId):voidName |
Type |
Description |
|
public hasAccountId($accountId):voidName |
Type |
Description |
|
public hasStatus($status):voidName |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
TagFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public hasTag($tagId):voidName |
Type |
Description |
|
public hasAnyTag($tagIds):voidName |
Type |
Description |
|
Name |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
TextFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public hasAnyName():voidpublic hasNameInLanguage($lang = self::LANG_DE, $filter = self::FILTER_ANY_NAME):voidName |
Type |
Description |
|
||
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
public static isLanguageSupported($lang):boolName |
Type |
Description |
|
public static isLanguageActivated($lang):boolName |
Type |
Description |
|
public static getM10lByLanguage($lang, $fallback = "en"):stringName |
Type |
Description |
|
||
|
public static getLanguageByM10l($lang, $fallback = "english"):stringName |
Type |
Description |
|
||
|
VariationAvailabilityUpdatedAtFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public getTimestamp():voidpublic getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationBaseFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public hasNumber($number, $precision):voidName |
Type |
Description |
|
||
|
public isActive():voidpublic isInactive():voidpublic hasId($id):voidName |
Type |
Description |
|
public hasIds($ids):voidName |
Type |
Description |
|
public hasItemId($itemId):voidName |
Type |
Description |
|
public hasItemIds($itemIds):voidName |
Type |
Description |
|
public isMain():voidpublic isChild():voidpublic isSalable($bool = true):voidName |
Type |
Description |
|
public isSalableAndActive($bool = true):voidName |
Type |
Description |
|
Name |
Type |
Description |
|
public hasADescriptionInLanguage($language):voidName |
Type |
Description |
|
public hasAnImageOrItemHasAnImage():voidpublic hasAnImage():voidpublic hasManufacturer($manufacturerId):voidName |
Type |
Description |
|
public hasSupplier($supplierId):voidName |
Type |
Description |
|
public hasAtLeastOneAvailability($availabilities):voidName |
Type |
Description |
|
public hasActiveChildren($bool = true):voidName |
Type |
Description |
|
public hasChildren($bool = true):voidName |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationBundleFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public hasBundleType($bundleType):voidName |
Type |
Description |
|
public hasNoBundleType():voiduse if value is "null"
public toArray():arraypublic setMinimumShouldMatch($minimumShouldMatch):voidName |
Type |
Description |
|
public addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationLastUpdatedFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public getTimestamp():voidpublic getType():stringpublic toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
VariationPropertyFilter
foo
Namespace
Plenty\Modules\Item\Search\Filter
Methods
public hasPropertySelection($id):voidName |
Type |
Description |
|
public hasAtLeastOnePropertySelection($ids):voidName |
Type |
Description |
|
public hasEachPropertySelection($ids):voidName |
Type |
Description |
|
public toArray():arraypublic addStatement($statement):voidName |
Type |
Description |
|
public addQuery($statement):voidName |
Type |
Description |
|
Helper
SearchHelper
To be written
Namespace
Plenty\Modules\Item\Search\Helper
Methods
public getFacetSearch():Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Document\DocumentSearchReturn type: DocumentSearch
public getFacetFilter():Plenty\Modules\Item\Search\Filter\FacetFilterReturn type: FacetFilter
public getSearchQuery($query):Plenty\Modules\Item\Search\Query\SearchQueryReturn type: SearchQuery
Name |
Type |
Description |
|
Models
LanguageSettings
The language settings model
Methods
public toArray()Returns this model as an array.
Mutators
BarcodeMutator
Namespace
Plenty\Modules\Item\Search\Mutators
Methods
public getPath():stringpublic mutateObject($data):arrayName |
Type |
Description |
|
public addMarket($marketId):Plenty\Modules\Item\Search\Mutators\BarcodeMutatorReturn type: BarcodeMutator
Name |
Type |
Description |
|
public getDependencies():arraypublic mutate($data):arrayName |
Type |
Description |
|
DefaultCategoryMutator
Namespace
Plenty\Modules\Item\Search\Mutators
Methods
public getPath():stringpublic mutateRow($data, $key):arrayName |
Type |
Description |
|
||
|
public setPlentyId($plentyId):Plenty\Modules\Item\Search\Mutators\DefaultCategoryMutatorReturn type: DefaultCategoryMutator
Name |
Type |
Description |
|
public getDependencies():arraypublic mutate($data):arrayName |
Type |
Description |
|
ImageDomainMutator
Converts image domains to client specific image domains.
Namespace
Plenty\Modules\Item\Search\Mutators
Methods
public getPath():stringpublic mutateObject($data):arrayName |
Type |
Description |
|
public setClient($plentyId):Plenty\Modules\Item\Search\Mutators\ImageDomainMutatorReturn type: ImageDomainMutator
Name |
Type |
Description |
|
public mutate($data):arrayName |
Type |
Description |
|
public getDependencies():arrayImageMutator
To be written…
Namespace
Plenty\Modules\Item\Search\Mutators
Methods
public getPath():stringpublic setSorting($field):voidName |
Type |
Description |
|
public setSections($sections):voidName |
Type |
Description |
|
public mutateObject($data):arrayName |
Type |
Description |
|
public addMarket($marketId):Plenty\Modules\Item\Search\Mutators\ImageMutatorReturn type: ImageMutator
Name |
Type |
Description |
|
public addClient($plentyId):Plenty\Modules\Item\Search\Mutators\ImageMutatorReturn type: ImageMutator
Name |
Type |
Description |
|
public addListing($listingId):Plenty\Modules\Item\Search\Mutators\ImageMutatorReturn type: ImageMutator
Name |
Type |
Description |
|
public getDependencies():arraypublic mutate($data):arrayName |
Type |
Description |
|
KeyMutator
Namespace
Plenty\Modules\Item\Search\Mutators
Methods
public getKeyList():arraypublic setKeyList($keyList):voidName |
Type |
Description |
|
public getNestedKeyList():voidpublic setNestedKeyList($nestedKeyList):voidName |
Type |
Description |
|
public mutate($data):arrayName |
Type |
Description |
|
public getDependencies():arraySkuMutator
Namespace
Plenty\Modules\Item\Search\Mutators
Methods
public getPath():stringpublic mutateObject($data):arrayName |
Type |
Description |
|
public setMarket($marketId):Plenty\Modules\Item\Search\Mutators\SkuMutatorReturn type: SkuMutator
Name |
Type |
Description |
|
public setAccount($accountId):Plenty\Modules\Item\Search\Mutators\SkuMutatorReturn type: SkuMutator
Name |
Type |
Description |
|
public getDependencies():arraypublic mutate($data):arrayName |
Type |
Description |
|
VariationPropertyGroupMutator
To be written…
Namespace
Plenty\Modules\Item\Search\Mutators
Methods
public mutate($data):arrayName |
Type |
Description |
|
public getDependencies():voidQuery
SearchQuery
foo
Namespace
Plenty\Modules\Item\Search\Query
Methods
public addBarcode($boost):voidName |
Type |
Description |
|
public addNumericField($field, $boost):voidName |
Type |
Description |
|
||
|
public addMultilingualField($field, $language, $boost):voidName |
Type |
Description |
|
||
|
||
|
public addField($field, $boost):voidName |
Type |
Description |
|
||
|
public toArray():arraypublic setType($type):voidName |
Type |
Description |
|
public setOperator($operator):Plenty\Modules\Cloud\ElasticSearch\Lib\Query\Type\Query\MultiMatchQueryReturn type: MultiMatchQuery
Name |
Type |
Description |
|
public setFuzzy($fuzzy):Plenty\Modules\Cloud\ElasticSearch\Lib\Query\Type\Query\MultiMatchQueryReturn type: MultiMatchQuery
Name |
Type |
Description |
|
public static isLanguageSupported($lang):boolName |
Type |
Description |
|
public static isLanguageActivated($lang):boolName |
Type |
Description |
|
public static getM10lByLanguage($lang, $fallback = "en"):stringName |
Type |
Description |
|
||
|
public static getLanguageByM10l($lang, $fallback = "english"):stringName |
Type |
Description |
|
||
|
Sort
NameSorting
To be written
Namespace
Plenty\Modules\Item\Search\Sort
Methods
public toArray():arraypublic static isLanguageSupported($lang):boolName |
Type |
Description |
|
public static isLanguageActivated($lang):boolName |
Type |
Description |
|
public static getM10lByLanguage($lang, $fallback = "en"):stringName |
Type |
Description |
|
||
|
public static getLanguageByM10l($lang, $fallback = "english"):stringName |
Type |
Description |
|
||
|
Suggestions
SearchSuggestion
foo
Namespace
Plenty\Modules\Item\Search\Suggestions
Methods
public setLanguage($language):Plenty\Modules\Item\Search\Suggestions\SearchSuggestionReturn type: SearchSuggestion
Name |
Type |
Description |
|
public getName():voidpublic getField():voidpublic toArray():arraypublic process($data):arrayName |
Type |
Description |
|
public setText($text):Plenty\Modules\Cloud\ElasticSearch\Lib\Search\Suggestion\BaseSuggestionReturn type: BaseSuggestion
Name |
Type |
Description |
|
SearchSuggestionProcessor
to be written
Namespace
Plenty\Modules\Item\Search\Suggestions
Methods
public process($data):arrayName |
Type |
Description |
|
public getDependencies():arraypublic addMutator($mutator):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
public addCondition($conditions):Plenty\Modules\Cloud\ElasticSearch\Lib\Processor\BaseProcessorReturn type: BaseProcessor
Name |
Type |
Description |
|
Stock
Events
BasketItemWarnOversell
The event is triggered to warn about an overselling.
Namespace
Plenty\Modules\Item\Stock\Events
Methods
public getBasketItem():Plenty\Modules\Basket\Models\BasketItemReturn type: BasketItem
public getQuantity():intHooks
CheckItemStock
CheckItemStock
Namespace
Plenty\Modules\Item\Stock\Hooks
Methods
public handle($basketItemEvent):voidName |
Type |
Description |
|
public getQuantityForItem($basketItem):voidCheck the quantity of the same variation in other basket items.
Name |
Type |
Description |
|
The basket item to check |
Unit
Contracts
UnitNameRepositoryContract
The contract for the unit name repository
Namespace
Plenty\Modules\Item\Unit\Contracts
Methods
public create($data, $unitId):Plenty\Modules\Item\Unit\Models\UnitNameReturn type: UnitName
Creates a unit name. The ID of the unit must be specified.
Name |
Type |
Description |
|
The unit name data as an associative array |
|
|
The ID of the unit |
public delete($unitId, $lang):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a unit name. The ID of the unit and the language must be specified.
Name |
Type |
Description |
|
The ID of the unit |
|
|
The lang of the unit name |
public update($data, $unitId, $lang):Plenty\Modules\Item\Unit\Models\UnitNameReturn type: UnitName
Updates a unit name. The ID of the unit and the language must be specified.
Name |
Type |
Description |
|
The unit name data as an associative array |
|
|
The ID of the unit |
|
|
The language of the unit name |
public findOne($unitId, $lang):Plenty\Modules\Item\Unit\Models\UnitNameReturn type: UnitName
Gets a unit name. The ID of the unit and the language must be specified.
Name |
Type |
Description |
|
The ID of the unit |
|
|
The language of the unit name |
public findByUnitId($unitId):arrayLists unit names. The ID of the unit must be specified.
Name |
Type |
Description |
|
The ID of the unit |
UnitRepositoryContract
The contract for the unit repository
Namespace
Plenty\Modules\Item\Unit\Contracts
Methods
public create($data):Plenty\Modules\Item\Unit\Models\UnitReturn type: Unit
Creates a unit.
Name |
Type |
Description |
|
The unit data as an associative array |
public show($id):Plenty\Modules\Item\Unit\Models\UnitReturn type: Unit
Gets a unit. The ID of the unit must be specified.
Name |
Type |
Description |
|
The ID of the unit |
public update($data, $id):Plenty\Modules\Item\Unit\Models\UnitReturn type: Unit
Updates a unit. The ID of the unit must be specified.
Name |
Type |
Description |
|
The unit data as an associative array |
|
|
The ID of the unit |
public delete($id):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a unit. The ID of the unit must be specified.
Name |
Type |
Description |
|
The ID of the unit |
public findById($id):Plenty\Modules\Item\Unit\Models\UnitReturn type: Unit
Gets a unit. The ID of the unit must be specified.
Name |
Type |
Description |
|
The ID of the unit |
public all($columns = [], $perPage = 50, $page = 1):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Lists all units.
Name |
Type |
Description |
|
An array of the shown columns. All columns are returned by default. |
|
|
The amount of units shown per page. Default value is 50. |
|
|
The shown page. Default value is 1. |
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
Unit
The unit model including the unit name
Namespace
Plenty\Modules\Item\Unit\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the unit |
|
position |
The position of the unit |
|
unitOfMeasurement |
The International System of Units (ISO) <a href="https://developers.plentymarkets.com/rest-doc/introduction#units" target="_blank">code</a> of the unit |
|
isDecimalPlacesAllowed |
Flag that indicates if decimal places are allowed for this unit of measurement. If false, only integer values are allowed for the unit. |
|
updatedAt |
The time the unit was last updated. |
|
createdAt |
The time the unit was created. |
|
names |
Methods
public toArray()Returns this model as an array.
UnitName
The unit name model including the unit
Namespace
Plenty\Modules\Item\Unit\Models
| Name | Type | Description |
|---|---|---|
unitId |
The unique ID of the unit |
|
lang |
The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language</a> of the unit name |
|
name |
The name of the unit |
|
unit |
Methods
public toArray()Returns this model as an array.
UnitCombination
Contracts
UnitCombinationRepositoryContract
Interface for unit combination
Namespace
Plenty\Modules\Item\UnitCombination\Contracts
Methods
public all($itemsPerPage = 50, $page = 1):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Returns all unit combinations
Name |
Type |
Description |
|
||
|
public get($id):Plenty\Modules\Item\UnitCombination\Models\UnitCombinationReturn type: UnitCombination
Returns the unit combination that matches the specified ID
Name |
Type |
Description |
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Variation
Contracts
VariationExportServiceContract
Enhances the loading speed.
Namespace
Plenty\Modules\Item\Variation\Contracts
Methods
public addPreloadTypes($types):voidName |
Type |
Description |
|
public preload($values, $parameters = []):arrayName |
Type |
Description |
|
||
|
public getData($dataType, $variationId):voidName |
Type |
Description |
|
||
|
public getAll($variationId):voidName |
Type |
Description |
|
public resetPreLoadedData():voidResets the pre loaded data
public resetPreloadTypes():voidResets the current pre load types
VariationImageServiceContract
Preload all variations linked to an image for several item IDs
Namespace
Plenty\Modules\Item\Variation\Contracts
VariationInheritanceServiceContract
To be written…
Namespace
Plenty\Modules\Item\Variation\Contracts
VariationLookupRepositoryContract
lookup repository for variations
Namespace
Plenty\Modules\Item\Variation\Contracts
Methods
public hasBarcode($code, $barcodeId = null):Plenty\Modules\Item\Variation\Contracts\VariationLookupRepositoryContractReturn type: VariationLookupRepositoryContract
Name |
Type |
Description |
|
||
|
public hasId($id):Plenty\Modules\Item\Variation\Contracts\VariationLookupRepositoryContractReturn type: VariationLookupRepositoryContract
Name |
Type |
Description |
|
public hasItemId($itemId):Plenty\Modules\Item\Variation\Contracts\VariationLookupRepositoryContractReturn type: VariationLookupRepositoryContract
Name |
Type |
Description |
|
public hasExternalId($externalId):Plenty\Modules\Item\Variation\Contracts\VariationLookupRepositoryContractReturn type: VariationLookupRepositoryContract
Name |
Type |
Description |
|
public hasNumber($number):Plenty\Modules\Item\Variation\Contracts\VariationLookupRepositoryContractReturn type: VariationLookupRepositoryContract
Name |
Type |
Description |
|
public hasSupplierItemNumber($supplierVariationNumber):Plenty\Modules\Item\Variation\Contracts\VariationLookupRepositoryContractReturn type: VariationLookupRepositoryContract
Name |
Type |
Description |
|
public hasAttributeValueMap($attributeValueMap):Plenty\Modules\Item\Variation\Contracts\VariationLookupRepositoryContractReturn type: VariationLookupRepositoryContract
Name |
Type |
Description |
|
public limit($limit):Plenty\Modules\Item\Variation\Contracts\VariationLookupRepositoryContractReturn type: VariationLookupRepositoryContract
Name |
Type |
Description |
|
public lookup():arrayVariationMultiPackServiceContract
The contract for the variation bundle service
Namespace
Plenty\Modules\Item\Variation\Contracts
Methods
public createMultiPackBundle($variationId, $componentId, $quantity):voidName |
Type |
Description |
|
||
|
||
|
public setMainVariationBundleItem($variationId):voidName |
Type |
Description |
|
public updateMultiPackBundle($variationId, $quantityId, $quantity):voidName |
Type |
Description |
|
||
|
||
|
public getAttributeValueSetId($itemId):intName |
Type |
Description |
|
public matchUnit($itemId):intName |
Type |
Description |
|
public isMultiPack($itemId):boolName |
Type |
Description |
|
VariationRepositoryContract
The contract for the variation repository
Namespace
Plenty\Modules\Item\Variation\Contracts
Methods
public show($variationId, $with, $lang):Plenty\Modules\Item\Variation\Models\VariationReturn type: Variation
Gets a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
The ID of the variation |
|
|
||
|
public showMultiple($ids, $with):arrayName |
Type |
Description |
|
||
|
public create($data):Plenty\Modules\Item\Variation\Models\VariationReturn type: Variation
Creates a variation.
Name |
Type |
Description |
|
The variation data as an associative array |
public createPrimary($data):Plenty\Modules\Item\Variation\Models\VariationReturn type: Variation
Creates a primary variation.
Name |
Type |
Description |
|
The variation data as an associative array |
public delete($variationId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
The ID of the variation |
public findById($variationId):Plenty\Modules\Item\Variation\Models\VariationReturn type: Variation
Get a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
The ID of the variation |
public update($data, $variationId):Plenty\Modules\Item\Variation\Models\VariationReturn type: Variation
Update a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
||
|
public updateBulk($data):arrayUpdates up to 50 variations.
Name |
Type |
Description |
|
public changePrimaryVariation($variationId):Plenty\Modules\Item\Variation\Models\VariationReturn type: Variation
Change main variation. Changes the variation with the specified variation ID to the new main variation.
Name |
Type |
Description |
|
public patchBulk($rows):Illuminate\Support\CollectionReturn type: Collection
Name |
Type |
Description |
|
VariationSearchRepositoryContract
A repository for comfortable searches for variations
Namespace
Plenty\Modules\Item\Variation\Contracts
Methods
public setSearchFilter($name, $params):voidName |
Type |
Description |
|
||
|
public setSearchParam($name, $value):voidName |
Type |
Description |
|
||
|
public setSearchParams($params):voidName |
Type |
Description |
|
public search():Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Events
BeforeStatisticAccess
The event is triggered before a statics will be loaded
Namespace
Plenty\Modules\Item\Variation\Events
Methods
public isAccessAllowed():boolpublic setAccessAllowed($accessAllowed):Plenty\Modules\Item\Variation\Events\BeforeStatisticAccessReturn type: BeforeStatisticAccess
Name |
Type |
Description |
|
public getStatistic():stringpublic setStatistic($statistic):Plenty\Modules\Item\Variation\Events\BeforeStatisticAccessReturn type: BeforeStatisticAccess
Name |
Type |
Description |
|
Models
Variation
Variation
Namespace
Plenty\Modules\Item\Variation\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of the variation. The ID must be unique. |
|
isMain |
Flag that indicates if the variation is the main variation of the item. |
|
mainVariationId |
The variation ID of the item’s main variation. Value is NULL if this variation is the item’s main variation. |
|
itemId |
The item ID of the item that this variation belongs to. |
|
position |
The position of the variation. Value is inherited from the item’s main variation if inheritance is active. |
|
isActive |
Flag that indicates if the variation is active. Only active variations can be offered in the online store and/or on markets. |
|
number |
The unique variation number of the variation. The variation number must be specified. |
|
model |
The model of the variation. Value is inherited from the item’s main variation if inheritance is active. |
|
externalId |
The external variation ID of this variation. The external variation number is optional and allows importing items and variations from external systems to plentymarkets. |
|
availability |
The availability of the variation. Possible values: 1 to 10, null = Variation inherits value of main variation. |
|
estimatedAvailableAt |
The estimated delivery date of variations on reorder. |
|
purchasePrice |
The net purchase price. Value e.g. is used for price calculations. |
|
movingAveragePrice |
The moving average purchase price of the variation. |
|
createdAt |
The time the variation was created. |
|
updatedAt |
The time the variation was last updated. |
|
relatedUpdatedAt |
The time at which related information for this variation was last updated. Related information is defined as information that is linked to the variation, i.e. barcodes, categories, images, markets, clients (stores), prices, suppliers, warehouses and the default category. |
|
availabilityUpdatedAt |
The time at which the availability of this variation was last updated. |
|
priceCalculationId |
The ID of the price calculation linked to the variation. (deprecated) |
|
priceCalculationUUID |
The UUID of the price calculation linked to the variation. |
|
picking |
The order picking type of the variation. Possible values: single_picking, no_single_picking, exclude_from_picklist, null (no order picking type) |
|
stockLimitation |
The stock limitation for the variation. Possible values: <ul><li>0 = No limitation, i.e. stock is not limited. The variations’s availability is not checked automatically.</li><li>1 = Stock is limited to net stock. The variation’s availability is checked automatically.</li><li>2 = Do not administer stock for this variation.</li></ul> |
|
isVisibleIfNetStockIsPositive |
Flag that indicates if the variation is visible in the online store if net stock is positive. If true, the variation automatically becomes visible when the net stock changes to positive. |
|
isInvisibleIfNetStockIsNotPositive |
Flag that indicates if the variation is invisible in the online store if net stock is not positive. If true, the variation automatically becomes invisible when the net stock changes to 0 or negative. |
|
isAvailableIfNetStockIsPositive |
Flag that indicates if the variation is available in the online store if net stock is positive. If true, the variation automatically becomes available when the net stock changes to positive. |
|
isUnavailableIfNetStockIsNotPositive |
Flag that indicates if the variation is unavailable in the online store if net stock is not positive. If true, the variation automatically becomes available when the net stock changes to 0 or negative. |
|
isVisibleInListIfNetStockIsPositive |
Flag that indicates if the variation is visible in the item list of the online store if net stock is positive. If true, the variation automatically becomes visible in categories, search results and item lists (store specials, cross-selling, last seen items) when the net stock changes to positive. |
|
isInvisibleInListIfNetStockIsNotPositive |
Flag that indicates if the variation is invisible in the item list of the online store if net stock is not positive. If true and no net stock is available for the variation, the variation can only be opened using the direct URL. The variation is not shown in the categories, search results or item lists (store specials, cross-selling, last seen items). |
|
mainWarehouseId |
The ID of the main warehouse of the variation. |
|
maximumOrderQuantity |
The maximum order quantity permitted per order. Decimal values are possible to allow orders by weight or length. Default value is 0. If value is 0, the maximum order quantity is unlimited. |
|
minimumOrderQuantity |
The minimum order quantity. Decimal values are possible to allow orders by weight or length. |
|
intervalOrderQuantity |
The quantity intervals the variation can be ordered in. Decimal values are possible to allow orders by weight or length. |
|
availableUntil |
The last date the item will be available for sale. |
|
releasedAt |
The release date of the variation. This is the date on which the variation will become available. The variation can be visible in the online store before this date, e.g. for preorders. |
|
name |
The name of the variation |
|
unitCombinationId |
The unit combination id of the variation |
|
weightG |
The gross weight of the variation in gramms (g). This weight includes the packaging for variations that are packaged separately. This value is used for calculating shipping packages and weight-based shipping costs. |
|
weightNetG |
The net weight of the variation in gramms (g). This is the weight of the variation without packaging. |
|
widthMM |
The width of the variation in millimetres (mm) |
|
lengthMM |
The length of the variation in millimeters (mm) |
|
heightMM |
The height of the variation in millimetres (mm) |
|
extraShippingCharge1 |
The extra shipping charge 1 for the variation. Extra shipping charges are useful for large or bulky items that are particularly expensive to ship. Charge 1 is added to the regular shipping costs for the first item of an order. If different variations are ordered, the extra shipping charge 1 of the variation with the highest charge 1 is selected. |
|
extraShippingCharge2 |
The extra shipping charge 2 for the variation. Extra shipping charges are useful for large or bulky items that are expensive to ship. Charge 2 is added to the shipping costs for any additional items of an order. |
|
unitsContained |
The number of sales units contained in one package. Default value is 1. |
|
palletTypeId |
The ID of the pallet type |
|
packingUnits |
The number of packing units if the item consists of multiple packages. Value is 0 if an item is sent as one package. All items of an order that have the value 0 will be packed into one package. |
|
packingUnitTypeId |
The ID of the packing unit type. |
|
transportationCosts |
The net transportation costs for the variation. This value is used for price calculations and for calculating the acquisition price. |
|
storageCosts |
The net storage costs for the variation |
|
customs |
The customs rate in percent |
|
operatingCosts |
The operating costs for the variation in percent |
|
vatId |
The ID of the VAT rate of the variation. VAT rates are created for each client (store) and linked to the variation. |
|
bundleType |
Indicates the bundle type of the variation. Possible values:<ul><li>bundle = The variation is a bundle</li><li>bundle_item = The variation is a bundle component.</li><li>Null = The variation is not associated with a bundle</li></ul> |
|
automaticClientVisibility |
Indicates if the variation is set as available for any clients (stores). Possible values:<ul><li>0 / -1 (GET) or 0 (POST) = Variation is not available in any client (store).</li><li>1 / 2 (GET) or 1 (POST) = Variation is available in at least one client (store).</li></ul>The variation’s actual visibility depends on the settings for net stock dependency. |
|
automaticListVisibility |
Indicates if the variation currently is visible in item lists. 3 = Variation is visible in item list because $isHiddenInCategoryList is false. 2, 1 = Variation is visible in item list because $isVisibleInListIfNetStockIsPositive is true and net stock is positive. 0, -1 = Variation is invisible in item list because $isInvisibleInListIfNetStockIsNotPositive is true and net stock is 0 or negative. -2 = Variation is invisible in item list because $isHiddenInCategoryList is true. |
|
isHiddenInCategoryList |
Flag that indicates if the variation is hidden in the category list. If true, the variation will not be shown in any item category and will not be returned as a search result. The variation can only be accessed via its URL. |
|
defaultShippingCosts |
The default shipping costs for the variation. |
|
mayShowUnitPrice |
Display unit price in the online store |
|
salesRank |
The sales rank of the variation. This ranking is used to position top items automatically if the option <b>Automatically sort by monthly sales</b> (<b>Settings » Client (store) » Standard » Item layouts » Basic settings</b>) is set to <b>Yes</b>. The sales ranking is calculated daily. If the option <b>Automatically sort by monthly sales</b> is set to <b>No</b>, a value of 0 is returned and variations are sorted by position instead. |
|
parentVariationId |
||
parentVariationQuantity |
||
singleItemCount |
||
customsTariffNumber |
The customs tariff number of the variation; usually a 11 digit code number based on the Harmonised System |
|
campaignId |
The id of the campaign for the variation |
|
categoryVariationId |
Either the ID of the variation or the ID of the item’s main variation. No other values are permitted.<ul><li>ID of the variation = Categories are not inherited from the main variation.</li><li>ID of the item’s main variation = Inheritance of categories is active.</li></ul> |
|
marketVariationId |
Either the ID of the variation or the ID of the item’s main variation. No other values are permitted.<ul><li>ID of the variation = Markets are not inherited from the main variation.</li><li>ID of the item’s main variation = Inheritance of markets is active.</li></ul> |
|
clientVariationId |
Either the ID of the variation or the ID of the item’s main variation. No other values are permitted.<ul><li>ID of the variation = Clients (stores) are not inherited from the main variation.</li><li>ID of the item’s main variation = Inheritance of clients (stores) is active.</li></ul> |
|
salesPriceVariationId |
Either the ID of the variation or the ID of the item’s main variation. No other values are permitted.<ul><li>ID of the variation = Sales prices are not inherited from the main variation.</li><li>ID of the item’s main variation = Inheritance of sales prices is active.</li></ul> |
|
supplierVariationId |
Either the ID of the variation or the ID of the item’s main variation. No other values are permitted.<ul><li>ID of the variation = Suppliers are not inherited from the main variation.</li><li>ID of the item’s main variation = Inheritance of suppliers is active.</li></ul> |
|
warehouseVariationId |
Either the ID of the variation or the ID of the item’s main variation. No other values are permitted.<ul><li>ID of the variation = Warehouses are not inherited from the main variation.</li><li>ID of the item’s main variation = Inheritance of warehouses is active.</li></ul> |
|
propertyVariationId |
Either the ID of the variation or the ID of the item’s main variation. No other values are permitted.<ul><li>ID of the variation = Properties are not inherited from the main variation.</li><li>ID of the item’s main variation = Inheritance of properties is active.</li></ul> |
|
tagVariationId |
Either the ID of the variation or the ID of the item’s main variation. No other values are permitted.<ul><li>ID of the variation = Tags are not inherited from the main variation.</li><li>ID of the item’s main variation = Inheritance of tags is active.</li></ul> |
|
hasCalculatedBundleWeight |
Indicates if the gross bundle weight is calculated by its components. |
|
hasCalculatedBundleNetWeight |
Indicates if the net bundle weight is calculated by its components. |
|
hasCalculatedBundlePurchasePrice |
Indicates if the net purchase price is calculated by its components. |
|
hasCalculatedBundleMovingAveragePrice |
Indicates if the moving average net purchase price is calculated by its components. |
|
variationBarcodes |
An array of the barcodes of the variation. |
|
variationBundleComponents |
An array of the bundle components of the variation. |
|
variationComponentBundles |
An array of the bundles that this variation is a component of. |
|
variationProperties |
An array of the properties of the variation. |
|
properties |
An array of the properties of the variation. |
|
propertiesV2 |
||
variationSalesPrices |
An array of the sales prices of the variation. |
|
marketItemNumbers |
An array of the barcodes of the variation. |
|
variationCategories |
An array of the categories of the variation. |
|
variationClients |
An array of the clients (stores) of the variation. |
|
variationMarkets |
An array of the markets of the variation. |
|
variationDefaultCategory |
An array of the default category of the variation. |
|
variationSuppliers |
An array of the suppliers of the variation. |
|
itemTexts |
An array of the texts of the variation. |
|
variationTexts |
An array of the texts of the variation. |
|
variationWarehouses |
An array of the warehouses of the variation. |
|
tags |
An array of the tags of the variation. |
|
comments |
An array of the comments of the variation. |
|
images |
An array of the images of the variation. |
|
itemImages |
An array of the images of the item linked to the variation. |
|
itemCrossSelling |
An array of the cross selling items of the item linked to the variation. |
|
itemShippingProfiles |
An array of the shipping profiles of the item linked to the variation. |
|
variationAdditionalSkus |
An array of additional SKUs of the variation. |
|
variationSkus |
An array of SKUs of the variation. |
|
variationAttributeValues |
An array of the attribute values of the variation. |
|
unit |
The UnitCombination of the Variation. Object contains unitId and content. |
|
parent |
The details of the main variation of the variation if applicable. |
|
item |
||
children |
||
stockStorageLocations |
An array of the stockStorageLocations of the variation. |
Methods
public toArray()Returns this model as an array.
VariationAdditionalSku
Contracts
VariationAdditionalSkuRepositoryContract
The contract of the variation additional sku repository
Namespace
Plenty\Modules\Item\VariationAdditionalSku\Contracts
Methods
public search($filter):arrayLists additional SKUs
Name |
Type |
Description |
|
public get($id):Plenty\Modules\Item\VariationAdditionalSku\Models\VariationAdditionalSkuReturn type: VariationAdditionalSku
Gets an additional SKU
Name |
Type |
Description |
|
The unique ID of the additional SKU |
public create($data):Plenty\Modules\Item\VariationAdditionalSku\Models\VariationAdditionalSkuReturn type: VariationAdditionalSku
Creates an additional SKU
Name |
Type |
Description |
|
public update($id, $data):Plenty\Modules\Item\VariationAdditionalSku\Models\VariationAdditionalSkuReturn type: VariationAdditionalSku
Updates an additional SKU
Name |
Type |
Description |
|
The unique ID of the SKU |
|
|
public delete($id):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes an additional SKU
Name |
Type |
Description |
|
The unique ID of the additional SKU |
Models
VariationAdditionalSku
The variation additional SKU model for order import
Namespace
Plenty\Modules\Item\VariationAdditionalSku\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of the additional sku |
|
variationId |
The ID of the variation. |
|
marketId |
The ID of the market reference. |
|
marketAccountId |
The ID of the market account. |
|
sku |
The additional sku for this variation. |
|
createdAt |
The time the SKU was created (YYYY-MM-DD HH:MM:SS). |
|
updatedAt |
The time the SKU was updated (YYYY-MM-DD HH:MM:SS). |
Methods
public toArray()Returns this model as an array.
VariationBarcode
Contracts
VariationBarcodeRepositoryContract
The contract of the variation barcode repository
Namespace
Plenty\Modules\Item\VariationBarcode\Contracts
Methods
public show($barcodeId, $variationId):Plenty\Modules\Item\VariationBarcode\Models\VariationBarcodeReturn type: VariationBarcode
Gets a variation barcode. The ID of the variation and the ID of the barcode must be specified.
Name |
Type |
Description |
|
The unique ID of the barcode |
|
|
The unique ID of the variation |
public create($data):Plenty\Modules\Item\VariationBarcode\Models\VariationBarcodeReturn type: VariationBarcode
Creates a variation barcode.
Name |
Type |
Description |
|
The variation barcode data as an associative array |
public update($data, $barcodeId, $variationId):Plenty\Modules\Item\VariationBarcode\Models\VariationBarcodeReturn type: VariationBarcode
Updates a variation barcode. The ID of the variation and the ID of the barcode must be specified.
Name |
Type |
Description |
|
The variation barcode data as an associative array |
|
|
The unique ID of the barcode |
|
|
The unique ID of the variation |
public delete($barcodeId, $variationId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a variation barcode. The ID of the variation and the ID of the barcode must be specified.
Name |
Type |
Description |
|
The unique ID of the barcode |
|
|
The unique ID of the variation |
public findByVariationId($variationId):arrayLists all barcodes of a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
Models
VariationBarcode
Variation Barcode
Namespace
Plenty\Modules\Item\VariationBarcode\Models
| Name | Type | Description |
|---|---|---|
code |
The code of the variation’s barcode. The combination of code and barcode ID must be unique. |
|
barcodeId |
The unique ID of the barcode linked to the variation. The combination of code and barcode ID must be unique. |
|
variationId |
The unique ID of the variation |
|
createdAt |
The time the variation’s code was created. |
|
barcode |
The barcode of the variation’s barcode |
Methods
public toArray()Returns this model as an array.
VariationBundle
Contracts
InternalVariationBundleRepositoryContract
The contract for the variation bundle repository
Namespace
Plenty\Modules\Item\VariationBundle\Contracts
Methods
public show($bundleId):Plenty\Modules\Item\VariationBundle\Models\VariationBundleReturn type: VariationBundle
Gets a variation bundle. The ID of the bundle must be specified.
Name |
Type |
Description |
|
The ID of the bundle |
public create($data):Plenty\Modules\Item\VariationBundle\Models\VariationBundleReturn type: VariationBundle
Creates a variation bundle.
Name |
Type |
Description |
|
The variation bundle data as an associative array |
public update($data, $bundleId):Plenty\Modules\Item\VariationBundle\Models\VariationBundleReturn type: VariationBundle
Updates a variation bundle. The ID of the bundle must be specified.
Name |
Type |
Description |
|
The variation bundle data as an associative array |
|
|
The ID of the bundle |
public delete($bundleId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a variation bundle component. The ID of the bundle must be specified.
Name |
Type |
Description |
|
The ID of the bundle |
public findByVariationId($variationId):Plenty\Modules\Item\VariationBundle\Models\VariationBundleReturn type: VariationBundle
Lists variation bundles. The ID of the variation must be specified.
Name |
Type |
Description |
|
The ID of the variation |
public findByComponentId($componentId):arrayLists variation bundles. The ID of the component variation must be specified.
Name |
Type |
Description |
|
The ID of the component variation |
VariationBundleRepositoryContract
The contract for the variation bundle repository
Namespace
Plenty\Modules\Item\VariationBundle\Contracts
Methods
public show($bundleId):Plenty\Modules\Item\VariationBundle\Models\VariationBundleReturn type: VariationBundle
Gets a variation bundle. The ID of the bundle must be specified.
Name |
Type |
Description |
|
The ID of the bundle |
public create($data):Plenty\Modules\Item\VariationBundle\Models\VariationBundleReturn type: VariationBundle
Creates a variation bundle.
Name |
Type |
Description |
|
The variation bundle data as an associative array |
public update($data, $bundleId):Plenty\Modules\Item\VariationBundle\Models\VariationBundleReturn type: VariationBundle
Updates a variation bundle. The ID of the bundle must be specified.
Name |
Type |
Description |
|
The variation bundle data as an associative array |
|
|
The ID of the bundle |
public delete($bundleId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a variation bundle component. The ID of the bundle must be specified.
Name |
Type |
Description |
|
The ID of the bundle |
public findByVariationId($variationId):Plenty\Modules\Item\VariationBundle\Models\VariationBundleReturn type: VariationBundle
Lists variation bundles. The ID of the variation must be specified.
Name |
Type |
Description |
|
The ID of the variation |
public findByComponentId($componentId):arrayLists variation bundles. The ID of the component variation must be specified.
Name |
Type |
Description |
|
The ID of the component variation |
Models
VariationBundle
The variation bundle
Namespace
Plenty\Modules\Item\VariationBundle\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the link that marks a variation as a bundle component |
|
variationId |
The unique ID of the variation to which other variations are added to create a bundle |
|
componentVariationId |
The unique ID of the variation added as bundle component |
|
componentQuantity |
The quantity of the variation to be added as bundle component |
|
lastUpdatedTimestamp |
The time the bundle was last updated. |
|
createdAt |
The time the bundle was created. |
Methods
public toArray()Returns this model as an array.
VariationCategory
Contracts
VariationCategoryRepositoryContract
The contract for the variation category repository
Namespace
Plenty\Modules\Item\VariationCategory\Contracts
Methods
public show($variationId, $categoryId):Plenty\Modules\Item\VariationCategory\Models\VariationCategoryReturn type: VariationCategory
Gets the link between a category and a variation. The ID of the variation and the ID of the category must be specified.
Name |
Type |
Description |
|
The ID of the variation |
|
|
The ID of the category |
public create($data):Plenty\Modules\Item\VariationCategory\Models\VariationCategoryReturn type: VariationCategory
Creates a link between a category and a variation.
Name |
Type |
Description |
|
The variation category data as an associative array |
public update($data, $variationId, $categoryId):Plenty\Modules\Item\VariationCategory\Models\VariationCategoryReturn type: VariationCategory
Updates a link between a category and a variation. The ID of the variation and the ID of the category must be specified.
Name |
Type |
Description |
|
The variation category data as an associative array |
|
|
The ID of the variation |
|
|
The ID of the category |
public delete($variationId, $categoryId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes the link between a category and a variation. The ID of the variation and the ID of the category must be specified.
Name |
Type |
Description |
|
The ID of the variation |
|
|
The ID of the category |
public findByVariationId($variationId):Plenty\Modules\Item\VariationCategory\Models\VariationCategoryReturn type: VariationCategory
Lists the categories linked to a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
The ID of the variation |
public findByVariationIdWithInheritance($variationId):Plenty\Modules\Item\VariationCategory\Models\VariationCategoryReturn type: VariationCategory
Lists the categories linked to a variation including inheritance information. The ID of the variation must be specified.
Name |
Type |
Description |
|
public updateBulk($data):Illuminate\Support\CollectionReturn type: Collection
Updates up to 50 links between variations and categories. The ID of the variations and the ID of the categories must be specified.
Name |
Type |
Description |
|
The array containing the data. |
public createBulk($data):Illuminate\Support\CollectionReturn type: Collection
Creates up to 50 links between variations and categories. The ID of the variations and the ID of the categories must be specified.
Name |
Type |
Description |
|
The array containing the data. |
Models
VariationCategory
Variation Category
Namespace
Plenty\Modules\Item\VariationCategory\Models
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation |
|
categoryId |
The unique ID of the category |
|
position |
The position of the category |
|
isNeckermannPrimary |
Flag that indicates if the category is the primary category for the market Neckermann for this variation. |
Methods
public toArray()Returns this model as an array.
VariationClient
Contracts
VariationClientRepositoryContract
The contract of the variation client repository
Namespace
Plenty\Modules\Item\VariationClient\Contracts
Methods
public findOne($plentyId, $variationId):Plenty\Modules\Item\VariationClient\Models\VariationClientReturn type: VariationClient
Gets a client (store) linked to a variation. The ID of the variation and the client ID must be specified.
Name |
Type |
Description |
|
The unique ID of the client (store) |
|
|
The unique ID of the variation |
public create($data):Plenty\Modules\Item\VariationClient\Models\VariationClientReturn type: VariationClient
Creates a link between a variation and a client (store).
Name |
Type |
Description |
|
The variation client data as an associative array |
public delete($plentyId, $variationId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes the link between a variation and a client (store). The ID of the variation and the client ID must be specified.
Name |
Type |
Description |
|
The unique ID of the client (store) |
|
|
The unique ID of the variation |
public findByVariationId($variationId):Plenty\Modules\Item\VariationClient\Models\VariationClientReturn type: VariationClient
Lists the clients (stores) linked to a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
public findByVariationIdWithInheritance($variationId):Plenty\Modules\Item\VariationClient\Models\VariationClientReturn type: VariationClient
Lists the clients (stores) linked to a variation including inheritance information. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
Models
VariationClient
Variation Client
Namespace
Plenty\Modules\Item\VariationClient\Models
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation |
|
plentyId |
The unique ID of the client (store) |
|
createdAt |
The time at which the client (store) was linked to the variation. |
Methods
public toArray()Returns this model as an array.
VariationDefaultCategory
Contracts
VariationDefaultCategoryRepositoryContract
The contract of the variation default category repository
Namespace
Plenty\Modules\Item\VariationDefaultCategory\Contracts
Methods
public show($plentyId, $variationId):Plenty\Modules\Item\VariationDefaultCategory\Models\VariationDefaultCategoryReturn type: VariationDefaultCategory
Gets the default category of a variation for the client (store) specified. The ID of the variation and the plenty ID of the client (store) must be specified.
Name |
Type |
Description |
|
The unique plenty ID of the client (store) |
|
|
The unique ID of the variation |
public create($data):Plenty\Modules\Item\VariationDefaultCategory\Models\VariationDefaultCategoryReturn type: VariationDefaultCategory
Creates a link between a variation and a category that designates the category as the default category for this client (store).
Name |
Type |
Description |
|
The variation default category data as an associative array |
public update($data, $plentyId, $variationId):Plenty\Modules\Item\VariationDefaultCategory\Models\VariationDefaultCategoryReturn type: VariationDefaultCategory
Updates the default category linked to a variation. The ID of the variation and the plenty ID of the client (store) must be specified.
Name |
Type |
Description |
|
The variation default category data as an associative array |
|
|
The unique plenty ID of the client (store) |
|
|
The unique ID of the variation |
public delete($plentyId, $variationId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes the link between a variation and a default category. The ID of the variation and the plenty ID of the client (store) must be specified.
Name |
Type |
Description |
|
The unique plenty ID of the client (store) |
|
|
The unique ID of the variation |
public findByVariationId($variationId):Plenty\Modules\Item\VariationDefaultCategory\Models\VariationDefaultCategoryReturn type: VariationDefaultCategory
Lists the default categories of a variation for all clients (stores). The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
Models
VariationDefaultCategory
Variation Default Category
Namespace
Plenty\Modules\Item\VariationDefaultCategory\Models
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation |
|
branchId |
The unique ID of the category branch |
|
plentyId |
The unique plenty ID of the client (store) |
|
manually |
Methods
public toArray()Returns this model as an array.
VariationDescription
Contracts
VariationDescriptionRepositoryContract
The contract of the variation description repository
Namespace
Plenty\Modules\Item\VariationDescription\Contracts
Methods
public create($data):Plenty\Modules\Item\VariationDescription\Models\VariationDescriptionReturn type: VariationDescription
Creates texts
Name |
Type |
Description |
|
The variation description data as an associative array |
public update($data, $variationId, $lang):Plenty\Modules\Item\VariationDescription\Models\VariationDescriptionReturn type: VariationDescription
Updates texts
Name |
Type |
Description |
|
The variation description data as an associative array |
|
|
The unique ID of the variation |
|
|
The unique code of the language |
public delete($variationId, $lang):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes texts
Name |
Type |
Description |
|
The unique ID of the variation |
|
|
The unique code of the language |
public find($variationId, $lang):Plenty\Modules\Item\VariationDescription\Models\VariationDescriptionReturn type: VariationDescription
Gets texts
Name |
Type |
Description |
|
The unique ID of the variation |
|
|
The unique code of the language |
public findById($id):Plenty\Modules\Item\VariationDescription\Models\VariationDescriptionReturn type: VariationDescription
Get texts
Name |
Type |
Description |
|
The unique ID of the item texts |
public findByVariationId($variationId):arrayList texts
Name |
Type |
Description |
|
The unique ID of the variation |
Models
VariationDescription
Variation Default Category
Namespace
Plenty\Modules\Item\VariationDescription\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the description |
|
itemId |
The unique ID of the item that this description belongs to |
|
lang |
The <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">language code</a> of the description |
|
name |
The default name of the item. By default, this name is displayed in the online store. For Default items, this name is also used for markets. Character limit: max. 240 characters. |
|
name2 |
Alternative item name that can be used e.g. for markets. Character limit: max. 240 characters. |
|
name3 |
Alternative item name that can be used e.g. for markets. Character limit: max. 240 characters. |
|
previewDescription |
The preview text. The preview text is a short description that can be displayed in item lists. |
|
metaDescription |
The meta description of the item. This description is analysed by search engines and displayed in search results. This text should be treated as an advertising text to maximise click-through from search engine result pages. Current recommended limit is 156 characters. |
|
description |
The item description. This is a detailed description displayed in the item layout of the online store. |
|
technicalData |
The technical data for the item. To display the technical data in the online store, insert the template variable TechnicalData and an optional title into the template ItemViewSingleItem. |
|
urlPath |
The URL path of the item in the online store. By default, the URL path consists of the categories and the item name. The path will be assigned automatically by plentymarkets when the item is created and will be displayed as part of the URL when the item is selected in the online store. |
|
metaKeywords |
Meta keywords to tag the item for search engines. More than one keyword can be separated by commas. |
Methods
public toArray()Returns this model as an array.
VariationImage
Contracts
VariationImageRepositoryContract
The contract of the variation image repository
Namespace
Plenty\Modules\Item\VariationImage\Contracts
Methods
public create($data):Plenty\Modules\Item\VariationImage\Models\VariationImageReturn type: VariationImage
Creates link between image and variation
Name |
Type |
Description |
|
The variation image data as an associative array |
public delete($variationId, $imageId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes Link between image and variation
Name |
Type |
Description |
|
The unique ID of the variation |
|
|
The unique ID of the image |
public findByImageId($imageId):arrayLists variations linked to an image
Name |
Type |
Description |
|
The unique ID of the image |
public findByVariationId($variationId):arrayLists images linked to a variation
Name |
Type |
Description |
|
The unique ID of the variation |
public findByItemId($itemId):arrayLists all images linked to an item. The ID of the item must be specified.
Name |
Type |
Description |
|
The unique ID of the image |
public findById($id):Plenty\Modules\Item\VariationImage\Models\VariationImageReturn type: VariationImage
Gets an image link
Name |
Type |
Description |
|
The unique ID of the image link |
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
VariationImage
Namespace
Plenty\Modules\Item\VariationImage\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the link between a variation and an image |
|
itemId |
The unique ID of the item |
|
variationId |
The unique ID of the variation |
|
imageId |
The unique ID of the image |
|
createdAt |
The time the image was linked to the variation. |
|
updatedAt |
The time the link between an image and a variation was last updated. |
Methods
public toArray()Returns this model as an array.
VariationMarket
Contracts
VariationMarketRepositoryContract
The contract of the variation market repository
Namespace
Plenty\Modules\Item\VariationMarket\Contracts
Methods
public findOne($variationId, $marketplaceId):Plenty\Modules\Item\VariationMarket\Models\VariationMarketReturn type: VariationMarket
Gets the data of a market linked to a variation. The ID of the market and the ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
|
|
The unique ID of the market |
public create($data):Plenty\Modules\Item\VariationMarket\Models\VariationMarketReturn type: VariationMarket
Creates a link between a market and a variation and adds market data.
Name |
Type |
Description |
|
The variation market data as an associative array |
public delete($marketplaceId, $variationId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes the link between a market and a variation. The ID of the market and the ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the market |
|
|
The unique ID of the variation |
public findByVariationId($variationId):Plenty\Modules\Item\VariationMarket\Models\VariationMarketReturn type: VariationMarket
Lists the markets linked to a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
public findByVariationIdWithInheritance($variationId):Plenty\Modules\Item\VariationMarket\Models\VariationMarketReturn type: VariationMarket
Lists the markets linked to a variation with inheritance details. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
public getVariationMarkets($itemsPerPage = 50, $page = 1):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Lists all links between variations and markets.
Name |
Type |
Description |
|
||
|
public createBulk($data):voidCreates up to 50 links between variations and markets.
Name |
Type |
Description |
|
public deleteBulk($itemId, $variationId):voidDeletes all market links of the variation specified.
Name |
Type |
Description |
|
||
|
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
Models
VariationMarket
Variation Market
Namespace
Plenty\Modules\Item\VariationMarket\Models
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation |
|
marketId |
The unique ID of the market |
|
createdAt |
The time the link between the variation and the market was created. |
Methods
public toArray()Returns this model as an array.
VariationMarketIdentNumber
Contracts
VariationMarketIdentNumberRepositoryContract
The contract of the variation market ident number repository
Namespace
Plenty\Modules\Item\VariationMarketIdentNumber\Contracts
Methods
public show($variationMarketIdentNumberId):Plenty\Modules\Item\VariationMarketIdentNumber\Models\VariationMarketIdentNumberReturn type: VariationMarketIdentNumber
Gets a market ident number (ASIN/ePID) of a variation. The ID of the market ident number must be specified.
Name |
Type |
Description |
|
The unique ID of the market ident number |
public create($data):Plenty\Modules\Item\VariationMarketIdentNumber\Models\VariationMarketIdentNumberReturn type: VariationMarketIdentNumber
Creates a new market ident number (ASIN/ePID) for a variation.
Name |
Type |
Description |
|
The variation market ident number data as an associative array |
public update($data, $variationMarketIdentNumberId):Plenty\Modules\Item\VariationMarketIdentNumber\Models\VariationMarketIdentNumberReturn type: VariationMarketIdentNumber
Updates a market ident number (ASIN/ePID) of a variation. The ID of the market ident number must be specified.
Name |
Type |
Description |
|
The variation market ident number data as an associative array |
|
|
The unique ID of the market ident number |
public delete($variationMarketIdentNumberId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a market ident number (ASIN/ePID) of a variation. The ID of the market ident number must be specified.
Name |
Type |
Description |
|
The unique ID of the market ident number |
public findByVariationId($variationId):arrayLists the market ident numbers (ASIN/ePID) of a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
Models
VariationMarketIdentNumber
Variation Market Ident Number
Namespace
Plenty\Modules\Item\VariationMarketIdentNumber\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the market ident number (ASIN/ePID) of a variation |
|
variationId |
The unique ID of the variation |
|
countryId |
The country code of the market ident number (ASIN/ePID) |
|
type |
The type of market ident number (ASIN/ePID) |
|
position |
The position of the market ident number (ASIN/ePID) |
|
value |
The value of the market ident number (ASIN/ePID) |
Methods
public toArray()Returns this model as an array.
VariationProperty
Contracts
VariationPropertyValueRepositoryContract
The contract of the variation property value repository
Namespace
Plenty\Modules\Item\VariationProperty\Contracts
Methods
public create($data):Plenty\Modules\Item\VariationProperty\Models\VariationPropertyValueReturn type: VariationPropertyValue
Creates a link between a property value and a variation and adds property value data.
Name |
Type |
Description |
|
The variation property value data as an associative array |
public show($variationId, $id):Plenty\Modules\Item\VariationProperty\Models\VariationPropertyValueReturn type: VariationPropertyValue
Gets the data of a property value linked to a variation. The ID of the variation property value and the variation ID must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
|
|
The unique ID of the link between a variation and a property value |
public update($data, $variationId, $id):Plenty\Modules\Item\VariationProperty\Models\VariationPropertyValueReturn type: VariationPropertyValue
Updates the data of a variation property linked to a variation. The ID of the variation property value and the variation ID must be specified.
Name |
Type |
Description |
|
The variation property value data as an associative array |
|
|
The ID of the Variation |
|
|
The unique ID of the link between a property value and a variation |
public delete($variationId, $id):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes the link between a property value and a variation. The ID of the variation property value and the variation ID must be specified.
Name |
Type |
Description |
|
The ID of the variation |
|
|
The unique ID of the link between a variation and a property value |
public deleteAll($variationId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes all links between a variation and its property values. The ID of the variation must be specified.
Name |
Type |
Description |
|
The ID of the variation |
public findByVariationId($variationId):arrayLists the property values linked to a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
public createBulk($data):Illuminate\Support\CollectionReturn type: Collection
Creates a list of variation properties.
Name |
Type |
Description |
|
The array containing the data. |
public updateBulk($data):Illuminate\Support\CollectionReturn type: Collection
Updates a list of variation properties.
Name |
Type |
Description |
|
The array containing the data. |
VariationPropertyValueTextRepositoryContract
The contract of the variation property value text repository
Namespace
Plenty\Modules\Item\VariationProperty\Contracts
Methods
public create($data):Plenty\Modules\Item\VariationProperty\Models\VariationPropertyValueTextReturn type: VariationPropertyValueText
Saves text for a specific property of the type Text in the specified language. The ID of the property value and the language must be specified.
Name |
Type |
Description |
|
public update($valueId, $lang, $data):Plenty\Modules\Item\VariationProperty\Models\VariationPropertyValueTextReturn type: VariationPropertyValueText
Updates the text saved for a specific property of the type Text in the specified language. The ID of the property value and the language must be specified.
Name |
Type |
Description |
|
||
|
||
|
public delete($valueId, $lang):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes the text saved for a specific property of the type Text in the specified language. The ID of the property value and the language must be specified.
Name |
Type |
Description |
|
||
|
public show($valueId, $lang):Plenty\Modules\Item\VariationProperty\Models\VariationPropertyValueTextReturn type: VariationPropertyValueText
Gets the text saved for a specific property of the type Text in the specified language. The ID of the property value and the language must be specified.
Name |
Type |
Description |
|
||
|
public findByPropertyValue($valueId):voidGets the texts saved for a specific property of the type Text in all available languages. The ID of the property value must be specified.
Name |
Type |
Description |
|
Models
VariationPropertyValue
The variation property value model. Represents a link between characteristic and item.
Namespace
Plenty\Modules\Item\VariationProperty\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the link between the variation and the property value |
|
variationId |
The unique ID of the variation |
|
propertyId |
The unique ID of the property |
|
propertySelectionId |
The unique ID of the property selection of the variation |
|
valueInt |
The int value of the property value of the variation |
|
valueFloat |
The float value of the property value of the variation |
|
valueFile |
The file value of the property value of the variation |
|
surcharge |
The surcharge of the property value of the variation |
|
names |
Collection of the variationPropertyValueNames names that belong to this variationPropertyValue |
|
property |
||
propertySelection |
||
valueTexts |
Methods
public toArray()Returns this model as an array.
VariationPropertyValueName
The property name of the variation
Namespace
Plenty\Modules\Item\VariationProperty\Models
| Name | Type | Description |
|---|---|---|
propertyValueId |
The unique ID of the link between the variation and the property |
|
lang |
The <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">language</a> of the property value name. |
|
value |
The value of the property value name in the specified language |
Methods
public toArray()Returns this model as an array.
VariationPropertyValueText
The variation property value text model. Includes language specific information for a variation property value.
Namespace
Plenty\Modules\Item\VariationProperty\Models
| Name | Type | Description |
|---|---|---|
valueId |
The unique ID of the link between the variation and the property |
|
lang |
The <a href="https://developers.plentymarkets.com/rest-doc/introduction#languages" target="_blank">language</a> of the property value text |
|
value |
The text saved for the property of the type Text |
|
characteristic |
Methods
public toArray()Returns this model as an array.
VariationSalesPrice
Contracts
VariationSalesPriceRepositoryContract
The contract of the variation sales price repository
Namespace
Plenty\Modules\Item\VariationSalesPrice\Contracts
Methods
public show($salesPriceId, $variationId):Plenty\Modules\Item\VariationSalesPrice\Models\VariationSalesPriceReturn type: VariationSalesPrice
Gets the price data of a sales price linked to a variation. The ID of the sales price and the ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
The unique ID of the variation |
public create($data):Plenty\Modules\Item\VariationSalesPrice\Models\VariationSalesPriceReturn type: VariationSalesPrice
Creates a link between a sales price and a variation and adds sales price data.
Name |
Type |
Description |
|
The variation sales price data as an associative array |
public update($data, $salesPriceId, $variationId):Plenty\Modules\Item\VariationSalesPrice\Models\VariationSalesPriceReturn type: VariationSalesPrice
Updates the data of a sales price linked to a variation.
Name |
Type |
Description |
|
The variation sales price data as an associative array |
|
|
The unique ID of the sales price |
|
|
The unique ID of the variation |
public delete($salesPriceId, $variationId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a link between a sales price and a variation and deletes the sales price data. The ID of the sales price and the ID of the variation must be specified. An exception is thrown if at least one relation exists.
Name |
Type |
Description |
|
The unique ID of the sales price |
|
|
The unique ID of the variation |
public deleteAll($variationId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes all links between a variation and its sales prices and deletes the sales price data. The ID of the variation must be specified.
Name |
Type |
Description |
|
The ID of the variation |
public findByVariationId($variationId):Plenty\Modules\Item\VariationSalesPrice\Models\VariationSalesPriceReturn type: VariationSalesPrice
Lists the data of the sales prices linked to a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
public findByVariationIdWithInheritance($variationId):Plenty\Modules\Item\VariationSalesPrice\Models\VariationSalesPriceReturn type: VariationSalesPrice
Lists the data of the sales prices linked to a variation with inheritance details. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
public updateBulk($data):Illuminate\Support\CollectionReturn type: Collection
Updates a list of variation prices. The variation ID, sales price ID and a new price must be specified.
Name |
Type |
Description |
|
The array containing the data. |
public createBulk($data):Illuminate\Support\CollectionReturn type: Collection
Creates a list of variation prices. The variation ID, sales price ID and a new price must be specified.
Name |
Type |
Description |
|
The array containing the data. |
public findAll($itemsPerPage = 100, $page = 1):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Gets all sales price relations.
Name |
Type |
Description |
|
||
|
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
Models
VariationSalesPrice
VariationSalesPrice
Namespace
Plenty\Modules\Item\VariationSalesPrice\Models
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation |
|
salesPriceId |
The unique ID of the sales price |
|
price |
The price of the variation saved for this sales price |
|
lowestPrice |
The lowest price of the variation saved for this sales price |
|
lowestPriceCalculation |
Is the lowest price calculation active for this sales price |
|
updatedAt |
The time the sales price was last updated. |
|
createdAt |
The time the sales price was created. |
Methods
public toArray()Returns this model as an array.
VariationSku
Contracts
VariationSkuBulkRepositoryContract
The contract of the variation SKU bulk repository.
Namespace
Plenty\Modules\Item\VariationSku\Contracts
Methods
public create($data):voidCreates multiple SKUs.
Name |
Type |
Description |
|
public updateStatus($ids, $status):voidUpdates status for multiple SKUs.
Name |
Type |
Description |
|
||
|
public updateExportedAt($ids, $time = ""):voidUpdates exportedAt for multiple SKUs.
Name |
Type |
Description |
|
||
|
public updateStockUpdatedAt($ids, $time = ""):voidUpdates stockUpdatedAt for multiple SKUs.
Name |
Type |
Description |
|
||
|
public updateDeletedAt($ids, $time = null):voidUpdates deletedAt for multiple SKUs.
Name |
Type |
Description |
|
||
|
public delete($data):intDeletes multiple SKUs.
Name |
Type |
Description |
|
VariationSkuRepositoryContract
The contract of the variation sku repository
Namespace
Plenty\Modules\Item\VariationSku\Contracts
Methods
public generateSkuWithParent($variation, $marketId, $accountId, $sku = null, $parentSku = null, $setLastExportedTimestamp = true, $returnObject = false):voidGenerates or updates an SKU and parent SKU
Name |
Type |
Description |
|
The array of values from the variation |
|
|
The unique ID of the market |
|
|
The unique ID of the account |
|
|
||
|
||
|
||
|
public generateSku($variationId, $marketId, $accountId, $sku = null, $setLastExportedTimestamp = true, $returnObject = false):voidGenerates or updates an SKU
Name |
Type |
Description |
|
The unique ID of the SKU |
|
|
The unique ID of the market |
|
|
The unique ID of the account |
|
|
||
|
||
|
public create($data):Plenty\Modules\Item\VariationSku\Models\VariationSkuReturn type: VariationSku
Creates an SKU
Name |
Type |
Description |
|
public update($data, $skuId):Plenty\Modules\Item\VariationSku\Models\VariationSkuReturn type: VariationSku
Updates an SKU
Name |
Type |
Description |
|
||
|
The unique ID of the SKU |
public delete($skuId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes an SKU
Name |
Type |
Description |
|
The unique ID of the SKU |
public show($skuId):Plenty\Modules\Item\VariationSku\Models\VariationSkuReturn type: VariationSku
Gets an SKU
Name |
Type |
Description |
|
The unique ID of the SKU |
public search($filter, $limit = null, $page = 1):arrayLists SKUs
Name |
Type |
Description |
|
||
|
limits the result to the specified amound |
|
|
defines at which entity the result should start depending on the provided limit |
public findByVariationId($variationId):arrayLists SKUs
Name |
Type |
Description |
|
The unique ID of the variation |
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
VariationSku
The variation SKU model
Namespace
Plenty\Modules\Item\VariationSku\Models
| Name | Type | Description |
|---|---|---|
id |
The row ID of the table plenty_item_variation_market_status |
|
variationId |
The ID of the variation |
|
marketId |
The ID of the market |
|
accountId |
The ID of the market account |
|
initialSku |
The initial SKU of the variation. The initial SKU cannot be modified even if the variation SKU is changed. However, it is possible to reset the variation SKU to the initial SKU. |
|
sku |
The SKU of the variation. The SKU is adjustable but may not exist twice for the combination of market Id and account Id. |
|
parentSku |
The Parent SKU of the variation. The Parent SKU is adjustable. The same Parent SKU value should be used on variations of same article. |
|
isActive |
Flag that indicates if the item is ready for export (currently not in use). |
|
createdAt |
The time the SKU was created (YYYY-MM-DD HH:MM:SS). |
|
updatedAt |
The time the SKU was updated (YYYY-MM-DD HH:MM:SS). |
|
exportedAt |
The time the variation was last exported (YYYY-MM-DD HH:MM:SS). |
|
stockUpdatedAt |
||
deletedAt |
The time the variation was deleted (YYYY-MM-DD HH:MM:SS). |
|
status |
The status of the variation after the export. Possible entries are INACTIVE, ERROR, SENT and ACTIVE. |
|
additionalInformation |
The field that contains additional information. |
Methods
public toArray()Returns this model as an array.
VariationStock
Contracts
VariationStockRepositoryContract
The contract of the variation stock repository
Namespace
Plenty\Modules\Item\VariationStock\Contracts
Methods
public listStockByWarehouse($variationId, $columns = [], $page = 1, $itemsPerPage = 200):arrayList stock per warehouse
Name |
Type |
Description |
|
The ID of the variation |
|
|
The properties to be loaded |
|
|
The requested page |
|
|
The number of items per page |
public listStockMovements($variationId, $columns, $page, $itemsPerPage):arrayList stock movements for a variation
Name |
Type |
Description |
|
The ID of the variation |
|
|
The properties to be loaded |
|
|
The requested page |
|
|
The number of items per page |
public bookIncomingItems($variationId, $data):arrayBook incoming stock
Name |
Type |
Description |
|
The ID of the variation |
|
|
The request data |
public bookOutgoingItems($variationId, $data):arrayBook outgoing stock
Name |
Type |
Description |
|
The ID of the variation |
|
|
The request data |
public correctStock($variationId, $data, $calcStockLater = false, $finishReceiptLater = false, $deactivateAutoTransaction = false):arrayCorrect stock
Name |
Type |
Description |
|
The ID of the variation |
|
|
The request data |
|
|
||
|
||
|
public redistributeStock($variationId, $data):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Redistribute stock
Name |
Type |
Description |
|
The ID of the variation |
|
|
The request data |
public finishReceipt():voidFinish receipt
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
VariationStock
The variation stock model
Namespace
Plenty\Modules\Item\VariationStock\Models
| Name | Type | Description |
|---|---|---|
itemId |
The ID of the item |
|
variationId |
The ID of the variation |
|
warehouseId |
The ID of the warehouse |
|
reservedListing |
The quantity of a variation that is reserved for listings |
|
reservedBundles |
The quantity of a variation that is reserved for item bundles |
|
valueOfGoods |
The value of goods based on the physical stock |
|
purchasePrice |
The purchase price of the variation stock |
|
physicalStock |
The physical stock of the variation stock |
|
reservedStock |
The reserved stock of the variation stock |
|
netStock |
The net stock is the stock that can still be sold |
|
reorderLevel |
The quantity of a variation that triggers a reorder |
|
deltaReorderLevel |
The quantity of a variation that is required to reach the reorder level |
Methods
public toArray()Returns this model as an array.
VariationStockMovement
The variation stock movement model
Namespace
Plenty\Modules\Item\VariationStock\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of the stock movement |
|
itemId |
The ID of the item |
|
variationId |
The ID of the variation |
|
warehouseId |
The ID of the warehouse |
|
reasonString |
The reason string |
|
attributeValues |
The attribute values of a variation |
|
processRowId |
The ID is either the actual ID of an order or of an incoming item data set. Whether it is an order ID or an incoming item data set ID depends on the processRowType. |
|
quantity |
The quantity |
|
reason |
The reason for the movement |
|
createdAt |
The date and time that the movement was created. This date is in W3C format. |
|
processRowType |
The type of the stock movement <ul> <li>1 = incoming item data set</li> <li>2 = order</li> <li>3 = deleted stock movement</li> <li>4 = new stock intake</li> </ul> |
|
bestBeforeDate |
The best before date for the movement |
|
batch |
The batch for the movement |
|
storageLocationName |
The name of the storage location |
|
warehouseName |
The name of the warehouse |
|
purchasePrice |
The purchase price of a variation |
|
userId |
The id of the user. Can be null if the movement was not triggered by an user. |
Methods
public toArray()Returns this model as an array.
VariationSupplier
Contracts
VariationSupplierRepositoryContract
The contract for the variation supplier repository
Namespace
Plenty\Modules\Item\VariationSupplier\Contracts
Methods
public show($id):Plenty\Modules\Item\VariationSupplier\Models\VariationSupplierReturn type: VariationSupplier
Gets the data of a supplier linked to a variation. The variation supplier ID must be specified.
Name |
Type |
Description |
|
The unique ID of the link between variation and supplier |
public create($data):Plenty\Modules\Item\VariationSupplier\Models\VariationSupplierReturn type: VariationSupplier
Creates a link between a supplier and a variation and adds supplier data.
Name |
Type |
Description |
|
The variation supplier data as an associative array |
public update($data, $id):Plenty\Modules\Item\VariationSupplier\Models\VariationSupplierReturn type: VariationSupplier
Updates the data of a supplier linked to a variation. The variation supplier ID must be specified.
Name |
Type |
Description |
|
The variation supplier data as an associative array |
|
|
The unique ID of the link between variation and supplier |
public delete($id):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes a link between a supplier and a variation. The variation supplier ID must be specified.
Name |
Type |
Description |
|
The unique ID of the link between variation and supplier |
public findByVariationId($variationId):arrayLists the data of the suppliers linked to a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
public findByVariationIdWithInheritance($variationId):arrayLists the data of the suppliers linked to a variation with inheritance details. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
Models
VariationSupplier
Variation Supplier
Namespace
Plenty\Modules\Item\VariationSupplier\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the link between variation and supplier |
|
variationId |
The unique ID of the variation |
|
supplierId |
The unique ID of the supplier |
|
purchasePrice |
The price at which the variation was purchased from this supplier. |
|
minimumPurchase |
The minimum quantity of the variation that has to be ordered from the supplier. This value is also used as a quantity suggestion when creating reorders. |
|
itemNumber |
The external item number assigned to the variation by this supplier |
|
lastPriceQuery |
The date of the last price query to this supplier. This helps to plan price negotiations. |
|
deliveryTimeInDays |
The delivery time in days for the variation saved for this supplier |
|
discount |
The discount in percent the supplier grants for the variation. |
|
isDiscountable |
Flag that indicates if the supplier’s discount for this variation is active. |
|
packagingUnit |
The packaging unit of the supplier if it differs from the packaging unit settings in plentymarkets. |
|
lastUpdateTimestamp |
The time the supplier data was last updated |
|
createdAt |
The time the supplier data was created |
|
currencyPurchasePrice |
The purchase price in the currency of the supplier |
|
itemDescription |
The supplier item description |
Methods
public toArray()Returns this model as an array.
VariationWarehouse
Contracts
VariationWarehouseRepositoryContract
The contract for the variation warehouse repository
Namespace
Plenty\Modules\Item\VariationWarehouse\Contracts
Methods
public show($variationId, $warehouseId):Plenty\Modules\Item\VariationWarehouse\Models\VariationWarehouseReturn type: VariationWarehouse
Gets the data of a warehouse linked to a variation. The ID of the variation and the ID of the warehouse must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
|
|
The unique ID of the warehouse |
public create($data):Plenty\Modules\Item\VariationWarehouse\Models\VariationWarehouseReturn type: VariationWarehouse
Creates a link between a warehouse and a variation and adds warehouse data.
Name |
Type |
Description |
|
The variation warehouse data as an associative array |
public update($data, $variationId, $warehouseId):Plenty\Modules\Item\VariationWarehouse\Models\VariationWarehouseReturn type: VariationWarehouse
Updates the data of a warehouse linked to a variation. The ID of the variation and the ID of the warehouse must be specified.
Name |
Type |
Description |
|
The variation warehouse data as an associative array |
|
|
The unique ID of the variation |
|
|
The unique ID of the warehouse |
public delete($variationId, $warehouseId):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Deletes the link between a warehouse and a variation. The ID of the variation and the ID of the warehouse must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
|
|
The unique ID of the warehouse |
public findByVariationId($variationId):arrayLists all warehouse data of a variation. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
public findByVariationIdWithInheritance($variationId, $with = [], $warehouseId = null, $storageLocationId = null):arrayLists all warehouse data of a variation with inheritance details. The ID of the variation must be specified.
Name |
Type |
Description |
|
The unique ID of the variation |
|
|
||
|
||
|
Models
VariationWarehouse
Variation Warehouse
Namespace
Plenty\Modules\Item\VariationWarehouse\Models
| Name | Type | Description |
|---|---|---|
variationId |
The unique ID of the variation |
|
warehouseId |
The unique ID of the warehouse |
|
warehouseZoneId |
The unique ID of the warehouse zone |
|
storageLocationType |
The storage location type of the warehouse |
|
reorderLevel |
The reorder level for the variation in this warehouse |
|
maximumStock |
The maximum stock for the variation in this warehouse |
|
stockTurnoverInDays |
The stock turnover in days for the variation in this warehouse |
|
storageLocation |
The storage location of the variation in this warehouse |
|
stockBuffer |
The stock buffer for the variation in this warehouse |
|
isBatch |
Is for warehouse and variation stock batch active |
|
isBestBeforeDate |
Is for warehouse and variation stock best before date active |
|
lastUpdateTimestamp |
The time the warehouse data was last updated. |
|
createdAt |
The time the warehouse data was created. |
Methods
public toArray()Returns this model as an array.