Plentymarkets interface documentation

Warehouse

Contracts

WarehouseLocationDimensionRepositoryContract

Get, create, update and delete warehouse location dimensions

Namespace

Plenty\Modules\Warehouse\Contracts

Methods
public getWarehouseLocationDimension($warehouseLocationDimension, $with = []):Plenty\Modules\Warehouse\Models\WarehouseLocationDimension
Return type: WarehouseLocationDimension

Get a warehouse location dimension

Parameters

Name

Type

Description

$warehouseLocationDimension

int

$with

array

public listWarehouseLocationDimension($warehouseId):Plenty\Modules\Warehouse\Models\WarehouseLocationDimension
Return type: WarehouseLocationDimension

Get all warehouse location dimensions

Parameters

Name

Type

Description

$warehouseId

int

public createMultipleWarehouseLocationDimension($data):array

Create multiple warehouse location dimensions

Parameters

Name

Type

Description

$data

array

The request data

public createWarehouseLocationDimension($data):Plenty\Modules\Warehouse\Models\WarehouseLocationDimension
Return type: WarehouseLocationDimension

Create a warehouse location dimension

Parameters

Name

Type

Description

$data

array

The request data

public updateWarehouseLocationDimension($warehouseLocationDimension, $data):Plenty\Modules\Warehouse\Models\WarehouseLocationDimension
Return type: WarehouseLocationDimension

Update a warehouse location dimension

Parameters

Name

Type

Description

$warehouseLocationDimension

int

$data

array

public deleteWarehouseLocationDimension($warehouseLocationDimension):void

Delete a warehouse location dimension

Parameters

Name

Type

Description

$warehouseLocationDimension

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

WarehouseLocationInventoryRepositoryContract

Get, create, update and delete warehouse locations

Namespace

Plenty\Modules\Warehouse\Contracts

Methods
public getWarehouseLocationInventory($warehouseLocationInventory):Plenty\Modules\Warehouse\Models\WarehouseLocationInventory
Return type: WarehouseLocationInventory

Get a warehouse location inventory

Parameters

Name

Type

Description

$warehouseLocationInventory

int

public getWarehouseLocationInventoryList($page = 1, $itemsPerPage = 50, $paginate = 1, $filters = [], $warehouseLocationId = null, $with = []):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult

Get a warehouse location inventory

Parameters

Name

Type

Description

$page

int

$itemsPerPage

int

$paginate

int

$filters

array

$warehouseLocationId

int

$with

array

public createWarehouseLocationInventory($data):Plenty\Modules\Warehouse\Models\WarehouseLocationInventory
Return type: WarehouseLocationInventory

Create a warehouse location inventory

Parameters

Name

Type

Description

$data

array

The request data

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

WarehouseLocationLevelRepositoryContract

Get, create, update and delete warehouse location levels

Namespace

Plenty\Modules\Warehouse\Contracts

Methods
public getWarehouseLocationLevel($warehouseLocationLevel):Plenty\Modules\Warehouse\Models\WarehouseLocationLevel
Return type: WarehouseLocationLevel

Get a warehouse location level

Parameters

Name

Type

Description

$warehouseLocationLevel

int

public getWarehouseLocationLevelByName($warehouseLocationLevelName, $dimensionId, $parentId):Plenty\Modules\Warehouse\Models\WarehouseLocationLevel
Return type: WarehouseLocationLevel

Get a warehouse location level

Parameters

Name

Type

Description

$warehouseLocationLevelName

string

$dimensionId

int

$parentId

int

public getWarehouseLocationLevelOnlyByName($warehouseLocationLevelName):Plenty\Modules\Warehouse\Models\WarehouseLocationLevel
Return type: WarehouseLocationLevel

Get a warehouse location level only by name.

Parameters

Name

Type

Description

$warehouseLocationLevelName

string

public listWarehouseLocationLevels($filters = [], $warehouseId = null):array

Get a list of warehouse location levels

Parameters

Name

Type

Description

$filters

array

$warehouseId

int

public createWarehouseLocationLevel($data, $apiMode = false):Plenty\Modules\Warehouse\Models\WarehouseLocationLevel
Return type: WarehouseLocationLevel

Create a warehouse location level

Parameters

Name

Type

Description

$data

array

The request data

$apiMode

bool

If the location is created using a route

public updateWarehouseLocationLevel($warehouseLocationLevel, $data):Plenty\Modules\Warehouse\Models\WarehouseLocationLevel
Return type: WarehouseLocationLevel

Update a warehouse location level

Parameters

Name

Type

Description

$warehouseLocationLevel

int

$data

array

public deleteWarehouseLocationLevel($warehouseLocationLevel):void

Delete a warehouse location level

Parameters

Name

Type

Description

$warehouseLocationLevel

int

public getWarehouseStructure($warehouseId, $data = []):void

Get a warehouse structure.

Parameters

Name

Type

Description

$warehouseId

int

$data

array

public moveWarehouseLocationLevelPosition($data):void

Move a warehouse location level position

Parameters

Name

Type

Description

$data

array

The request data

public getWarehouseStructureMoving($warehouseId, $data):void

Get a warehouse structure moving.

Parameters

Name

Type

Description

$warehouseId

int

$data

array

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

WarehouseLocationRepositoryContract

Get, create, update and delete warehouse locations

Namespace

Plenty\Modules\Warehouse\Contracts

Methods
public getWarehouseLocation($warehouseLocation):Plenty\Modules\Warehouse\Models\WarehouseLocation
Return type: WarehouseLocation

Get a warehouse location

Parameters

Name

Type

Description

$warehouseLocation

int

public listWarehouseLocations($page = 1, $itemsPerPage = 50, $paginate = 1, $filters = [], $warehouseId = null, $with = []):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult

Get all warehouse locations

Parameters

Name

Type

Description

$page

int

$itemsPerPage

int

$paginate

int

$filters

array

$warehouseId

int

$with

array

public listWarehouseLocationsByLevelId($warehouseId, $levelId):void

List warehouse locations by levelId

Parameters

Name

Type

Description

$warehouseId

int

$levelId

int

public getWarehouseLocationByLabel($label):Plenty\Modules\Warehouse\Models\WarehouseLocation
Return type: WarehouseLocation

Get first warehouse location matching the given label Gets the first warehouse location matching the given label. The label must be specified.

Parameters

Name

Type

Description

$label

string

public createWarehouseLocation($data):Plenty\Modules\Warehouse\Models\WarehouseLocation
Return type: WarehouseLocation

Create a warehouse location

Parameters

Name

Type

Description

$data

array

The request data

public updateWarehouseLocation($warehouseLocation, $data):Plenty\Modules\Warehouse\Models\WarehouseLocation
Return type: WarehouseLocation

Update a warehouse location

Parameters

Name

Type

Description

$warehouseLocation

int

$data

array

public updateStorageLocations($data):void

Updates several Storage Locations in a single DB Transaction with the data provided

Parameters

Name

Type

Description

$data

public deleteWarehouseLocation($warehouseLocation):void

Delete a warehouse location

Parameters

Name

Type

Description

$warehouseLocation

int

public deleteMultipleWarehouseLocations($warehouseLocationIds):void

Delete multiple warehouse locations

Parameters

Name

Type

Description

$warehouseLocationIds

array

public executeGroupFunction($data):array

Edit the purpose and status for a group of storage locations

Parameters

Name

Type

Description

$data

array

public generateWarehouseLocationLabel($warehouseId, $warehouseLocationIds):array

Generate warehouse location labels

Parameters

Name

Type

Description

$warehouseId

int

$warehouseLocationIds

array

public moveWarehouseLocationPosition($data):void

Move a warehouse location position

Parameters

Name

Type

Description

$data

array

The request data

public listWarehouseLocationStock($page = 1, $itemsPerPage = 50, $paginate = 1, $filters = [], $warehouseLocationId = null, $with = []):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult

Get all warehouse locations stock

Parameters

Name

Type

Description

$page

int

$itemsPerPage

int

$paginate

int

$filters

array

$warehouseLocationId

int

$with

array

public getWarehouseLocationAvailability($warehouseLocationId):array

Get availability for storage location

Parameters

Name

Type

Description

$warehouseLocationId

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

WarehouseLocation

The warehouse location model.

Namespace

Plenty\Modules\Warehouse\Models

Properties
Name Type Description

id

int

The ID of the warehouse location

levelId

int

The level ID of the warehouse location

label

string

The label of the warehouse location

purposeKey

string

The purpose key of the warehouse location

statusKey

string

The status key of the warehouse location

position

int

The position of the warehouse location

fullLabel

string

The label with level path name

type

string

The type of the warehouse location (array values: 'small','medium','large','europallet')

notes

string

The notes of the warehouse location

createdAt

The date when the warehouse location was created

updatedAt

The date when the warehouse location was last updated

warehouseLocationLevel

WarehouseLocationLevel

The level from warehouse location.

Methods
public toArray()

Returns this model as an array.

WarehouseLocationDimension

The warehouse location dimension model.

Namespace

Plenty\Modules\Warehouse\Models

Properties
Name Type Description

id

int

The ID of the warehouse location dimension

parentId

int

The parent ID of the warehouse location dimension

warehouseId

int

The warehouse ID of the warehouse location dimension

level

int

The level of the warehouse location dimension

name

string

The name of the warehouse location dimension

shortcut

string

The shortcut of the warehouse location dimension

separator

string

The separator of the warehouse location dimension

displayInName

int

If true, the dimension prefix will be shown in the storage location name

isActiveForPickupPath

int

Active flag for pickup path of the warehouse location dimension

createdAt

Date when the warehouse location dimension was created

updatedAt

Date when the warehouse location dimension was last updated

warehouseLocationLevel

array

The linked warehouse location level

Methods
public toArray()

Returns this model as an array.

WarehouseLocationInventory

The warehouse location inventory model.

Namespace

Plenty\Modules\Warehouse\Models

Properties
Name Type Description

id

int

The ID of the warehouse location

user_id

int

The user ID of the warehouse location

status

int

The status of the warehouse location inventory

warehouse_location

int

The warehouse location

createdAt

The date when the warehouse location inventory was created

updatedAt

The date when the warehouse location inventory was last updated

warehouseLocation

WarehouseLocation

The warehouse location.

Methods
public toArray()

Returns this model as an array.

WarehouseLocationLevel

The warehouse location level model.

Namespace

Plenty\Modules\Warehouse\Models

Properties
Name Type Description

id

int

The ID of the warehouse location level

parentId

int

The parent ID of the warehouse location level

dimensionId

int

The warehouse location dimension id of the warehouse location level

position

int

The position of the warehouse location level

name

string

The name of the warehouse location level

type

string

The type of the warehouse location ['small','medium','large','europallet']

pathName

string

The complete path name from the level

createdAt

The date when the warehouse location level was created

updatedAt

The date when the warehouse location level was last updated

parent

WarehouseLocationLevel

The parent warehouse location level if existing

children

array

The children warehouse location level if existing

warehouseLocation

array

The linked warehouse location

warehouseLocationDimension

WarehouseLocationDimension

The linked warehouse location dimension

Methods
public toArray()

Returns this model as an array.