Plentymarkets interface documentation :: Developers documentation

Listing

Contracts

ListingRepositoryContract

The contract for the listing repository.

Namespace

Plenty\Modules\Listing\Contracts

Methods

public get($id, $with = []):Plenty\Modules\Listing\Models\Listing

Return type: `Listing`

Get a listing by a given ID.

**Parameters**
Name	Type	Description
`$id`	int	The ID of the listing.
`$with`	array	The relations to load in the listing instance, one of "markets", "type", "stockDependenceType", "properties".

public search($page = 1, $itemsPerPage = 50, $with = [], $filters = []):Plenty\Repositories\Models\PaginatedResult

Return type: `PaginatedResult`

List listing

**Parameters**
Name	Type	Description
`$page`	int	The default page that will be returned is page 1.
`$itemsPerPage`	int	The number of entries to be displayed per page. The default number of entries per page is 50.
`$with`	array	The relations to load in the ListingMarket instance. The relations available are 'type', 'stockDependenceType' and 'markets'.
`$filters`	array	The filters that could be applied: 'id', 'itemId', 'typeId', 'stockDependenceTypeId', 'unitCombinationId'

public create($data):Plenty\Modules\Listing\Models\Listing

Return type: `Listing`

Create new listing

**Parameters**
Name	Type	Description
`$data`	array	The listing data as associative array.

public update($id, $data):Plenty\Modules\Listing\Models\Listing

Return type: `Listing`

Update listing

**Parameters**
Name	Type	Description
`$id`	int	The ID of the listing.
`$data`	array	The listing data as associative array.

public delete($id):bool

Delete listing

**Parameters**
Name	Type	Description
`$id`	int	The ID of the listing.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

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

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Listing

The listing model.

Namespace

Plenty\Modules\Listing\Models

Properties
Name	Type	Description
id	int	The ID of the listing.
itemId	int	The ID of the item.
typeId	int	The ID of the listing type. Possible types are: <ul> <li>1 = Auction</li> <li>2 = Fixed</li> <li>3 = Shop item</li> </ul>
stockDependenceTypeId	int	The ID of the listing stock dependence. Possible stock dependence types are: <ul> <li>1 = Unlimited with sync</li> <li>2 = Limited with reservation</li> <li>3 = Limited without reservation</li> <li>4 = Unlimited without sync</li> </ul>
unitCombinationId	int	The ID of the unit combination.
properties		The listing properties of the listing.
type	`ListingType`	The type of the listing.
stockDependenceType	`StockDependenceType`	The stock dependence type of the listing.
markets	`ListingMarket`	The listing markets of the listing

Methods

public toArray()

Returns this model as an array.

ListingProperty

The listing properties model. Each listing property has a type.

Namespace

Plenty\Modules\Listing\Models

Properties
Name	Type	Description
id	int	The ID of the listing property.
listingId	int	The ID of the listing that the property belongs to.
typeId	int	The ID of the listing property type. The following types are available: <ul> <li>10 = Use item price</li> <li>11 = Number per lot</li> <li>12 = Transmit item number type</li> </ul>
value		The value of the listing property. The value depends on the type.
createdAt		The date that the property was created.
updatedAt		The date that the property was last updated.
listing	`Listing`	The listing that the property belongs to.

Methods

public toArray()

Returns this model as an array.

Date

Models

ListingDateType

The listing date type model. Each listing date type can have multiple names.

Namespace

Plenty\Modules\Listing\Date\Models

Properties
Name	Type	Description
id	int	The ID of the listing date type. The following date types are available: <ul> <li>1 = Last price update</li> <li>2 = Last listing attempt</li> <li>3 = Start time</li> <li>4 = End time</li> <li>5 = Last market update</li> <li>6 = Last sale</li> </ul>
isErasable	bool	Flag that indicates if this type can be deleted or not.
names	array	The listing date type names.

Methods

public toArray()

Returns this model as an array.

ListingDateTypeName

The listing date type name model.

Namespace

Plenty\Modules\Listing\Date\Models

Properties
Name	Type	Description
id	int	The ID of the listing date type name.
typeId	int	The listing date type ID that the current name belongs to.
name	int	The name of the listing date type.
lang	int	The language of the listing date type name.

Methods

public toArray()

Returns this model as an array.

LayoutTemplate

Contracts

LayoutTemplateRepositoryContract

The LayoutTemplateRepositoryContract is the interface for the layout template repository. This interface allows you to get a single layout template or lists of layout templates as well as to create, update or delete a layout tempalte.

Namespace

Plenty\Modules\Listing\LayoutTemplate\Contracts

Methods

public get($id, $with = []):Plenty\Modules\Listing\LayoutTemplate\Models\LayoutTemplate

Return type: `LayoutTemplate`

Get a layout template.

**Parameters**
Name	Type	Description
`$id`	int	The ID of the layout template.
`$with`	array	The relations to load in the LayoutTemplate instance, one of "additional".

public create($data):Plenty\Modules\Listing\LayoutTemplate\Models\LayoutTemplate

Return type: `LayoutTemplate`

Create a layout template.

**Parameters**
Name	Type	Description
`$data`	array	The layout template data.

public delete($id):bool

Delete layout template

**Parameters**
Name	Type	Description
`$id`	int	The ID of the layout template.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

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

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

LayoutTemplate

The layout template model.

Namespace

Plenty\Modules\Listing\LayoutTemplate\Models

Properties
Name	Type	Description
id	int	The ID of the layout template.
name	string	The name of the layout template.
css	string	The css of the layout template.
htmlStructure	string	The html structure of the layout template.
mainFrame	string	The main frame of the layout template.
additionalContent	array	The additional content of the layout template.
appendixType	string	The appendix type of the layout template.

Methods

public toArray()

Returns this model as an array.

Market

Contracts

ListingMarketRepositoryContract

The ListingMarketRepositoryContract is the interface for the listing market repository. This interface allows you to get a single listing market or lists of listing markets as well as to create a listing market.

Namespace

Plenty\Modules\Listing\Market\Contracts

Repository can be extended!

It is possible to extend this repository with own search criteria.

Methods

public get($id, $with = []):Plenty\Modules\Listing\Market\Models\ListingMarket

Return type: `ListingMarket`

Get a listing market

**Parameters**
Name	Type	Description
`$id`	int	The ID of the listing market.
`$with`	array	The relations to load in the ListingMarket instance, one of "listing", "prices", "dates", "properties", "texts", "infos".

public search($page = 1, $itemsPerPage = 50, $with = [], $filters = []):Plenty\Repositories\Models\PaginatedResult

Return type: `PaginatedResult`

List listing markets

**Parameters**
Name	Type	Description
`$page`	int	The page to get. The default page that will be returned is page 1.
`$itemsPerPage`	int	The number of entries to be displayed per page. The default number of entries per page is 50.
`$with`	array	The relations to load in the ListingMarket instance, one of "listing", "prices", "dates", "properties", "texts", "infos".
`$filters`	array	The filters that should be applied. The filters that could be applied: 'id', 'variationId', 'allVariations', 'referrerId', 'credentialsId', 'directoryId', 'verified', 'duration', 'listingId', 'itemId', 'listingTypeId', 'stockDependenceTypeId', 'status', 'stockCondition', 'shippingProfileId', .

public find($page = 1, $itemsPerPage = 50, $with = [], $filters = []):Plenty\Repositories\Models\PaginatedResult

Return type: `PaginatedResult`

Find listing markets

**Parameters**
Name	Type	Description
`$page`	int	The page to get. The default page that will be returned is page 1.
`$itemsPerPage`	int	The number of entries to be displayed per page. The default number of entries per page is 50.
`$with`	array	The relations to load in the ListingMarket instance, one of "listing", "prices", "dates", "properties", "texts", "infos".
`$filters`	array	The filters that should be applied. The filters that could be applied: 'id', 'variationId', 'allVariations', 'referrerId', 'credentialsId', 'directoryId', 'verified', 'duration', 'listingId', 'itemId', 'listingTypeId', 'stockDependenceTypeId', 'status', 'stockCondition', 'shippingProfileId', .

public create($data):array

Create a listing

**Parameters**
Name	Type	Description
`$data`	array	The listing market data.

public update($id, $data):Plenty\Modules\Listing\Market\Models\ListingMarket

Return type: `ListingMarket`

Update listing market

**Parameters**
Name	Type	Description
`$id`	int	The ID of the listing market.
`$data`	array	The listing market data as associative array.

public start($ids, $params = []):array

Start listing markets on the designated markets.

**Parameters**
Name	Type	Description
`$ids`	array	The IDs of the listing markets that need to be started.
`$params`	array	The parameters that should be considered during start. Available values are 'startTime', 'startDistribution'

public verify($ids):array

Verifies listing markets.

**Parameters**
Name	Type	Description
`$ids`	array	The IDs of the listing markets that need to be verified.

public delete($id):void

Delete a listing market

**Parameters**
Name	Type	Description
`$id`	int	The ID of the listing market.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

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

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Events

ListingMarketBatchCreated

An event class fired after multiple new listing markets are created.

Namespace

Plenty\Modules\Listing\Market\Events

Methods

public __construct($listingMarkets):void

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

public getListingMarkets():array

Get the list of ListingMarket instances.

ListingMarketBatchDeleted

An event class fired after multiple listing markets are deleted.

Namespace

Plenty\Modules\Listing\Market\Events

Methods

public __construct($listingMarkets):void

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

public getListingMarkets():array

Get the list of ListingMarket instances.

ListingMarketBatchEvent

A base event class for all listing market events. Each listing market batch event expects an array of ListingMarket instances.

Namespace

Plenty\Modules\Listing\Market\Events

Methods

public __construct($listingMarkets):void

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

public getListingMarkets():array

Get the list of ListingMarket instances.

ListingMarketBatchUpdated

An event class fired after multiple listing markets are updated.

Namespace

Plenty\Modules\Listing\Market\Events

Methods

public __construct($listingMarkets):void

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

public getListingMarkets():array

Get the list of ListingMarket instances.

ListingMarketCreated

An event class fired after a new listing market is created.

Namespace

Plenty\Modules\Listing\Market\Events

Methods

public __construct($listingMarket):void

**Parameters**
Name	Type	Description
`$listingMarket`	`ListingMarket`

public getListingMarket():Plenty\Modules\Listing\Market\Models\ListingMarket

Return type: `ListingMarket`

Get the ListingMarket instance.

ListingMarketDeleted

An event class fired after a new listing market is deleted.

Namespace

Plenty\Modules\Listing\Market\Events

Methods

public __construct($listingMarket):void

**Parameters**
Name	Type	Description
`$listingMarket`	`ListingMarket`

public getListingMarket():Plenty\Modules\Listing\Market\Models\ListingMarket

Return type: `ListingMarket`

Get the ListingMarket instance.

ListingMarketEvent

A base event class for all listing market events. Each listing market event expects an ListingMarket instance.

Namespace

Plenty\Modules\Listing\Market\Events

Methods

public __construct($listingMarket):void

**Parameters**
Name	Type	Description
`$listingMarket`	`ListingMarket`

public getListingMarket():Plenty\Modules\Listing\Market\Models\ListingMarket

Return type: `ListingMarket`

Get the ListingMarket instance.

ListingMarketItemSpecificsCreated

An event class fired after a new listing market item specifics are created.

Namespace

Plenty\Modules\Listing\Market\Events

Methods

public __construct($listingMarket):void

**Parameters**
Name	Type	Description
`$listingMarket`	`ListingMarket`

public getListingMarket():Plenty\Modules\Listing\Market\Models\ListingMarket

Return type: `ListingMarket`

Get the ListingMarket instance.

ListingMarketItemSpecificsDeleted

An event class fired after a new listing market item specifics are deleted.

Namespace

Plenty\Modules\Listing\Market\Events

Methods

public __construct($listingMarket):void

**Parameters**
Name	Type	Description
`$listingMarket`	`ListingMarket`

public getListingMarket():Plenty\Modules\Listing\Market\Models\ListingMarket

Return type: `ListingMarket`

Get the ListingMarket instance.

ListingMarketUpdated

An event class fired after a new listing market is updated.

Namespace

Plenty\Modules\Listing\Market\Events

Methods

public __construct($listingMarket):void

**Parameters**
Name	Type	Description
`$listingMarket`	`ListingMarket`

public getListingMarket():Plenty\Modules\Listing\Market\Models\ListingMarket

Return type: `ListingMarket`

Get the ListingMarket instance.

Models

ListingMarket

The listing market model.

Namespace

Plenty\Modules\Listing\Market\Models

Properties
Name	Type	Description
id	int	The ID of the listing market.
listingId	int	The listing ID of the current listing market.
variationId	int	The variation ID for this listing market.
referrerId	int	The ID of the referrer.
credentialsId	int	The credentials ID that this listing market belongs to.
directoryId	int	The directory ID of the listing market.
enabled	bool	Indicates if the listing market is enabled.
duration	string	The duration of the listing market.
verified	string	Indicates if the listing market has been verified. Possible values are: 'succeeded', 'failed', 'unknown'.
quantity	int	The quantity set for this listing market.
allVariations	bool	Indicates if all variations should be included.
createdAt		The date that the listing was created.
updatedAt		The date that the listing was last updated.
listing	`Listing`	The listing that the listing market belongs to.
properties		The listing market properties of the listing market. The following properties are available: <ul> <li>1 = Shipping profile ID</li> <li>2 = Order status</li> <li>3 = Layout template ID</li> <li>4 = Maximum number of images</li> <li>5 = Warehouse ID</li> <li>6 = Basic price in text</li> <li>7 = Vat value</li> <li>8 = Vat country ID</li> <li>9 = Main language</li> <li>10 = Use item price</li> <li>11 = Number per lot</li> <li>12 = Transmit item number type</li> <li>13 = Relisted external ID</li> <li>14 = SCO offer</li> <li>15 = Promotion</li> <li>16 = UUID</li> <li>17 = Update error</li> <li>18 = Has variations</li> <li>19 = End now</li> <li>20 = Insert by type</li> <li>21 = Payment methods</li> <li>22 = First platform category ID</li> <li>23 = Second platform category ID</li> <li>24 = First shop category ID</li> <li>25 = Second shop category ID</li> <li>26 = Third shop category ID</li> <li>27 = Enhancements</li> <li>100 = eBay parts fitment ID</li> <li>101 = eBay maximum online listings</li> <li>102 = eBay private auction</li> <li>103 = eBay gallery type</li> <li>104 = eBay gallery duration</li> <li>105 = eBay transmit MPR</li> <li>106 = eBay counter type</li> <li>107 = eBay condition ID</li> <li>108 = eBay condition description</li> <li>109 = eBay best offer</li> <li>110 = eBay best offer decline price</li> <li>111 = eBay best offer accept price</li> <li>112 = eBay is eBay Plus</li> <li>113 = eBay is click & Collect</li> <li>114 = eBay use EPS</li> <li>200 = Hood show on shop startpage</li> <li>201 = Hood shipping discount</li> <li>202 = Hood delivery days on stock from</li> <li>203 = Hood delivery days on stock to</li> <li>204 = Hood delivery days not on stock from</li> <li>205 = Hood delivery days not on stock to</li> <li>300 = Ricardo warranty ID</li> <li>301 = Ricardo delivery ID</li> <li>302 = Ricardo availability ID</li> <li>303 = Ricardo delivery cost</li> <li>304 = Ricardo payment ID</li> <li>305 = Ricardo price increment</li> <li>306 = Ricardo item condition ID</li> <li>307 = Ricardo max relist count</li> <li>308 = Ricardo is cumulative shipping</li> <li>309 = Ricardo delivery package size ID</li> <li>310 = Ricardo use secondary language</li> <li>311 = Ricardo template ID</li> <li>312 = Ricardo is relist sold out</li> </ul>
itemSpecifics		The listing market item specifics of the listing market.
prices		The listing market prices of the listing market.
dates		The listing market dates of the listing market.
texts		The listing market texts of the listing market.
infos		The listing market infos of the listing market.
lister		The listing market lister of the listing market.
histories		The listing market histories of the listing market.

Methods

public toArray()

Returns this model as an array.

ListingMarketDate

The listing market dates model. Each listing market date has a type.

Namespace

Plenty\Modules\Listing\Market\Models

Properties
Name	Type	Description
id	int	The ID of the listing market date.
listingMarketId	int	The ID of the listing market that the date belongs to.
typeId	int	The ID of the listing market date type. The following types are available: <ul> <li>1 = Last price update</li> <li>2 = Last listing attempt</li> <li>3 = Start time</li> <li>4 = End time</li> <li>5 = Last market update</li> </ul>
date	`Carbon`	The date plus hours, minutes and seconds. The date format must comply with the W3C standard.
createdAt		The date that the date was created.
updatedAt		The date that the date was last updated.
listingMarket	`ListingMarket`	The listing market that the date belongs to.

Methods

public toArray()

Returns this model as an array.

ListingMarketItemSpecific

The listing market item specific model.

Namespace

Plenty\Modules\Listing\Market\Models

Properties
Name	Type	Description
id	int	The ID of the listing market item specific.
listingMarketId	int	The ID of the listing market.
name	string	The name of the listing market item specific.
value		The value of the listing market item specific.

Methods

public toArray()

Returns this model as an array.

ListingMarketPrice

The listing market price model.

Namespace

Plenty\Modules\Listing\Market\Models

Properties
Name	Type	Description
id	int	The ID of the listing price.
listingMarketId	int	The ID of the listing market.
typeId	int	The ID of the listing price type.
value	float	The value of the listing market price.
currency	string	The currency of the listing market price.
listingMarket		The listing market.
type		The listing price type.

Methods

public toArray()

Returns this model as an array.

ListingMarketProperty

The listing market properties model. Each listing market property has a type.

Namespace

Plenty\Modules\Listing\Market\Models

Properties
Name	Type	Description
id	int	The ID of the listing market property.
listingMarketId	int	The ID of the listing market that the property belongs to.
typeId	int	The ID of the listing market property type. The following types are available: <ul> <li>1 = Shipping profile ID</li> <li>2 = Order status</li> <li>3 = Layout template ID</li> <li>4 = Maximum number of images</li> <li>5 = Warehouse ID</li> <li>6 = Basic price in text</li> <li>7 = Vat value</li> <li>8 = Vat country ID</li> <li>9 = Main language</li> <li>10 = Use item price</li> <li>11 = Number per lot</li> <li>12 = Transmit item number type</li> <li>13 = Relisted external ID</li> <li>14 = SCO offer</li> <li>15 = Promotion</li> <li>16 = UUID</li> <li>17 = Update error</li> <li>18 = Has variations</li> <li>19 = End now</li> <li>20 = Insert by type</li> <li>21 = Payment methods</li> <li>22 = First platform category ID</li> <li>23 = Second platform category ID</li> <li>24 = First shop category ID</li> <li>25 = Second shop category ID</li> <li>26 = Third shop category ID</li> <li>27 = Enhancements</li> <li>100 = eBay parts fitment ID</li> <li>101 = eBay maximum online listings</li> <li>102 = eBay private auction</li> <li>103 = eBay gallery type</li> <li>104 = eBay gallery duration</li> <li>105 = eBay transmit MPR</li> <li>106 = eBay counter type</li> <li>107 = eBay condition ID</li> <li>108 = eBay condition description</li> <li>109 = eBay best offer</li> <li>110 = eBay best offer decline price</li> <li>111 = eBay best offer accept price</li> <li>112 = eBay is eBay Plus</li> <li>113 = eBay is click & Collect</li> <li>114 = eBay use EPS</li> <li>116 = eBay repair score</li> <li>200 = Hood show on shop startpage</li> <li>201 = Hood shipping discount</li> <li>202 = Hood delivery days on stock from</li> <li>203 = Hood delivery days on stock to</li> <li>204 = Hood delivery days not on stock from</li> <li>205 = Hood delivery days not on stock to</li> <li>300 = Ricardo warranty ID</li> <li>301 = Ricardo delivery ID</li> <li>302 = Ricardo availability ID</li> <li>303 = Ricardo delivery cost</li> <li>304 = Ricardo payment ID</li> <li>305 = Ricardo price increment</li> <li>306 = Ricardo item condition ID</li> <li>307 = Ricardo max relist count</li> <li>308 = Ricardo is cumulative shipping</li> <li>309 = Ricardo delivery package size ID</li> <li>310 = Ricardo use secondary language</li> <li>311 = Ricardo template ID</li> <li>312 = Ricardo is relist sold out</li> </ul>
value	string	The value of the listing market property. The value depends on the type.
createdAt		The date that the property was created.
updatedAt		The date that the property was updated last.
listingMarket	`ListingMarket`	The listing market that the property belongs to.

Methods

public toArray()

Returns this model as an array.

Properties
Name	Type	Description
id	int	The ID of the listing market directory.
name	string	The name of the listing market directory.
parentId	int	The parent ID of the listing market directory.
level	int	The level of the directory.

History

Contracts

ListingMarketHistoryRepositoryContract

The ListingMarketHistoryRepositoryContract is the interface for the listing market history repository. This interface allows you to get a single listing market history or to list several listing market histories.

Namespace

Plenty\Modules\Listing\Market\History\Contracts

Methods

public get($id, $with = []):Plenty\Modules\Listing\Market\History\Models\ListingMarketHistory

Return type: `ListingMarketHistory`

Get a listing market.

**Parameters**
Name	Type	Description
`$id`	int	The ID of the listing market.
`$with`	array	The relations to load in the ListingMarket instance, one of "listing", "prices", "dates", "properties", "texts".

public search($page = 1, $itemsPerPage = 50, $with = [], $filters = [], $sort = &quot;&quot;):Plenty\Repositories\Models\PaginatedResult

Return type: `PaginatedResult`

List listing market histories

**Parameters**
Name	Type	Description
`$page`	int	The page to get. The default page that will be returned is page 1.
`$itemsPerPage`	int	The number of entries to be displayed per page. The default number of entries per page is 50.
`$with`	array	The relations to load in the ListingMarketHistory instance, one of "listingMarket", "dates", "properties", "texts".
`$filters`	array	The filters that should be applied. The filters that are available: 'listingMarketId', 'variationId', 'allVariations', 'referrerId', 'credentialsId', 'verified', 'duration', 'listingId', 'itemId', 'listingTypeId', 'stockDependenceTypeId', 'status', 'stockCondition', 'updatedAtFrom', 'updatedAtTo , 'textData', 'firstPlatformCategoryId', 'secondPlatformCategoryId', 'firstShopCategoryId', 'secondShopCategoryId', 'thirdShopCategoryId', 'shippingProfileId', 'lastSale', 'isEbayPlus', 'isClickAndCollect'.
`$sort`	string	The sorting key that can be applied. These sortings are available: 'endTimeAsc', 'endTimeDesc', 'startTimeAsc', 'startTimeDesc', 'externalListingIdAsc', 'externalListingIdDesc'

public end($ids, $params = []):array

End the listing market histories on the designated markets.

**Parameters**
Name	Type	Description
`$ids`	array	The IDs of the listing market histories that need to be started.
`$params`	array	The parameters that should be considers during end. Available values are 'deleteOnSuccess'

public relist($ids):void

Relist the listing market histories on the designated markets.

**Parameters**
Name	Type	Description
`$ids`	array	The IDs of the listing market histories that need to be started.

public update($ids, $options = []):array

Update the listing market histories on the designated markets.

**Parameters**
Name	Type	Description
`$ids`	array	The IDs of the listing market histories that need to be updated.
`$options`	array	The update options that should be considers during update. Available values are: <ul> <li>title - Updates the title <li>subtitle - Updates the subtitle</li></li> <li>itemSpecifics - Updates the item specifics</li> <li>category - Updates the platform and shop category</li> <li>productListingDetails - Updates the product data for the listing</li> <li>listingEnhancements - Updates the enhancements information</li> <li>duration - Updates the duration</li> <li>shipping - Updates the shipping information</li> <li>description - Updates the description</li> <li>pictures - Updates the entry pictures</li> <li>quantityPriceAndVariations - Updates the quantity and price (also for variations)</li> <li>resetVariations - Reset the variations. The variation from the item are transmitted again</li> <li>partsFitment - Updates the parts fitment information (only available for eBay)</li> <li>loyaltyProgram - Updates the listing loyalty program information (only available for eBay Plus) </li> <li>resetRrp - Reset the recommended retail price information</li> <li>payment - Updates payment information (only available for Hood)</li> </ul>

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

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

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

ListingMarketHistory

The listing market history model.

Namespace

Plenty\Modules\Listing\Market\History\Models

Properties
Name	Type	Description
id	int	The listing market history ID.
listingMarketId	int	The listing market ID of the current listing market history.
referrerId	int	The referrer ID.
externalId	string	The external ID of the listing market history.
statusId	int	The status ID of the current listing market history. The following properties are available: <ul> <li>1 = Active</li> <li>2 = Ended</li> <li>3 = Relisted</li> <li>4 = Hidden</li> </ul>
quantity	int	The quantity available for sale on the marketplace.
quantitySold	int	The quantity sold currently on the marketplace.
quantitySoldDelta	int	The difference between the sold quantity and orders imported for this listing market history.
quantityRemain	int	The quantity remaining on the marketplace.
price	float	The price offered for this listing market. @see ListingMarketHistoryVariation if the listing market history contains variations.
currency	string	The currency for the price of this listing market.
sku	string	The stock keeping unit of this listing market history.
createdAt		The date that the entry was created.
updatedAt		The date that the entry was updated last.
hasStockReservationForEbay	bool	The flag which indicates if we have an active stock reservations for this listing
listingMarket	`ListingMarket`	The listing market that the listing market history belongs to.
variations		The listing market history variations that belong to this listing market history.
properties		The listing market history properties of the listing market.
dates		The listing market history dates of the listing market history.
texts		The listing market history texts of the listing market history.
status		The listing market history status of the listing market history.

Methods

public toArray()

Returns this model as an array.

ListingMarketHistoryDate

The listing market history dates model. Each listing market history date has a type.

Namespace

Plenty\Modules\Listing\Market\History\Models

Properties
Name	Type	Description
id	int	The ID of the listing market history date.
historyId	int	The ID of the listing market history that the date belongs to.
typeId	int	The ID of the listing date type. The following types are available: <ul> <li>Last price update = 1</li> <li>Last listing attempt = 2</li> <li>Start time = 3</li> <li>End time = 4</li> <li>Last market update = 5</li> <li>Last sale = 6</li> </ul>
date	`Carbon`	The date plus hours, minutes and seconds. The date format must comply with the W3C standard.
createdAt		The date that the date was created.
updatedAt		The date that the date was last updated.
listingMarket	`ListingMarket`	The listing market that the date belongs to.

Methods

public toArray()

Returns this model as an array.

ListingMarketHistoryProperty

The listing market properties model. Each listing market property has a type.

Namespace

Plenty\Modules\Listing\Market\History\Models

Properties
Name	Type	Description
id	int	The ID of the listing market history property
historyId	int	The ID of the listing market history that the property belongs to
typeId	int	The ID of the listing market history property type. The following types are available: <ul> <li>Relisted external ID = 13</li> <li>SCO Offer = 14</li> <li>Promotion = 15</li> <li>Unique user ID = 16</li> <li>Update error = 17</li> <li>Has variations = 18</li> <li>End now = 19</li> <li>Insert by type = 20</li> <li>Is eBayPlus = 117</li> <li>Is click & collect = 118</li> </ul>
value	string	The value of the listing market history property. The value depends on the type.
createdAt		The date that the property was created.
updatedAt		The date that the property was updated last.
history	`ListingMarketHistory`	The listing market history that the property belongs to.

Methods

public toArray()

Returns this model as an array.

ListingMarketHistoryText

The listing market history text model.

Namespace

Plenty\Modules\Listing\Market\History\Models

Properties
Name	Type	Description
id	int	The ID of the listing market history text.
historyId	int	The ID of the listing market history the text belongs to.
lang	string	The language of the listing market text. Available values: 'de', 'en', 'fr', 'it', 'es', 'tr', 'nl', 'pl', 'nn', 'da', 'se', 'cz', 'ru', 'sk', 'cn', 'vn', 'pt', 'bg', 'ro'.
title	string	The title of the listing market text.

Methods

public toArray()

Returns this model as an array.

ListingMarketHistoryVariation

The listing market history model.

Namespace

Plenty\Modules\Listing\Market\History\Models

Properties
Name	Type	Description
id	int	The listing market history variation ID.
historyId	int	The listing market history ID of the current listing market history variation.
variationId	int	The variation ID.
attributeName	string	The attribute name. This is an serialized array of the attribute-value data.
sku	string	The stock keeping unit of this listing market history variation.
quantity	int	The quantity available for sale on the marketplace.
quantitySold	int	The quantity sold currently on the marketplace.
quantitySoldDelta	int	The difference between the sold quantity and orders imported for this listing market history variation.
quantityRemain	int	The quantity remaining on the marketplace.
price	float	The price offered for this listing market history variation.
createdAt		The date that the entry was created.
updatedAt		The date that the entry was updated last.
history	`ListingMarketHistory`	The listing market history variations that belong to this listing market history.

Methods

public toArray()

Returns this model as an array.

Info

Contracts

ListingMarketInfoRepositoryContract

The ListingMarketInfoRepositoryContract is the interface for the listing market info repository. This interface allows you to get information about one or many listing markets.

Namespace

Plenty\Modules\Listing\Market\Info\Contracts

Methods

public search($page = 1, $itemsPerPage = 50, $with = [], $filters = []):Plenty\Repositories\Models\PaginatedResult

Return type: `PaginatedResult`

List listing market infos by filter options

**Parameters**
Name	Type	Description
`$page`	int	The page to get. The default page that will be returned is page 1.
`$itemsPerPage`	int	The number of entries to be displayed per page. The default number of entries per page is 50.
`$with`	array	The relations to load in the ListingMarketInfo instance.
`$filters`	array	The filters that should be applied. The filters that could be applied: 'id', 'listingMarketId', 'type', 'createdAtFrom', 'createdAtTo', 'code'.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

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

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

ListingMarketInfo

The listing market info model.

Namespace

Plenty\Modules\Listing\Market\Info\Models

Properties
Name	Type	Description
id	int	The listing market info ID.
listingMarketId	int	The listing market ID that the current information belongs to.
type	string	The information type. Possible values: 'warning', 'error', 'info'.
code	int	The information code.
message	string	The information message.
createdAt		The date that the listing market info was created.
listingMarket	`ListingMarket`	The listing market that the listing market info belongs to.

Methods

public toArray()

Returns this model as an array.

ItemSpecific

Contracts

ListingMarketItemSpecificRepositoryContract

The contract of the listing market item specific repository

Namespace

Plenty\Modules\Listing\Market\ItemSpecific\Contracts

Repository can be extended!

It is possible to extend this repository with own search criteria.

Methods

public get($id):Plenty\Modules\Listing\Market\ItemSpecific\Models\ListingMarketItemSpecific

Return type: `ListingMarketItemSpecific`

Gets a ListingMarketItemSpecific.

**Parameters**
Name	Type	Description
`$id`	int

public search($data, $page = 1, $itemsPerPage = 50):Plenty\Modules\Listing\Market\ItemSpecific\Models\ListingMarketItemSpecific

Return type: `ListingMarketItemSpecific`

Gets all ListingMarketItemSpecifics.

**Parameters**
Name	Type	Description
`$data`	array
`$page`	int
`$itemsPerPage`	int

public find($filters = [], $page = 1, $itemsPerPage = 50):Plenty\Repositories\Models\PaginatedResult

Return type: `PaginatedResult`

Gets all ListingMarketItemSpecifics.

**Parameters**
Name	Type	Description
`$filters`	array
`$page`	int
`$itemsPerPage`	int

public update($id, $data):Plenty\Modules\Listing\Market\ItemSpecific\Models\ListingMarketItemSpecific

Return type: `ListingMarketItemSpecific`

Updates a ListingMarketItemSpecific.

**Parameters**
Name	Type	Description
`$id`	int
`$data`	array

public delete($id):bool

Deletes a ListingMarketItemSpecific.

**Parameters**
Name	Type	Description
`$id`	int

public deleteByListingMarketId($listingMarketId):bool

Deletes all ListingMarketItemSpecific entries by listing market id.

**Parameters**
Name	Type	Description
`$listingMarketId`	int

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

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

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

ListingMarketItemSpecific

The item specific model.

Namespace

Plenty\Modules\Listing\Market\ItemSpecific\Models

Properties
Name	Type	Description
id	int	The ID of the item specific.
listingMarketId	int	The LMID which belongs to the item specific ID.
name	string	The name of the item specific.
value	string	The value of the item specific.

Methods

public toArray()

Returns this model as an array.

Text

Contracts

ListingMarketTextRepositoryContract

The contract for the listing market text repository.

Namespace

Plenty\Modules\Listing\Market\Text\Contracts

Methods

public get($id):Plenty\Modules\Listing\Market\Text\Models\ListingMarketText

Return type: `ListingMarketText`

Get a listing market text

**Parameters**
Name	Type	Description
`$id`	int	The ID of the listing market text.

public create($listingMarketId, $data):Plenty\Modules\Listing\Market\Text\Models\ListingMarketText

Return type: `ListingMarketText`

Create new listing market text

**Parameters**
Name	Type	Description
`$listingMarketId`	int	The listing market ID the new market listing text belongs to.
`$data`	array	The listing market text data as associative array.

public update($listingMarketId, $lang, $data):Plenty\Modules\Listing\Market\Text\Models\ListingMarketText

Return type: `ListingMarketText`

Update listing market text

**Parameters**
Name	Type	Description
`$listingMarketId`	int	The listing market ID the new listing market text belongs to.
`$lang`	string	The language that should be updated.
`$data`	array	The listing market text data as associative array.

public updateOrCreate($listingMarketId, $lang, $data):Plenty\Modules\Listing\Market\Text\Models\ListingMarketText

Return type: `ListingMarketText`

Update or create listing market text

**Parameters**
Name	Type	Description
`$listingMarketId`	int	The listing market ID the new listing market text belongs to.
`$lang`	string	The language that should be updated.
`$data`	array	The listing market text data as associative array.

public delete($id):bool

Delete listing market text

**Parameters**
Name	Type	Description
`$id`	int	The ID of the listing market text.

public search($page = 1, $itemsPerPage = 50, $filters = []):Plenty\Repositories\Models\PaginatedResult

Return type: `PaginatedResult`

List listing market text

**Parameters**
Name	Type	Description
`$page`	int	The default page that will be returned is page 1.
`$itemsPerPage`	int	The number of entries to be displayed per page. The default number of entries per page is 50.
`$filters`	array	The filters that should be applied: 'id', 'language', 'contains'

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

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

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

ListingMarketText

The listing market text model.

Namespace

Plenty\Modules\Listing\Market\Text\Models

Properties
Name	Type	Description
id	int	The ID of the listing market text.
listingMarketId	int	The ID of the listing market the text belongs to.
lang	string	The language of the listing market text. Available values: 'de', 'en', 'fr', 'it', 'es', 'tr', 'nl', 'pl', 'nn', 'da', 'se', 'cz', 'ru', 'sk', 'cn', 'vn', 'pt', 'bg', 'ro'.
title	string	The title of the listing market text.
subtitle	string	The subtitle of the listing market text.
description	string	The description of the listing market text.

Methods

public toArray()

Returns this model as an array.

OptionTemplate

Contracts

OptionTemplateRepositoryContract

The contract for the listing option template repository.

Namespace

Plenty\Modules\Listing\OptionTemplate\Contracts

Methods

public preview():array

Get a preview list of all listing option templates

public get($id):Plenty\Modules\Listing\OptionTemplate\Models\OptionTemplate

Return type: `OptionTemplate`

Get option template

**Parameters**
Name	Type	Description
`$id`	int	The ID of the option template.

public create($data):Plenty\Modules\Listing\OptionTemplate\Models\OptionTemplate

Return type: `OptionTemplate`

Create option template

**Parameters**
Name	Type	Description
`$data`	array	The option template data as associative array.

public update($id, $data):void

Update option template

**Parameters**
Name	Type	Description
`$id`	int	The ID of the option template.
`$data`	array	The option template data as associative array.

public delete($id):void

Delete option template

**Parameters**
Name	Type	Description
`$id`	int	The ID of the option template.

Models

OptionTemplate

The option template model.

Namespace

Plenty\Modules\Listing\OptionTemplate\Models

Properties
Name	Type	Description
id	int	The ID of the option template.
name	string	The name of the option template.
listing	array	The listing options of the option template.
listingMarket	array	The listing market options of the option template.
marketOptions	array	The market options of the option template.

Methods

public toArray()

Returns this model as an array.

Price

Models

ListingPriceType

The listing price type model.

Namespace

Plenty\Modules\Listing\Price\Models

Properties
Name	Type	Description
id	int	The ID of the listing price type. The following date types are available: <ul> <li>1 = Start price</li> <li>2 = Fixed price</li> <li>3 = Reserved price</li> <li>4 = SCO minimum price</li> <li>5 = Market fee</li> </ul>
isErasable	bool	Flag that states if this type can be deleted or not.
names		The listing price type names.

Methods

public toArray()

Returns this model as an array.

ListingPriceTypeName

The listing price type name model.

Namespace

Plenty\Modules\Listing\Price\Models

Properties
Name	Type	Description
id	int	The ID of the listing price type name.
typeId	int	The ID of the listing price type.
name	int	The name of the listing price type.
lang	int	The language of the listing price type name.

Methods

public toArray()

Returns this model as an array.

Property

Models

ListingPropertyType

The listing properties model. Each listing property has a type.

Namespace

Plenty\Modules\Listing\Property\Models

Properties
Name	Type	Description
id	int	The ID of the listing property. The following types are available: <ul> <li>1 = Shipping profile ID</li> <li>2 = Order status</li> <li>3 = Layout template ID</li> <li>4 = Maximum number of images</li> <li>5 = Warehouse ID</li> <li>6 = Basic price in text</li> <li>7 = Vat value</li> <li>8 = Vat country ID</li> <li>9 = Main language</li> <li>10 = Use item price</li> <li>11 = Number per lot</li> <li>12 = Transmit item number type</li> <li>13 = Relisted external ID</li> <li>14 = SCO offer</li> <li>15 = Promotion</li> <li>16 = UUID</li> <li>17 = Update error</li> <li>18 = Has variations</li> <li>19 = End now</li> <li>20 = Insert by type</li> <li>21 = Payment methods</li> <li>22 = First platform category ID</li> <li>23 = Second platform category ID</li> <li>24 = First shop category ID</li> <li>25 = Second shop category ID</li> <li>26 = Third shop category ID</li> <li>27 = Enhancements</li> <li>100 = eBay parts fitment ID</li> <li>101 = eBay maximum online listings</li> <li>102 = eBay private auction</li> <li>103 = eBay gallery type</li> <li>104 = eBay gallery duration</li> <li>105 = eBay transmit MPR</li> <li>106 = eBay counter type</li> <li>107 = eBay condition ID</li> <li>108 = eBay condition description</li> <li>109 = eBay best offer</li> <li>110 = eBay best offer decline price</li> <li>111 = eBay best offer accept price</li> <li>112 = eBay is eBay Plus</li> <li>113 = eBay is click & Collect</li> <li>114 = eBay use EPS</li> <li>115 = eBay best offer type</li> <li>200 = Hood show on shop startpage</li> <li>201 = Hood shipping discount</li> <li>202 = Hood delivery days on stock from</li> <li>203 = Hood delivery days on stock to</li> <li>204 = Hood delivery days not on stock from</li> <li>205 = Hood delivery days not on stock to</li> <li>300 = Ricardo warranty ID</li> <li>301 = Ricardo delivery ID</li> <li>302 = Ricardo availability ID</li> <li>303 = Ricardo delivery cost</li> <li>304 = Ricardo payment ID</li> <li>305 = Ricardo price increment</li> <li>306 = Ricardo item condition ID</li> <li>307 = Ricardo max relist count</li> <li>308 = Ricardo is cumulative shipping</li> <li>309 = Ricardo delivery package size ID</li> <li>310 = Ricardo use secondary language</li> <li>311 = Ricardo template ID</li> <li>312 = Ricardo is relist sold out</li> </ul>
isErasable	bool	Flag that indicates if this type can be deleted or not.

Methods

public toArray()

Returns this model as an array.

ListingPropertyTypeName

The listing property type name model.

Namespace

Plenty\Modules\Listing\Property\Models

Properties
Name	Type	Description
id	int	The ID of the listing property type name.
typeId	int	The ID of the listing property type.
name	int	The name of the listing property type.
lang	int	The language of the listing property type name.

Methods

public toArray()

Returns this model as an array.

ShippingProfile

Contracts

ShippingProfileRepositoryContract

The ShippingProfileRepositoryContract is the interface for the listing shipping profile repository. This interface allows you to get a shipping profile.

Namespace

Plenty\Modules\Listing\ShippingProfile\Contracts

Methods

public get($id, $with = []):Plenty\Modules\Listing\ShippingProfile\Models\ShippingProfile

Return type: `ShippingProfile`

Get a shipping profile

**Parameters**
Name	Type	Description
`$id`	int	The ID of the shipping profile.
`$with`	array	The relations to load in the ShippingProfile instance.

public search($page = 1, $itemsPerPage = 50, $with = [], $filters = []):Plenty\Repositories\Models\PaginatedResult

Return type: `PaginatedResult`

Search shipping profiles

**Parameters**
Name	Type	Description
`$page`	int	The page to get. The default page that will be returned is page 1.
`$itemsPerPage`	int	The number of entries to be displayed per page. The default number of entries per page is 50.
`$with`	array	The relations to load in the ShippingProfile instance.
`$filters`	array	The filters that should be applied. The filters that could be applied: 'id', 'referrerId', 'credentialsId'.

public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

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

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Events

ShippingProfileCreated

An event class fired after a new listing shipping profile is created.

Namespace

Plenty\Modules\Listing\ShippingProfile\Events

Methods

public __construct($shippingProfile):void

**Parameters**
Name	Type	Description
`$shippingProfile`	`ShippingProfile`

public getShippingProfile():Plenty\Modules\Listing\ShippingProfile\Models\ShippingProfile

Return type: `ShippingProfile`

Get the ShippingProfile instance.

ShippingProfileDeleted

An event class fired after a listing shipping profile is deleted.

Namespace

Plenty\Modules\Listing\ShippingProfile\Events

Methods

public __construct($shippingProfile):void

**Parameters**
Name	Type	Description
`$shippingProfile`	`ShippingProfile`

public getShippingProfile():Plenty\Modules\Listing\ShippingProfile\Models\ShippingProfile

Return type: `ShippingProfile`

Get the ShippingProfile instance.

ShippingProfileEvent

A base event class for all listing shipping profile events. Each shipping profile event expects an ShippingProfile instance.

Namespace

Plenty\Modules\Listing\ShippingProfile\Events

Methods

public __construct($shippingProfile):void

**Parameters**
Name	Type	Description
`$shippingProfile`	`ShippingProfile`

public getShippingProfile():Plenty\Modules\Listing\ShippingProfile\Models\ShippingProfile

Return type: `ShippingProfile`

Get the ShippingProfile instance.

ShippingProfileUpdated

An event class fired after a listing shipping profile is updated.

Namespace

Plenty\Modules\Listing\ShippingProfile\Events

Methods

public __construct($shippingProfile):void

**Parameters**
Name	Type	Description
`$shippingProfile`	`ShippingProfile`

public getShippingProfile():Plenty\Modules\Listing\ShippingProfile\Models\ShippingProfile

Return type: `ShippingProfile`

Get the ShippingProfile instance.

Models

ShippingProfile

The listing shipping profile model.

Namespace

Plenty\Modules\Listing\ShippingProfile\Models

Properties
Name	Type	Description
id	int	The listing shipping profile ID.
name	string	The listing shipping profile name.
credentialsId	int	The credentials ID that this listing shipping profile belongs to.
referrerId	int	The referrer ID.
createdBy	string	Who created the shipping profile. Possible values: 'migration','customer','external'.
isDefault	bool	Tells if the current listing shipping profile is set as default.
extendedData	array	Extended data that defines the current shipping profile.

Methods

public toArray()

Returns this model as an array.

Status

Models

ListingStatus

The listing status model.

Namespace

Plenty\Modules\Listing\Status\Models

Properties
Name	Type	Description
id	int	The ID of the listing status.
isErasable	int	Flag that indicates if the status can be deleted.
position	int	The position for sorting.
names		The listing status names.

Methods

public toArray()

Returns this model as an array.

ListingStatusName

The listing status name model.

Namespace

Plenty\Modules\Listing\Status\Models

Properties
Name	Type	Description
id	int	The ID of the listing status name.
statusId	int	The ID of the listing status.
name	string	The name of the listing status.
lang	string	The language of the listing status name.

Methods

public toArray()

Returns this model as an array.

StockDependenceType

Contracts

StockDependenceTypeRepositoryContract

The contract for the listing stock dependence type repository.

Namespace

Plenty\Modules\Listing\StockDependenceType\Contracts

Methods

public get($id, $with = []):Plenty\Modules\Listing\StockDependenceType\Models\StockDependenceType

Return type: `StockDependenceType`

Get a listing stock dependence type

**Parameters**
Name	Type	Description
`$id`	int	The ID of the listing stock dependence type.
`$with`	array	The relations to load in the StockDependenceType instance, available values are: "names".

public all($page = 1, $itemsPerPage = 50, $with = []):Plenty\Repositories\Models\PaginatedResult

Return type: `PaginatedResult`

List listing stock dependence types

**Parameters**
Name	Type	Description
`$page`	int	The default page that will be returned is page 1.
`$itemsPerPage`	int	The number of entries to be displayed per page. The default number of entries per page is 50.
`$with`	array	The relations to load in the ListingMarket instance. The relations available are 'names'.

Models

StockDependenceType

The listing stock dependence type model.

Namespace

Plenty\Modules\Listing\StockDependenceType\Models

Properties
Name	Type	Description
id	int	The ID of the listing stock dependence type.
isErasable	int	Flag that indicates if the type can be deleted.
position	int	The position for sorting.
names		The listing stock dependence type names.

Methods

public toArray()

Returns this model as an array.

StockDependenceTypeName

The listing stock dependence type name model.

Namespace

Plenty\Modules\Listing\StockDependenceType\Models

Properties
Name	Type	Description
id	int	The ID of the listing stock dependence type name.
typeId	int	The ID of the listing stock type.
name	string	The name of the listing stock dependence type.
lang	string	The language of the listing stock dependence type name.

Methods

public toArray()

Returns this model as an array.

Type

Contracts

ListingTypeRepositoryContract

The contract for the listing type repository.

Namespace

Plenty\Modules\Listing\Type\Contracts

Methods

public get($id, $with = []):Plenty\Modules\Listing\Type\Models\ListingType

Return type: `ListingType`

Get a listing type

**Parameters**
Name	Type	Description
`$id`	int	The ID of the listing type.
`$with`	array	The relations to load in the type instance, available values are: "names".

public all($page = 1, $itemsPerPage = 50, $with = []):Plenty\Repositories\Models\PaginatedResult

Return type: `PaginatedResult`

List listing types

**Parameters**
Name	Type	Description
`$page`	int	The default page that will be returned is page 1.
`$itemsPerPage`	int	The number of entries to be displayed per page. The default number of entries per page is 50.
`$with`	array	The relations to load in the ListingMarket instance. The relations available are 'names'.

Models

ListingType

The listing type model.

Namespace

Plenty\Modules\Listing\Type\Models

Properties
Name	Type	Description
id	int	The ID of the listing type.
isErasable	int	Flag that indicates if the type can be deleted.
position	int	The position for sorting.
names		The listing type names.

Methods

public toArray()

Returns this model as an array.

ListingTypeName

The listing type name model.

Namespace

Plenty\Modules\Listing\Type\Models

Properties
Name	Type	Description
id	int	The ID of the listing type name.
typeId	int	The ID of the listing type.
name	string	The name of the listing type.
lang	string	The language of the listing type name.

Methods

public toArray()

Returns this model as an array.

Plentymarkets interface documentation

Listing

Contracts

ListingRepositoryContract

Namespace

Methods

Return type: Listing

Return type: PaginatedResult

Return type: Listing

Return type: Listing

Models

Listing

Namespace

Methods

ListingProperty

Namespace

Methods

Date

Models

ListingDateType

Namespace

Methods

ListingDateTypeName

Namespace

Methods

LayoutTemplate

Contracts

LayoutTemplateRepositoryContract

Namespace

Methods

Return type: LayoutTemplate

Return type: LayoutTemplate

Models

LayoutTemplate

Namespace

Methods

Market

Contracts

ListingMarketRepositoryContract

Namespace

Methods

Return type: ListingMarket

Return type: PaginatedResult

Return type: PaginatedResult

Return type: ListingMarket

Events

ListingMarketBatchCreated

Namespace

Methods

ListingMarketBatchDeleted

Namespace

Methods

ListingMarketBatchEvent

Namespace

Methods

ListingMarketBatchUpdated

Namespace

Methods

ListingMarketCreated

Namespace

Methods

Return type: ListingMarket

ListingMarketDeleted

Namespace

Methods

Return type: ListingMarket

ListingMarketEvent

Namespace

Methods

Return type: ListingMarket

ListingMarketItemSpecificsCreated

Namespace

Methods

Return type: ListingMarket

ListingMarketItemSpecificsDeleted

Namespace

Methods

Return type: ListingMarket

ListingMarketUpdated

Namespace

Return type: `Listing`

Return type: `PaginatedResult`

Return type: `Listing`

Return type: `Listing`

Return type: `LayoutTemplate`

Return type: `LayoutTemplate`

Return type: `ListingMarket`

Return type: `PaginatedResult`

Return type: `PaginatedResult`

Return type: `ListingMarket`

Return type: `ListingMarket`

Return type: `ListingMarket`

Return type: `ListingMarket`

Return type: `ListingMarket`

Return type: `ListingMarket`

Return type: `ListingMarket`

Return type: `ListingMarketDirectory`

Return type: `ListingMarketDirectory`

Return type: `ListingMarketHistory`

Return type: `PaginatedResult`

Return type: `PaginatedResult`

Return type: `ListingMarketItemSpecific`

Return type: `ListingMarketItemSpecific`

Return type: `PaginatedResult`