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

Services

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