Plentymarkets interface documentation

Picklist

Contracts

PickingOrderItemRepositoryContract

The PickingOrderItemRepositoryContract describes methods for fetching one or multiple picking order items.

Namespace

Plenty\Modules\Fulfillment\Picklist\Contracts

Methods
public getAll():Illuminate\Database\Eloquent\Collection
Return type: Collection
public getPickingOrderItemById($pickingOrderItemId):Plenty\Modules\Fulfillment\Picklist\Models\PickingOrderItem
Return type: PickingOrderItem
Parameters

Name

Type

Description

$pickingOrderItemId

int

Events

GetPickingItemConfig

This event will be triggered, when an item is picked

Namespace

Plenty\Modules\Fulfillment\Picklist\Events

Methods
public getPickingOrderItemId():int

Returns picking order item ID

public getProcessUserId():int

Returns process user ID

public addPluginConfig($identifier, $pluginConfig):Plenty\Modules\Fulfillment\Picklist\Events
Return type: Events

Add a plugin configuration

Parameters

Name

Type

Description

$identifier

string

$pluginConfig

public getPluginConfigs():array

Return all plugin configurations

Models

PickingOrderItem

Represent a picking order item

Namespace

Plenty\Modules\Fulfillment\Picklist\Models

Properties
Name Type Description

id

int

pickingOrderId

int

orderItemId

int

processState

string

processDate

processUserId

int

comment

string

quantity

float

itemId

int

holdingArea

int

warehouseId

int

orderIdList

string

Methods
public toArray()

Returns this model as an array.

Fulfillment

Contracts

ShippingProviderConfigFormContract

Add fields to the shipping provider config form.

Namespace

Plenty\Modules\Fulfillment\Contracts

Methods
public addDateField($dateField):void

Add a shipping provider date field to the config form

Parameters

Name

Type

Description

$dateField

DateField

public addTimeField($timeField):void

Add a shipping provider time field to the config form

Parameters

Name

Type

Description

$timeField

TimeField

public addInputField($inputField):void

Add a shipping provider input field to the config form

Parameters

Name

Type

Description

$inputField

InputField

public addCheckboxField($checkboxField):void

Add a shipping provider checkbox field to the config form

Parameters

Name

Type

Description

$checkboxField

CheckboxField

public addSelectboxField($selectboxField):void

Add a shipping provider selectbox field to the config form

Parameters

Name

Type

Description

$selectboxField

SelectboxField

public addHyperlinkField($hyperlinkField):void

Add a shipping provider hyperlink field to the config form

Parameters

Name

Type

Description

$hyperlinkField

HyperlinkField

public getConfigFields():array

Get the list with the config fields

DataModels

DSGVOContactData

The DSGVO contact data model.

Namespace

Plenty\Modules\Fulfillment\DataModels

Properties
Name Type Description

phone

string

The contact data phone

email

string

The contact data email address

Methods
public toArray()

Returns this model as an array.

VATNumberData

The VAT number data model.

Namespace

Plenty\Modules\Fulfillment\DataModels

Properties
Name Type Description

type

string

The VAT number type

value

string

The VAT number value

Methods
public toArray()

Returns this model as an array.

Services

DSGVOContactAddressDataService

The DSGVOContactAddressDataService is the service for generating contact address data according to DSGVO settings.

Namespace

Plenty\Modules\Fulfillment\Services

Methods
public static getDSGVOAddressData($addressType, $order):array
Parameters

Name

Type

Description

$addressType

int

$order

Order

FulfillmentReturnService

The FulfillmentReturnService is the service for return shipments of an order.

Namespace

Plenty\Modules\Fulfillment\Services

Methods
public registerReturns($orderId):bool

Register the return of an order.

Parameters

Name

Type

Description

$orderId

int

The ID of the order

public registerReturn($orderId, $returnProvider):bool

Register the return of an order

Parameters

Name

Type

Description

$orderId

int

$returnProvider

string

FulfillmentShipmentService

The FulfillmentShipmentService is the service for registering and cancelling shipments of an order.

Namespace

Plenty\Modules\Fulfillment\Services

Methods
public resetShipment($orderId):bool
Parameters

Name

Type

Description

$orderId

int

public cancelShipment($orderId):bool

Cancel the shipment of an order.

Parameters

Name

Type

Description

$orderId

int

The ID of the order

public registerShipment($orderId):bool

Register the shipment of an order.

Parameters

Name

Type

Description

$orderId

int

The ID of the order

GetDhlRetoureOnlineDataService

The GetDhlRetoureOnlineDataService is the service that retrieves old DHL Retoure Online data.

Namespace

Plenty\Modules\Fulfillment\Services

Methods
public getDhlRetoureOnlineData():void

Get all DHL Retoure Online configurations

ShippingProviderConfigFormService

The ShippingProviderConfigFormService is the service for creating the config form for a shipping provider.

Namespace

Plenty\Modules\Fulfillment\Services

Methods
public addDateField($dateField):void
Parameters

Name

Type

Description

$dateField

public addTimeField($timeField):void
Parameters

Name

Type

Description

$timeField

public addInputField($inputField):void
Parameters

Name

Type

Description

$inputField

public addCheckboxField($checkboxField):void
Parameters

Name

Type

Description

$checkboxField

public addSelectboxField($selectboxField):void
Parameters

Name

Type

Description

$selectboxField

public addHyperlinkField($hyperlinkField):void
Parameters

Name

Type

Description

$hyperlinkField

public getConfigFields():void

VATNumberService

The VATNumberService is the service for providing the correct VAT ID.

Namespace

Plenty\Modules\Fulfillment\Services

Methods
public getVATNumber($orderId):Plenty\Modules\Fulfillment\DataModels\VATNumberData
Return type: VATNumberData
Parameters

Name

Type

Description

$orderId

int

DataModels

ConfigForm

CheckboxField

The checkbox field model.

Namespace

Plenty\Modules\Fulfillment\DataModels\ConfigForm

Properties
Name Type Description

name

string

The name of the field

label

string

The label of the field

value

bool

The value of the field

type

string

The type of the field

isVisible

bool

The visibility of the form on the config form

Methods
public toArray()

Returns this model as an array.

DateField

The date field model.

Namespace

Plenty\Modules\Fulfillment\DataModels\ConfigForm

Properties
Name Type Description

name

string

The name of the field

label

string

The label of the field

value

The value of the field

type

string

The type of the field

isVisible

bool

The visibility of the form on the config form

Methods
public toArray()

Returns this model as an array.

FormField

The form field model.

Namespace

Plenty\Modules\Fulfillment\DataModels\ConfigForm

Properties
Name Type Description

name

string

The name of the field

label

string

The label of the field

value

string

The value of the field

type

string

The type of the field

isVisible

bool

The visibility of the form on the config form

Methods
public toArray()

Returns this model as an array.

HyperlinkField

The hyperlink field model.

Namespace

Plenty\Modules\Fulfillment\DataModels\ConfigForm

Properties
Name Type Description

name

string

The name of the field

label

string

The label of the field

value

string

The value of the field

type

string

The type of the field

url

string

The url of the field

isVisible

bool

The visibility of the form on the config form

Methods
public toArray()

Returns this model as an array.

InputField

The input field model.

Namespace

Plenty\Modules\Fulfillment\DataModels\ConfigForm

Properties
Name Type Description

name

string

The name of the field

label

string

The label of the field

value

string

The value of the field

type

string

The type of the field

isVisible

bool

The visibility of the form on the config form

Methods
public toArray()

Returns this model as an array.

SelectboxField

The selectbox field model.

Namespace

Plenty\Modules\Fulfillment\DataModels\ConfigForm

Properties
Name Type Description

name

string

The name of the field

label

string

The label of the field

value

string

The value of the field

type

string

The type of the field

selectBoxValues

array

The selectbox values of the field

isVisible

bool

The visibility of the form on the config form

Methods
public toArray()

Returns this model as an array.

SelectboxValue

The selectbox value model.

Namespace

Plenty\Modules\Fulfillment\DataModels\ConfigForm

Properties
Name Type Description

caption

string

The name of the field

value

string

The label of the field

translateCaption

bool

The option to translate caption, default value is true

Methods
public toArray()

Returns this model as an array.

TimeField

The time field model.

Namespace

Plenty\Modules\Fulfillment\DataModels\ConfigForm

Properties
Name Type Description

name

string

The name of the field

label

string

The label of the field

value

string

The value of the field

type

string

The type of the field

isVisible

bool

The visibility of the form on the config form

Methods
public toArray()

Returns this model as an array.