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\InventoryJournalReturn type: InventoryJournal
Get a inventory journal
Name |
Type |
Description |
|
public getInventoryJournalList($page = 1, $itemsPerPage = 50, $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Get a inventory journal
Name |
Type |
Description |
|
||
|
||
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears 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\WarehouseLocationDimensionReturn type: WarehouseLocationDimension
Get a storage location dimension
Name |
Type |
Description |
|
||
|
public listWarehouseLocationDimension($warehouseId):Plenty\Modules\Warehouse\Models\WarehouseLocationDimensionReturn type: WarehouseLocationDimension
Get all storage location dimensions
Name |
Type |
Description |
|
public createMultipleWarehouseLocationDimension($data):arrayCreate multiple storage location dimensions
Name |
Type |
Description |
|
The request data |
public createWarehouseLocationDimension($data):Plenty\Modules\Warehouse\Models\WarehouseLocationDimensionReturn type: WarehouseLocationDimension
Create a storage location dimension
Name |
Type |
Description |
|
The request data |
public updateWarehouseLocationDimension($warehouseLocationDimension, $data):Plenty\Modules\Warehouse\Models\WarehouseLocationDimensionReturn type: WarehouseLocationDimension
Update a storage location dimension
Name |
Type |
Description |
|
||
|
public deleteWarehouseLocationDimension($warehouseLocationDimension):voidDelete a storage location dimension
Name |
Type |
Description |
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
WarehouseLocationInventoryRepositoryContract
Get, create, update and delete storage locations
Namespace
Plenty\Modules\Warehouse\Contracts
Methods
public getWarehouseLocationInventory($warehouseLocationInventory):Plenty\Modules\Warehouse\Models\WarehouseLocationInventoryReturn type: WarehouseLocationInventory
Get a storage location inventory
Name |
Type |
Description |
|
public getWarehouseLocationInventoryList($page = 1, $itemsPerPage = 50, $paginate = 1, $filters = [], $warehouseLocationId = null, $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Get a storage location inventory
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
||
|
public createWarehouseLocationInventory($data):Plenty\Modules\Warehouse\Models\WarehouseLocationInventoryReturn type: WarehouseLocationInventory
Create a storage location inventory
Name |
Type |
Description |
|
The request data |
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears 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\WarehouseLocationLevelReturn type: WarehouseLocationLevel
Get a storage location level
Name |
Type |
Description |
|
public getWarehouseLocationLevelByName($warehouseLocationLevelName, $dimensionId, $parentId):Plenty\Modules\Warehouse\Models\WarehouseLocationLevelReturn type: WarehouseLocationLevel
Get a storage location level
Name |
Type |
Description |
|
||
|
||
|
public getWarehouseLocationLevelOnlyByName($warehouseLocationLevelName):Plenty\Modules\Warehouse\Models\WarehouseLocationLevelReturn type: WarehouseLocationLevel
Get a storage location level only by name.
Name |
Type |
Description |
|
public listWarehouseLocationLevels($filters = [], $warehouseId = null):arrayGet a list of storage location levels
Name |
Type |
Description |
|
||
|
public createWarehouseLocationLevel($data, $apiMode = false):Plenty\Modules\Warehouse\Models\WarehouseLocationLevelReturn type: WarehouseLocationLevel
Create a storage location level
Name |
Type |
Description |
|
The request data |
|
|
If the location is created using a route |
public updateWarehouseLocationLevel($warehouseLocationLevel, $data):Plenty\Modules\Warehouse\Models\WarehouseLocationLevelReturn type: WarehouseLocationLevel
Update a storage location level
Name |
Type |
Description |
|
||
|
public deleteWarehouseLocationLevel($warehouseLocationLevel):voidDelete a storage location level
Name |
Type |
Description |
|
public getWarehouseStructure($warehouseId, $data = []):voidGet a warehouse structure.
Name |
Type |
Description |
|
||
|
public moveWarehouseLocationLevelPosition($data):voidMove a storage location level position
Name |
Type |
Description |
|
The request data |
public getWarehouseStructureMoving($warehouseId, $data):voidGet a warehouse structure moving.
Name |
Type |
Description |
|
||
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears 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\WarehouseLocationReturn type: WarehouseLocation
Get a storage location
Name |
Type |
Description |
|
||
|
public listWarehouseLocations($page = 1, $itemsPerPage = 50, $paginate = 1, $filters = [], $warehouseId = null, $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Get all storage locations
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
||
|
public listWarehouseLocationsByLevelId($warehouseId, $levelId):voidList storage locations by levelId
Name |
Type |
Description |
|
||
|
public getWarehouseLocationByLabel($label):Plenty\Modules\Warehouse\Models\WarehouseLocationReturn type: WarehouseLocation
Get first storage location matching the given label Gets the first storage location matching the given label. The label must be specified.
Name |
Type |
Description |
|
public createWarehouseLocation($data):Plenty\Modules\Warehouse\Models\WarehouseLocationReturn type: WarehouseLocation
Create a storage location
Name |
Type |
Description |
|
The request data |
public updateWarehouseLocation($warehouseLocation, $data):Plenty\Modules\Warehouse\Models\WarehouseLocationReturn type: WarehouseLocation
Update a storage location
Name |
Type |
Description |
|
||
|
public updateStorageLocations($data):voidUpdates several Storage Locations in a single DB Transaction with the data provided
Name |
Type |
Description |
|
public deleteWarehouseLocation($warehouseLocation):voidDelete a storage location
Name |
Type |
Description |
|
public deleteMultipleWarehouseLocations($warehouseLocationIds):voidDelete multiple storage locations
Name |
Type |
Description |
|
public executeGroupFunction($data):arrayEdit the purpose and status for a group of storage locations
Name |
Type |
Description |
|
public generateWarehouseLocationLabel($warehouseId, $warehouseLocationIds):arrayGenerate storage location labels
Name |
Type |
Description |
|
||
|
public moveWarehouseLocationPosition($data):voidMove a storage location position
Name |
Type |
Description |
|
The request data |
public listWarehouseLocationStock($page = 1, $itemsPerPage = 50, $paginate = 1, $filters = [], $warehouseLocationId = null, $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Get all storage locations stock
Name |
Type |
Description |
|
||
|
||
|
||
|
||
|
||
|
Get availability for storage location
Name |
Type |
Description |
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
WarehouseRepositoryContract
The interface for the warehouse repository
Namespace
Plenty\Modules\Warehouse\Contracts
Methods
public search($perPage = 50, $page = 1, $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Gets a list of warehouses. Filter can be specified.
Name |
Type |
Description |
|
||
|
||
|
public create($data):Plenty\Modules\Warehouse\Models\WarehouseReturn type: Warehouse
Creates a warehouse.
Name |
Type |
Description |
|
public update($id, $data):Plenty\Modules\Warehouse\Models\WarehouseReturn type: Warehouse
Updates a warehouse. The ID of the warehouse must be specified.
Name |
Type |
Description |
|
||
|
public delete($id, $newWarehouseId = -1):boolDeletes a warehouse. The ID of the warehouse must be specified.
Name |
Type |
Description |
|
||
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
InventoryJournal
The stocktaking journal model.
Namespace
Plenty\Modules\Warehouse\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of the stocktaking journal |
|
warehouseLocationInventoryId |
The ID of the storage location stocktaking / stocktaking entry |
|
warehouseId |
The warehouse id |
|
warehouseName |
The warehouse name |
|
storageLocationId |
The storage location Id of the stocktaking / stocktaking |
|
storageLocationName |
The name of the storage location |
|
variationId |
variation Id |
|
variationNumber |
The shortcut of the storage location dimension |
|
variationDescription |
The description / name of the variation |
|
purchasePrice |
the purchase price of the variation |
|
movingAveragePrice |
the moving average price of the variation |
|
bestBeforeDate |
the best before date of the variation |
|
batch |
variation batch |
|
quantity |
variation quantity |
|
unitContent |
content of unit for the variation |
|
unit |
used unit for the variation |
|
userId |
user Id |
|
userName |
user name |
|
origin |
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.
Warehouse
The warehouse model in plentymarkets represents actual warehouses. Every warehouse is identified by an Id. Furthermore a warehouse is described by a name and is always associated with an address. This address may not only contain a physical address information like a street, a house number, a postal code and a town, but also an email address, a telephone number or a fax number.
Namespace
Plenty\Modules\Warehouse\Models
| Name | Type | Description |
|---|---|---|
id |
The id of the warehouse |
|
name |
The name of the warehouse |
|
note |
A note for this warehouse |
|
typeId |
The id of the warehouse type. The following types are available: <ul> <li>0 = Sales warehouse</li> <li>1 = Repair warehouse</li> <li>4 = Storage warehouse</li> <li>5 = Transit warehouse</li> <li>6 = Distribution warehouse</li> <li>7 = Other</li> </ul> |
|
priority |
The priority of the warehouse. The higher the priority, the more important the warehouse is. The priority is used for automatic warehouse detection. |
|
allocationReferrerIds |
Allocation Referrer Ids by automatic warehouse detection |
|
onStockAvailability |
Displayed availability of a variation if stock is available |
|
outOfStockAvailability |
Displayed availability of a variation if no stock is available |
|
splitByShippingProfile |
Flag that indicates if for this warehouse orders are split by shipping profiles or not. <ul><li>True = Orders are split by shipping profiles</li> <li>False = Orders will not be split by shipping profiles</li></ul> |
|
storageLocationType |
The storage location type. The following types are available: <ul><li>none</li> <li>small</li><li>medium</li> <li>large</li> <li>europallet</li></ul> |
|
storageLocationZone |
The zone that the storage location is in |
|
repairWarehouseId |
The id of the associated repair warehouse |
|
isInventoryModeActive |
Flag that indicates if the stocktaking mode for this warehouse is active or not. <ul><li>True = active</li> <li>False = inactive</li></ul> |
|
logisticsType |
The id of the logistics type of the warehouse. The logistics type states which service provider fulfills the storage and shipping. The following logistics types are available: <ul> <li>own</li> <li>amazon</li> <li>dhlFulfillment</li> </ul> |
|
address |
The address that the warehouse is located at |
|
repairWarehouse |
All information about the repair warehouse if a repair warehouse is linked to the sales warehouse |
|
updatedAt |
The updated at timestamp of the warehouse |
|
createdAt |
The created at timestamp of the warehouse |
Methods
public toArray()Returns this model as an array.
WarehouseLocation
The storage location model.
Namespace
Plenty\Modules\Warehouse\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of the storage location |
|
levelId |
The level ID of the storage location |
|
label |
The label of the storage location |
|
purposeKey |
The purpose key of the storage location |
|
statusKey |
The status key of the storage location |
|
position |
The position of the storage location |
|
fullLabel |
The label with level path name |
|
type |
The type of the storage location (array values: 'small','medium','large','europallet') |
|
notes |
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 |
The level from storage location. |
|
lastFinishedInventory |
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
| Name | Type | Description |
|---|---|---|
id |
The ID of the storage location dimension |
|
parentId |
The parent ID of the storage location dimension |
|
warehouseId |
The warehouse ID of the storage location dimension |
|
level |
The level of the storage location dimension |
|
name |
The name of the storage location dimension |
|
shortcut |
The shortcut of the storage location dimension |
|
separator |
The separator of the storage location dimension |
|
displayInName |
If true, the dimension prefix will be shown in the storage location name |
|
isActiveForPickupPath |
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 |
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
| Name | Type | Description |
|---|---|---|
id |
The ID of the storage location |
|
userId |
The user ID of the storage location |
|
user_id |
deprecated - use userID instead |
|
status |
The status of the storage location stocktaking |
|
warehouseLocationId |
The storage location ID |
|
warehouse_location |
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 |
The storage location. |
Methods
public toArray()Returns this model as an array.
WarehouseLocationLevel
The storage location level model.
Namespace
Plenty\Modules\Warehouse\Models
| Name | Type | Description |
|---|---|---|
id |
The ID of the storage location level |
|
parentId |
The parent ID of the storage location level |
|
dimensionId |
The storage location dimension id of the storage location level |
|
position |
The position of the storage location level |
|
name |
The name of the storage location level |
|
type |
The type of the storage location ['small','medium','large','europallet'] |
|
pathName |
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 |
The parent storage location level if existing |
|
children |
The children storage location level if existing |
|
warehouseLocation |
The linked storage location |
|
warehouseLocationDimension |
The linked storage location dimension |
Methods
public toArray()Returns this model as an array.