Listing

Contracts

ListingRepositoryContract

The contract for the listing repository.

Namespace

Plenty\Modules\Listing\Contracts

Methods

public get(int $id, array $with = []):Listing

Get a listing by a given ID.

Parameters
int $id The ID of the listing.
array $with The relations to load in the listing instance, one of "markets", "type", "stockDependenceType", "properties".
public search(int $page = 1, int $itemsPerPage = 50, array $with = [], array $filters = []):PaginatedResult

List listing

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

Create new listing

Parameters
array $data The listing data as associative array.
public update(int $id, array $data):Listing

Update listing

Parameters
int $id The ID of the listing.
array $data The listing data as associative array.
public delete(int $id):bool

Delete listing

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

Sets the filter array.

Parameters
array $filters
public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Listing

The listing model.

Namespace

Plenty\Modules\Listing\Models

Properties

Type Name Description
int id The ID of the listing.
int itemId The ID of the item.
int typeId The ID of the listing type. Possible types are:
  • 1 = Auction
  • 2 = Fixed
  • 3 = Shop item
int stockDependenceTypeId The ID of the listing stock dependence. Possible stock dependence types are:
  • 1 = Unlimited with sync
  • 2 = Limited with reservation
  • 3 = Limited without reservation
  • 4 = Unlimited without sync
int unitCombinationId The ID of the unit combination.
properties The listing properties of the listing.
ListingType type The type of the listing.
StockDependenceType stockDependenceType The stock dependence type of the listing.
ListingMarket markets 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

Type Name Description
int id The ID of the listing property.
int listingId The ID of the listing that the property belongs to.
int typeId The ID of the listing property type. The following types are available:
  • 10 = Use item price
  • 11 = Number per lot
  • 12 = Transmit item number type
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

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

Type Name Description
int id The ID of the listing date type name.
int typeId The listing date type ID that the current name belongs to.
int name The name of the listing date type.
int lang 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(int $id, array $with = []):LayoutTemplate

Get a layout template.

Parameters
int $id The ID of the layout template.
array $with The relations to load in the LayoutTemplate instance, one of "additional".
public create(array $data):LayoutTemplate

Create a layout template.

Parameters
array $data The layout template data.
public delete(int $id):bool

Delete layout template

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

Sets the filter array.

Parameters
array $filters
public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

LayoutTemplate

The layout template model.

Namespace

Plenty\Modules\Listing\LayoutTemplate\Models

Properties

Type Name Description
int id The ID of the layout template.
string name The name of the layout template.
string css The css of the layout template.
string htmlStructure The html structure of the layout template.
string mainFrame The main frame of the layout template.
array additionalContent The additional content of the layout template.
string appendixType 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(int $id, array $with = []):ListingMarket

Get a listing market

Parameters
int $id The ID of the listing market.
array $with The relations to load in the ListingMarket instance, one of "listing", "prices", "dates", "properties", "texts", "infos".
public search(int $page = 1, int $itemsPerPage = 50, array $with = [], array $filters = []):PaginatedResult

List listing markets

Parameters
int $page The page to get. The default page that will be returned is page 1.
int $itemsPerPage The number of entries to be displayed per page. The default number of entries per page is 50.
array $with The relations to load in the ListingMarket instance, one of "listing", "prices", "dates", "properties", "texts", "infos".
array $filters 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(int $page = 1, int $itemsPerPage = 50, array $with = [], array $filters = []):PaginatedResult

Find listing markets

Parameters
int $page The page to get. The default page that will be returned is page 1.
int $itemsPerPage The number of entries to be displayed per page. The default number of entries per page is 50.
array $with The relations to load in the ListingMarket instance, one of "listing", "prices", "dates", "properties", "texts", "infos".
array $filters 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(array $data):array

Create a listing

Parameters
array $data The listing market data.
public update(int $id, array $data):ListingMarket

Update listing market

Parameters
int $id The ID of the listing market.
array $data The listing market data as associative array.
public start(array $ids, array $params = []):array

Start listing markets on the designated markets.

Parameters
array $ids The IDs of the listing markets that need to be started.
array $params The parameters that should be considered during start. Available values are 'startTime', 'startDistribution'
public verify(array $ids):array

Verifies listing markets.

Parameters
array $ids The IDs of the listing markets that need to be verified.
public delete(int $id):void

Delete a listing market

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

Sets the filter array.

Parameters
array $filters
public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Events

ListingMarketBatchCreated

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

Namespace

Plenty\Modules\Listing\Market\Events

Methods

public __construct(array $listingMarkets):void
Parameters
array $listingMarkets
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(array $listingMarkets):void
Parameters
array $listingMarkets
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(array $listingMarkets):void
Parameters
array $listingMarkets
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(array $listingMarkets):void
Parameters
array $listingMarkets
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
 $listingMarket):void
Parameters
ListingMarket $listingMarket
public getListingMarket():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
 $listingMarket):void
Parameters
ListingMarket $listingMarket
public getListingMarket():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
 $listingMarket):void
Parameters
ListingMarket $listingMarket
public getListingMarket():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
 $listingMarket):void
Parameters
ListingMarket $listingMarket
public getListingMarket():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
 $listingMarket):void
Parameters
ListingMarket $listingMarket
public getListingMarket():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
 $listingMarket):void
Parameters
ListingMarket $listingMarket
public getListingMarket():ListingMarket

Get the ListingMarket instance.

Models

ListingMarket

The listing market model.

Namespace

Plenty\Modules\Listing\Market\Models

Properties

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

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

Type Name Description
int id The ID of the listing market date.
int listingMarketId The ID of the listing market that the date belongs to.
int typeId The ID of the listing market date type. The following types are available:
  • 1 = Last price update
  • 2 = Last listing attempt
  • 3 = Start time
  • 4 = End time
  • 5 = Last market update
Carbon date 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

Type Name Description
int id The ID of the listing market item specific.
int listingMarketId The ID of the listing market.
string name 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

Type Name Description
int id The ID of the listing price.
int listingMarketId The ID of the listing market.
int typeId The ID of the listing price type.
float value The value 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

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

Directory

Contracts

ListingMarketDirectoryRepositoryContract

The contract for the listing market directory repository.

Namespace

Plenty\Modules\Listing\Market\Directory\Contracts

Methods

public get(int $id, array $with = []):ListingMarketDirectory

Get a listing market directory

Parameters
int $id The ID of the listing market directory.
array $with The relations to load in the ListingMarketDirectory instance, one of "children".
public all(array $with = [], array $filters = []):array

List all directories

Parameters
array $with The relations to load in the ListingMarketDirectory instances, one of "children".
array $filters Listing market directory filters. Available filters: parentId (if no parentId is given than top level is returned).
public create(array $data):array

Create a listing market directory.

Parameters
array $data The listing market directory data as associative array.
public update(int $id, array $data):ListingMarketDirectory

Update listing market directory

Parameters
int $id The ID of the listing market directory.
array $data The listing market directory data as associative array.
public delete(int $id):void

Delete a listing market directory

Parameters
int $id The ID of the listing market directory.
public clearCriteria():void

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

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

Sets the filter array.

Parameters
array $filters
public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

ListingMarketDirectory

The listing market directory model.

Namespace

Plenty\Modules\Listing\Market\Directory\Models

Properties

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

Methods

public toArray()

Returns this model as an array.

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(int $id, array $with = []):ListingMarketHistory

Get a listing market.

Parameters
int $id The ID of the listing market.
array $with The relations to load in the ListingMarket instance, one of "listing", "prices", "dates", "properties", "texts".
public search(int $page = 1, int $itemsPerPage = 50, array $with = [], array $filters = []):PaginatedResult

List listing market histories

Parameters
int $page The page to get. The default page that will be returned is page 1.
int $itemsPerPage The number of entries to be displayed per page. The default number of entries per page is 50.
array $with The relations to load in the ListingMarketHistory instance, one of "listingMarket", "dates", "properties", "texts".
array $filters 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'.
public end(array $ids, array $params = []):array

End the listing market histories on the designated markets.

Parameters
array $ids The IDs of the listing market histories that need to be started.
array $params The parameters that should be considers during end. Available values are 'deleteOnSuccess'
public relist(array $ids):void

Relist the listing market histories on the designated markets.

Parameters
array $ids The IDs of the listing market histories that need to be started.
public update(array $ids, array $options = []):array

Update the listing market histories on the designated markets.

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

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

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

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

Sets the filter array.

Parameters
array $filters
public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

ListingMarketHistory

The listing market history model.

Namespace

Plenty\Modules\Listing\Market\History\Models

Properties

Type Name Description
int id The listing market history ID.
int listingMarketId The listing market ID of the current listing market history.
int referrerId The referrer ID.
string externalId The external ID of the listing market history.
int statusId The status ID of the current listing market history. The following properties are available:
  • 1 = Active
  • 2 = Ended
  • 3 = Relisted
  • 4 = Hidden
int quantity The quantity available for sale on the marketplace.
int quantitySold The quantity sold currently on the marketplace.
int quantitySoldDelta The difference between the sold quantity and orders imported for this listing market history.
int quantityRemain The quantity remaining on the marketplace.
float price The price offered for this listing market. @see ListingMarketHistoryVariation if the listing market history contains variations.
string sku 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.
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

Type Name Description
int id The ID of the listing market history date.
int historyId The ID of the listing market history that the date belongs to.
int typeId The ID of the listing date type. The following types are available:
  • Start time = 3
  • End time = 4
  • Last market update = 5
  • Last sale = 6
Carbon date 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

Type Name Description
int id The ID of the listing market history property
int historyId The ID of the listing market history that the property belongs to
int typeId The ID of the listing market history property type. The following types are available:
  • Relisted external ID = 13
  • SCO Offer = 14
  • Promotion = 15
  • Unique user ID = 16
  • Update error = 17
  • Has variations = 18
  • End now = 19
  • Insert by type = 20
  • Is eBayPlus = 117
  • Is click & collect = 118
string value 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.
ListingMarketHistory history 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

Type Name Description
int id The ID of the listing market history text.
int historyId The ID of the listing market history the text belongs to.
string lang 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'.
string title 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

Type Name Description
int id The listing market history variation ID.
int historyId The listing market history ID of the current listing market history variation.
int variationId The variation ID.
string attributeName The attribute name. This is an serialized array of the attribute-value data.
string sku The stock keeping unit of this listing market history variation.
int quantity The quantity available for sale on the marketplace.
int quantitySold The quantity sold currently on the marketplace.
int quantitySoldDelta The difference between the sold quantity and orders imported for this listing market history variation.
int quantityRemain The quantity remaining on the marketplace.
float price 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.
ListingMarketHistory history 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(int $page = 1, int $itemsPerPage = 50, array $with = [], array $filters = []):PaginatedResult

List listing market infos by filter options

Parameters
int $page The page to get. The default page that will be returned is page 1.
int $itemsPerPage The number of entries to be displayed per page. The default number of entries per page is 50.
array $with The relations to load in the ListingMarketInfo instance.
array $filters 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(array $filters = []):void

Sets the filter array.

Parameters
array $filters
public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

ListingMarketInfo

The listing market info model.

Namespace

Plenty\Modules\Listing\Market\Info\Models

Properties

Type Name Description
int id The listing market info ID.
int listingMarketId The listing market ID that the current information belongs to.
string type The information type. Possible values: 'warning', 'error', 'info'.
int code The information code.
string message 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.

Text

Contracts

ListingMarketTextRepositoryContract

The contract for the listing market text repository.

Namespace

Plenty\Modules\Listing\Market\Text\Contracts

Methods

public get(int $id):ListingMarketText

Get a listing market text

Parameters
int $id The ID of the listing market text.
public create(int $listingMarketId, array $data):ListingMarketText

Create new listing market text

Parameters
int $listingMarketId The listing market ID the new market listing text belongs to.
array $data The listing market text data as associative array.
public update(int $listingMarketId, string $lang, array $data):ListingMarketText

Update listing market text

Parameters
int $listingMarketId The listing market ID the new listing market text belongs to.
string $lang The language that should be updated.
array $data The listing market text data as associative array.
public updateOrCreate(int $listingMarketId, string $lang, array $data):ListingMarketText

Update or create listing market text

Parameters
int $listingMarketId The listing market ID the new listing market text belongs to.
string $lang The language that should be updated.
array $data The listing market text data as associative array.
public delete(int $id):bool

Delete listing market text

Parameters
int $id The ID of the listing market text.
public search(int $page = 1, int $itemsPerPage = 50, array $filters = []):PaginatedResult

List listing market text

Parameters
int $page The default page that will be returned is page 1.
int $itemsPerPage The number of entries to be displayed per page. The default number of entries per page is 50.
array $filters 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(array $filters = []):void

Sets the filter array.

Parameters
array $filters
public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

ListingMarketText

The listing market text model.

Namespace

Plenty\Modules\Listing\Market\Text\Models

Properties

Type Name Description
int id The ID of the listing market text.
int listingMarketId The ID of the listing market the text belongs to.
string lang 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'.
string title The title of the listing market text.
string subtitle The subtitle of the listing market text.
string description 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(int $id):OptionTemplate

Get option template

Parameters
int $id The ID of the option template.
public create(array $data):OptionTemplate

Create option template

Parameters
array $data The option template data as associative array.
public update(int $id, array $data):void

Update option template

Parameters
int $id The ID of the option template.
array $data The option template data as associative array.
public delete(int $id):void

Delete option template

Parameters
int $id The ID of the option template.

Models

OptionTemplate

The option template model.

Namespace

Plenty\Modules\Listing\OptionTemplate\Models

Properties

Type Name Description
int id The ID of the option template.
string name The name of the option template.
array listing The listing options of the option template.
array listingMarket The listing market options of the option template.
array marketOptions 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

Type Name Description
int id The ID of the listing price type. The following date types are available:
  • 1 = Start price
  • 2 = Fixed price
  • 3 = Reserved price
  • 4 = SCO minimum price
  • 5 = Market fee
bool isErasable 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

Type Name Description
int id The ID of the listing price type name.
int typeId The ID of the listing price type.
int name The name of the listing price type.
int lang 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

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

Type Name Description
int id The ID of the listing property type name.
int typeId The ID of the listing property type.
int name The name of the listing property type.
int lang 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(int $id, array $with = []):ShippingProfile

Get a shipping profile

Parameters
int $id The ID of the shipping profile.
array $with The relations to load in the ShippingProfile instance.
public search(int $page = 1, int $itemsPerPage = 50, array $with = [], array $filters = []):PaginatedResult

Search shipping profiles

Parameters
int $page The page to get. The default page that will be returned is page 1.
int $itemsPerPage The number of entries to be displayed per page. The default number of entries per page is 50.
array $with The relations to load in the ShippingProfile instance.
array $filters 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(array $filters = []):void

Sets the filter array.

Parameters
array $filters
public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Events

ShippingProfileCreated

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

Namespace

Plenty\Modules\Listing\ShippingProfile\Events

Methods

public __construct(ShippingProfile
 $shippingProfile):void
Parameters
ShippingProfile $shippingProfile
public getShippingProfile():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
 $shippingProfile):void
Parameters
ShippingProfile $shippingProfile
public getShippingProfile():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
 $shippingProfile):void
Parameters
ShippingProfile $shippingProfile
public getShippingProfile():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
 $shippingProfile):void
Parameters
ShippingProfile $shippingProfile
public getShippingProfile():ShippingProfile

Get the ShippingProfile instance.

Models

ShippingProfile

The listing shipping profile model.

Namespace

Plenty\Modules\Listing\ShippingProfile\Models

Properties

Type Name Description
int id The listing shipping profile ID.
string name The listing shipping profile name.
int credentialsId The credentials ID that this listing shipping profile belongs to.
int referrerId The referrer ID.
string createdBy Who created the shipping profile. Possible values: 'migration','customer','external'.
bool isDefault Tells if the current listing shipping profile is set as default.
array extendedData 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

Type Name Description
int id The ID of the listing status.
int isErasable Flag that indicates if the status can be deleted.
int position 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

Type Name Description
int id The ID of the listing status name.
int statusId The ID of the listing status.
string name The name of the listing status.
string lang 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(int $id, array $with = []):StockDependenceType

Get a listing stock dependence type

Parameters
int $id The ID of the listing stock dependence type.
array $with The relations to load in the StockDependenceType instance, available values are: "names".
public all(int $page = 1, int $itemsPerPage = 50, array $with = []):PaginatedResult

List listing stock dependence types

Parameters
int $page The default page that will be returned is page 1.
int $itemsPerPage The number of entries to be displayed per page. The default number of entries per page is 50.
array $with 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

Type Name Description
int id The ID of the listing stock dependence type.
int isErasable Flag that indicates if the type can be deleted.
int position 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

Type Name Description
int id The ID of the listing stock dependence type name.
int typeId The ID of the listing stock type.
string name The name of the listing stock dependence type.
string lang 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(int $id, array $with = []):ListingType

Get a listing type

Parameters
int $id The ID of the listing type.
array $with The relations to load in the type instance, available values are: "names".
public all(int $page = 1, int $itemsPerPage = 50, array $with = []):PaginatedResult

List listing types

Parameters
int $page The default page that will be returned is page 1.
int $itemsPerPage The number of entries to be displayed per page. The default number of entries per page is 50.
array $with 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

Type Name Description
int id The ID of the listing type.
int isErasable Flag that indicates if the type can be deleted.
int position 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

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

Methods

public toArray()

Returns this model as an array.