Plentymarkets interface documentation

LiveShopping

Contracts

LiveShoppingRepositoryContract

Return information about live shopping offers.

Namespace

Plenty\Modules\LiveShopping\Contracts

Methods
public getLiveShopping($liveShoppingId):void

Get live shopping data for specific live shopping ID.

Parameters

Name

Type

Description

$liveShoppingId

int

Live shopping ID for which to retrieve data.

public getActiveByItemId($itemId):void

Get live shopping data for a specific item ID.

Parameters

Name

Type

Description

$itemId

int

Item ID for which to retrieve data.

public getActive($liveShoppingId):void

Get live shopping data for a specific live shopping ID and active status.

Parameters

Name

Type

Description

$liveShoppingId

int

Live shopping ID for which to retrieve data.

public getNextActive($liveShoppingId):void

Get the next live shopping data for a specific live shopping ID.

Parameters

Name

Type

Description

$liveShoppingId

int

Live shopping ID for which to retrieve data.

public getLastExpired($liveShoppingId):void

Get the last expired live shopping data for a specific live shopping ID.

Parameters

Name

Type

Description

$liveShoppingId

int

Live shopping ID for which to retrieve data.

public getRecentlyStartedOrExpired($time, $interval):void

Get recently started or expired live shopping data.

Parameters

Name

Type

Description

$time

int

Unix timestamp to define start time.

$interval

int

Period time in seconds used to be checked before and after start time.

public itemHasActiveLiveShopping($itemId):bool

Get an active live shopping status for specific item ID.

Parameters

Name

Type

Description

$itemId

int

Item ID for which to retrieve active status.

public increaseRealQuantity($itemId, $increase):void

Increase the real sold quantity for specific item ID.

Parameters

Name

Type

Description

$itemId

int

Item ID for which to increase real sold quantity.

$increase

float

Quantity to be increased.

Models

LiveShopping

The LiveShopping data model.

Namespace

Plenty\Modules\LiveShopping\Models

Properties
Name Type Description

id

int

Autoincremented ID

fromTime

int

Unix timestamp for the start time

toTime

int

Unix timestamp for the end time

itemId

int

Specific item ID

quantitySold

int

Declared quantity sold

quantitySoldReal

int

Defacto quantity sold

quantityMax

int

Declared maximal quantity for sale as live shopping

liveShoppingId

int

ID for a specific live shopping slot (1-10)

link

int

Link value

Methods
public toArray()

Returns this model as an array.