Warehouse

Contracts

WarehouseLocationRepositoryContract

Get, create, update and delete warehouse locations

Namespace

Plenty\Modules\Warehouse\Contracts

Methods

public getWarehouseLocation(int $warehouseLocation):WarehouseLocation

Get a warehouse location

Parameters
int $warehouseLocation
public listWarehouseLocations(int $page = 1, int $itemsPerPage = 50, int $paginate = 1, array $filters = [], int $warehouseId = null):PaginatedResult

Get all warehouse locations

Parameters
int $page
int $itemsPerPage
int $paginate
array $filters
int $warehouseId
public getWarehouseLocationByLabel(string $label):WarehouseLocation

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

Parameters
string $label
public createWarehouseLocation(array $data):WarehouseLocation

Create a warehouse location

Parameters
array $data The request data
public updateWarehouseLocation(int $warehouseLocation, array $data):WarehouseLocation

Update a warehouse location

Parameters
int $warehouseLocation
array $data
public deleteWarehouseLocation(int $warehouseLocation):void

Delete a warehouse location

Parameters
int $warehouseLocation
public deleteMultipleWarehouseLocations(array $warehouseLocationIds):void

Delete multiple warehouse locations

Parameters
array $warehouseLocationIds
public executeGroupFunction(array $data):array

Edit the purpose and status for a group of storage locations

Parameters
array $data
public generateWarehouseLocationLabel(int $warehouseId, array $warehouseLocationIds):array

Generate warehouse location labels

Parameters
int $warehouseId
array $warehouseLocationIds
public moveWarehouseLocationPosition(array $data):void

Move a warehouse location position

Parameters
array $data 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(array $filters = []):void

Sets the filter array.

Parameters
array $filters
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(int $warehouseLocationLevel):WarehouseLocationLevel

Get a warehouse location level

Parameters
int $warehouseLocationLevel
public getWarehouseLocationLevelByName(string $warehouseLocationLevelName, int $dimensionId, int $parentId):WarehouseLocationLevel

Get a warehouse location level

Parameters
string $warehouseLocationLevelName
int $dimensionId
int $parentId
public getWarehouseLocationLevelOnlyByName(string $warehouseLocationLevelName):WarehouseLocationLevel

Get a warehouse location level only by name.

Parameters
string $warehouseLocationLevelName
public listWarehouseLocationLevels(array $filters = [], int $warehouseId = null):array

Get a list of warehouse location levels

Parameters
array $filters
int $warehouseId
public createWarehouseLocationLevel(array $data, bool $apiMode = false):WarehouseLocationLevel

Create a warehouse location level

Parameters
array $data The request data
bool $apiMode If the location is created using a route
public updateWarehouseLocationLevel(int $warehouseLocationLevel, array $data):WarehouseLocationLevel

Update a warehouse location level

Parameters
int $warehouseLocationLevel
array $data
public deleteWarehouseLocationLevel(int $warehouseLocationLevel):void

Delete a warehouse location level

Parameters
int $warehouseLocationLevel
public getWarehouseStructure(int $warehouseId):void

Get a warehouse structure.

Parameters
int $warehouseId
public moveWarehouseLocationLevelPosition(array $data):void

Move a warehouse location level position

Parameters
array $data 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(array $filters = []):void

Sets the filter array.

Parameters
array $filters
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.

WarehouseLocationDimensionRepositoryContract

Get, create, update and delete warehouse location dimensions

Namespace

Plenty\Modules\Warehouse\Contracts

Methods

public getWarehouseLocationDimension(int $warehouseLocationDimension, array $with = []):WarehouseLocationDimension

Get a warehouse location dimension

Parameters
int $warehouseLocationDimension
array $with
public listWarehouseLocationDimension(int $warehouseId):WarehouseLocationDimension

Get all warehouse location dimensions

Parameters
int $warehouseId
public createMultipleWarehouseLocationDimension(array $data):array

Create multiple warehouse location dimensions

Parameters
array $data The request data
public createWarehouseLocationDimension(array $data):WarehouseLocationDimension

Create a warehouse location dimension

Parameters
array $data The request data
public updateWarehouseLocationDimension(int $warehouseLocationDimension, array $data):WarehouseLocationDimension

Update a warehouse location dimension

Parameters
int $warehouseLocationDimension
array $data
public deleteWarehouseLocationDimension(int $warehouseLocationDimension):void

Delete a warehouse location dimension

Parameters
int $warehouseLocationDimension
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(array $filters = []):void

Sets the filter array.

Parameters
array $filters
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

WarehouseLocationDimension

The warehouse location dimension model.

Namespace

Plenty\Modules\Warehouse\Models

Properties

Type Name Description
int id The ID of the warehouse location dimension
int parentId The parent ID of the warehouse location dimension
int warehouseId The warehouse ID of the warehouse location dimension
int level The level of the warehouse location dimension
string name The name of the warehouse location dimension
string shortcut The shortcut of the warehouse location dimension
string separator The separator of the warehouse location dimension
int displayInName If true, the dimension prefix will be shown in the storage location name
int isActiveForPickupPath 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
array warehouseLocationLevel The linked warehouse location level

Methods

public toArray()

Returns this model as an array.

WarehouseLocationLevel

The warehouse location level model.

Namespace

Plenty\Modules\Warehouse\Models

Properties

Type Name Description
int id The ID of the warehouse location level
int parentId The parent ID of the warehouse location level
int dimensionId The warehouse location dimension id of the warehouse location level
int position The position of the warehouse location level
string name The name of the warehouse location level
string type The type of the warehouse location ['small','medium','large','europallet']
string pathName 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
WarehouseLocationLevel parent The parent warehouse location level if existing
array children The children warehouse location level if existing
array warehouseLocation The linked warehouse location
WarehouseLocationDimension warehouseLocationDimension The linked warehouse location dimension

Methods

public toArray()

Returns this model as an array.

WarehouseLocation

The warehouse location model.

Namespace

Plenty\Modules\Warehouse\Models

Properties

Type Name Description
int id The ID of the warehouse location
int levelId The level ID of the warehouse location
string label The label of the warehouse location
string purposeKey The purpose key of the warehouse location
string statusKey The status key of the warehouse location
int position The position of the warehouse location
string fullLabel The label with level path name
string type The type of the warehouse location (array values: 'small','medium','large','europallet')
string notes 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.