Picklist

Contracts

PickingOrderItemRepositoryContract

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

Namespace

Plenty\Modules\Fulfillment\Picklist\Contracts

Methods

public getAll():Collection
public getPickingOrderItemById(int $pickingOrderItemId):PickingOrderItem
Parameters
int $pickingOrderItemId

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(string $identifier, $pluginConfig):Events

Add a plugin configuration

Parameters
string $identifier
$pluginConfig
public getPluginConfigs():array

Return all plugin configurations

Models

PickingOrderItem

Represent a picking order item

Namespace

Plenty\Modules\Fulfillment\Picklist\Models

Properties

Type Name Description
int id
int pickingOrderId
int orderItemId
string processState
processDate
int processUserId
string comment
float quantity
int itemId
int holdingArea
int warehouseId
string orderIdList

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(int $orderId):bool

Register the return of an order.

Parameters
int $orderId The ID of the order
public registerReturn(int $orderId, string $returnProvider):bool

Register the return of an order

Parameters
int $orderId
string $returnProvider

FulfillmentShipmentService

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

Namespace

Plenty\Modules\Fulfillment\Services

Methods

public cancelShipment(int $orderId):bool

Cancel the shipment of an order.

Parameters
int $orderId The ID of the order
public registerShipment(int $orderId):bool

Register the shipment of an order.

Parameters
int $orderId 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