Plentymarkets interface documentation

Warehouse

Contracts

InventoryJournalRepositoryContract

Get, create, update and delete inventory journal

Namespace

Plenty\Modules\Warehouse\Contracts

Methods
public getInventoryJournal($inventoryJournal):Plenty\Modules\Warehouse\Models\InventoryJournal
Return type: InventoryJournal

Get a inventory journal

Parameters

Name

Type

Description

$inventoryJournal

int

public getInventoryJournalList($page = 1, $itemsPerPage = 50, $with = []):Plenty\Repositories\Models\PaginatedResult
Return type: PaginatedResult

Get a inventory journal

Parameters

Name

Type

Description

$page

int

$itemsPerPage

int

$with

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.

WarehouseLocationDimensionRepositoryContract

Get, create, update and delete storage location dimensions

Namespace

Plenty\Modules\Warehouse\Contracts

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

Get a storage location dimension

Parameters

Name

Type

Description

$warehouseLocationDimension

int

$with

array

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

Get all storage location dimensions

Parameters

Name

Type

Description

$warehouseId

int

public createMultipleWarehouseLocationDimension($data):array

Create multiple storage location dimensions

Parameters

Name

Type

Description

$data

array

The request data

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

Create a storage 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 storage location dimension

Parameters

Name

Type

Description

$warehouseLocationDimension

int

$data

array

public deleteWarehouseLocationDimension($warehouseLocationDimension):void

Delete a storage 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 storage locations

Namespace

Plenty\Modules\Warehouse\Contracts

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

Get a storage 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 storage 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 storage 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 storage location levels

Namespace

Plenty\Modules\Warehouse\Contracts

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

Get a storage location level

Parameters

Name

Type

Description

$warehouseLocationLevel

int

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

Get a storage 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 storage location level only by name.

Parameters

Name

Type

Description

$warehouseLocationLevelName

string

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

Get a list of storage 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 storage 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 storage location level

Parameters

Name

Type

Description

$warehouseLocationLevel

int

$data

array

public deleteWarehouseLocationLevel($warehouseLocationLevel):void

Delete a storage 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 storage 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 storage locations

Namespace

Plenty\Modules\Warehouse\Contracts

Methods
public getWarehouseLocation($warehouseLocation, $with = []):Plenty\Modules\Warehouse\Models\WarehouseLocation
Return type: WarehouseLocation

Get a storage location

Parameters

Name

Type

Description

$warehouseLocation

int

$with

array

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

Get all storage locations

Parameters

Name

Type

Description

$page

int

$itemsPerPage

int

$paginate

int

$filters

array

$warehouseId

int

$with

array

public listWarehouseLocationsByLevelId($warehouseId, $levelId):void

List storage locations by levelId

Parameters

Name

Type

Description

$warehouseId

int

$levelId

int

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

Get first storage location matching the given label Gets the first storage 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 storage location

Parameters

Name

Type

Description

$data

array

The request data

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

Update a storage 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 storage location

Parameters

Name

Type

Description

$warehouseLocation

int

public deleteMultipleWarehouseLocations($warehouseLocationIds):void

Delete multiple storage 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 storage location labels

Parameters

Name

Type

Description

$warehouseId

int

$warehouseLocationIds

array

public moveWarehouseLocationPosition($data):void

Move a storage 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 storage 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

InventoryJournal

The stocktaking journal model.

Namespace

Plenty\Modules\Warehouse\Models

Properties
Name Type Description

id

int

The ID of the stocktaking journal

warehouseLocationInventoryId

int

The ID of the storage location stocktaking / stocktaking entry

warehouseId

int

The warehouse id

warehouseName

string

The warehouse name

storageLocationId

int

The storage location Id of the stocktaking / stocktaking

storageLocationName

string

The name of the storage location

variationId

int

variation Id

variationNumber

string

The shortcut of the storage location dimension

variationDescription

string

The description / name of the variation

purchasePrice

float

the purchase price of the variation

movingAveragePrice

float

the moving average price of the variation

bestBeforeDate

the best before date of the variation

batch

float

variation batch

quantity

float

variation quantity

unit

string

used unit for the variation

userId

int

user Id

userName

string

user name

origin

string

origin

createdAt

Date when the stocktaking / stocktaking journal for this location was created

updatedAt

Date when the stocktaking / stocktaking journal for this location was updated

Methods
public toArray()

Returns this model as an array.

WarehouseLocation

The storage location model.

Namespace

Plenty\Modules\Warehouse\Models

Properties
Name Type Description

id

int

The ID of the storage location

levelId

int

The level ID of the storage location

label

string

The label of the storage location

purposeKey

string

The purpose key of the storage location

statusKey

string

The status key of the storage location

position

int

The position of the storage location

fullLabel

string

The label with level path name

type

string

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

notes

string

The notes of the storage location

createdAt

The date when the storage location was created

updatedAt

The date when the storage location was last updated

warehouseLocationLevel

WarehouseLocationLevel

The level from storage location.

lastFinishedInventory

WarehouseLocationInventory

The last finished storage location inventory.

Methods
public toArray()

Returns this model as an array.

WarehouseLocationDimension

The storage location dimension model.

Namespace

Plenty\Modules\Warehouse\Models

Properties
Name Type Description

id

int

The ID of the storage location dimension

parentId

int

The parent ID of the storage location dimension

warehouseId

int

The warehouse ID of the storage location dimension

level

int

The level of the storage location dimension

name

string

The name of the storage location dimension

shortcut

string

The shortcut of the storage location dimension

separator

string

The separator of the storage 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 storage location dimension

createdAt

Date when the storage location dimension was created

updatedAt

Date when the storage location dimension was last updated

warehouseLocationLevel

array

The linked storage location level

Methods
public toArray()

Returns this model as an array.

WarehouseLocationInventory

The storage location stocktaking model.

Namespace

Plenty\Modules\Warehouse\Models

Properties
Name Type Description

id

int

The ID of the storage location

userId

int

The user ID of the storage location

user_id

int

deprecated - use userID instead

status

int

The status of the storage location stocktaking

warehouseLocationId

int

The storage location ID

warehouse_location

int

deprecated - use WarehouseLocationId

createdAt

The date when the storage location stocktaking was created

updatedAt

The date when the storage location stocktaking was last updated

warehouseLocation

WarehouseLocation

The storage location.

Methods
public toArray()

Returns this model as an array.

WarehouseLocationLevel

The storage location level model.

Namespace

Plenty\Modules\Warehouse\Models

Properties
Name Type Description

id

int

The ID of the storage location level

parentId

int

The parent ID of the storage location level

dimensionId

int

The storage location dimension id of the storage location level

position

int

The position of the storage location level

name

string

The name of the storage location level

type

string

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

pathName

string

The complete path name from the level

createdAt

The date when the storage location level was created

updatedAt

The date when the storage location level was last updated

parent

WarehouseLocationLevel

The parent storage location level if existing

children

array

The children storage location level if existing

warehouseLocation

array

The linked storage location

warehouseLocationDimension

WarehouseLocationDimension

The linked storage location dimension

Methods
public toArray()

Returns this model as an array.