Plentymarkets interface documentation

PlentyMarketplace

Contracts

MarketplacePurchaseInformationContract

Get information about purchases on marketplace.

Namespace

Plenty\Modules\PlentyMarketplace\Contracts

Methods
public isPaid($pluginName):bool

Takes the Name of a plugin and returns true if the plugin has been paid for.

Parameters

Name

Type

Description

$pluginName

string

The plugin name. Must be exactly as provided in the plugin.json.

SubscriptionInformationServiceContract

Get information about plugin subscriptions. Only suitable for subscription plugins.

Namespace

Plenty\Modules\PlentyMarketplace\Contracts

Methods
public isPaid($pluginName):bool

Takes the Name of a subscription plugin and returns true if the subscription has been paid for in the current payment period on the current system.

Parameters

Name

Type

Description

$pluginName

string

The plugin name. Must be exactly as provided in the plugin.json.

 
public getSubscriptionInfo($pluginName):Plenty\Modules\PlentyMarketplace\Models\SubscriptionOrderInformation
Return type: SubscriptionOrderInformation

Takes the Name of a subscription plugin and returns information about the subscription.

Parameters

Name

Type

Description

$pluginName

string

The plugin name. Must be exactly as provided in the plugin.json.

Models

SubscriptionChildOrderInformation

Eloquent model representing a SubscriptionChildOrderInformation.

Namespace

Plenty\Modules\PlentyMarketplace\Models

Properties
Name Type Description

paymentStatus

string

paymentInformation

array
Methods
public toArray()

Returns this model as an array.

SubscriptionChildPaymentInformation

Eloquent model representing a SubscriptionChildPaymentInformation.

Namespace

Plenty\Modules\PlentyMarketplace\Models

Properties
Name Type Description

amount

float

The amount of the payment

status

int

The <a href="https://developers.plentymarkets.com/rest-doc/introduction#payment-statuses" target="_blank">status</a> of the payment

unaccountable

int

An unassigned payment. Unassigned payments have the value 1.

currency

string

The currency of the payment in ISO 4217 code.

receivedAt

string

The time the payment was received

importedAt

string

The time the payment was imported
Methods
public toArray()

Returns this model as an array.

SubscriptionOrderInformation

Eloquent model representing a SubscriptionOrderInformation.

Namespace

Plenty\Modules\PlentyMarketplace\Models

Properties
Name Type Description

isPaid

bool

intervalType

string

intervalValue

string

startDate

string

subscriptionLastRun

string

subscriptionNextRun

string

childOrders

array
Methods
public toArray()

Returns this model as an array.