Plentymarkets interface documentation
Stock
Contracts
IncomingStockSettingsRepositoryContract
Get or update incoming stock settings
Namespace
Plenty\Modules\StockManagement\Stock\Contracts
Methods
public get():Plenty\Modules\StockManagement\Stock\Models\IncomingStockSettingsReturn type: IncomingStockSettings
Get the incoming stock settings.
public update($data):Plenty\Modules\StockManagement\Stock\Models\IncomingStockSettingsReturn type: IncomingStockSettings
Update the incoming stock settings.
Name |
Type |
Description |
|
ItemVariationWarehouseDynamicRepositoryContract
The ItemVariationWarehouseDynamicRepositoryContract is the interface for the stock repository. This interface allows you to find, create and update stock. Stock is assigned to one variation and is stored in warehouses.
Namespace
Plenty\Modules\StockManagement\Stock\Contracts
Methods
public findAvgOrderByVariationId($variationId):voidName |
Type |
Description |
|
StockRepositoryContract
The StockRepositoryContract is the interface for the stock repository. This interface allows you to find, create and update stock. Stock is assigned to one variation and is stored in warehouses.
Namespace
Plenty\Modules\StockManagement\Stock\Contracts
Methods
public listStockByWarehouseId($warehouseId, $columns = [], $page = 1, $itemsPerPage = 50):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
List stock of a warehouse
Name |
Type |
Description |
|
The ID of the warehouse |
|
|
The properties to be loaded |
|
|
The requested page |
|
|
The number of items per page |
public listStock($columns = [], $page = 1, $itemsPerPage = 50):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
List stock
Name |
Type |
Description |
|
The properties to be loaded |
|
|
The requested page |
|
|
The number of items per page |
public listStockJoinStorageLocation($columns = [], $page = 1, $itemsPerPage = 50):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
List stock joined with storage locations
Name |
Type |
Description |
|
The properties to be loaded |
|
|
The requested page |
|
|
The number of items per page |
public listStockByWarehouseType($type, $columns = [], $page = 1, $itemsPerPage = 50):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
List stock by warehouse type
Name |
Type |
Description |
|
The type of the warehouse. Currently only 'sales' is supported. |
|
|
The properties to be loaded |
|
|
The requested page |
|
|
The number of items per page |
public correctStock($warehouseId, $data):voidCorrects stock. The ID of the warehouse has to be provided.
Name |
Type |
Description |
|
The ID of the warehouse. |
|
|
The request data. |
public bookIncomingItems($warehouseId, $data):voidBook incoming stock
Name |
Type |
Description |
|
The ID of the warehouse |
|
|
The request data |
public bookOutgoingItems($warehouseId, $data):voidBook outgoing stock
Name |
Type |
Description |
|
The ID of the warehouse |
|
|
The request data |
public bookStocktaking($warehouseId, $warehouseLocationId, $data):voidBook stocktaking
Name |
Type |
Description |
|
||
|
||
|
public redistributeStock($data, $additionalParams = []):voidRedistribute stock
Name |
Type |
Description |
|
The request data |
|
|
public listStockMovements($warehouseId, $columns = [], $page = 1, $itemsPerPage = 50):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
List stock movements
Name |
Type |
Description |
|
The ID of the warehouse |
|
|
The properties to be loaded |
|
|
The requested page |
|
|
The number of items per page |
public listStockMovementArchives():arrayList archive years of stock movements
public unpackVariation($warehouseId, $variationStockIntake, $variationStockCorrection):Plenty\Modules\StockManagement\Warehouse\Models\WarehouseReturn type: Warehouse
Unpack variation
Name |
Type |
Description |
|
The ID of the warehouse |
|
|
||
|
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.
StockStorageLocationRepositoryContract
The StockStorageLocationRepositoryContract is the interface for the stock storage location repository. This interface allows you to list the stock of all storage locations of a warehouse or to list all storage locations of a variation and the stock stored at these locations.
Namespace
Plenty\Modules\StockManagement\Stock\Contracts
Methods
public listStockStorageLocations($columns = [], $page = 1, $itemsPerPage = 50, $with = [], $filters = []):voidList stock of all storage locations
Name |
Type |
Description |
|
The properties to be loaded |
|
|
The requested page |
|
|
The number of items per page |
|
|
The relations to load in the StockStorageLocationInstance |
|
|
Conditions to be applied to the search |
public listStockStorageLocationsByWarehouseId($warehouseId, $columns = [], $page = 1, $itemsPerPage = 50, $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
List stock of all storage locations of a warehouse
Name |
Type |
Description |
|
The ID of the warehouse |
|
|
The properties to be loaded |
|
|
The requested page |
|
|
The number of items per page |
|
|
The relations to load in the StockStorageLocationInstance, possible is: storageLocation |
public listStockStorageLocationsByVariationId($variationId, $columns = [], $page = 1, $itemsPerPage = 50, $with = [], $sortBy = "id", $sortOrder = "asc"):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
List stock of a variation per storage location
Name |
Type |
Description |
|
The ID of the variation. |
|
|
The properties to be loaded |
|
|
The requested page |
|
|
The number of items per page |
|
|
The relations to load in the StockStorageLocationInstance, possible is: storageLocation |
|
|
||
|
public listStockStorageLocationsByWarehouseIdPim($warehouseId, $columns = [], $page = 1, $itemsPerPage = 50, $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
List stock of all storage locations of a warehouse with pim entry
Name |
Type |
Description |
|
The ID of the warehouse |
|
|
The properties to be loaded |
|
|
The requested page |
|
|
The number of items per page |
|
|
The relations to load in the StockStorageLocationInstance, possible is: storageLocation |
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
IncomingStockSettings
Configuration of incoming stock
Namespace
Plenty\Modules\StockManagement\Stock\Models
| Name | Type | Description |
|---|---|---|
intakePurchasePriceTransferred |
Whether the purchase price is transferred and the transfer method. Accepted values: 0: No transfer, 1: Save purchase price in variation data, 2: Save purchase price in variation and supplier data, 3: Save live average purchase price in variation data, 4: Save the highest purchase price in the variation, 5: Save the lowest purchase price in the variation. |
|
intakeStorageLocationTransferred |
Whether the storage location is saved and the save method. Accepted values: 0: Storage location not saved, 1: Save storage location in variation data, 2: Save storage location in variation data if no storage location or default storage location saved. |
|
warehouseSearchPurchasePrice |
||
intakeMaximumQuantity |
Maximum quantity for incoming stock |
|
deleteStorageLocationTime |
Time after empty stock information for storage locations is deleted. Accepted values: 1: 1 day, 2: 2 days, 3: 3 days, 4: 4 days, 5: 5 days, 6: 6 days, 7: 1 week, 14: 2 weeks, 30: 1 month, 91: 3 months, 183: 6 months, 365: 1 year. |
|
invisibleStockEntryZeroTime |
Time after empty stock information for warehouses is deleted. Accepted values: 2: 2 days, 3: 3 days, 4: 4 days, 5: 5 days, 6: 6 days, 7: 1 week, 14: 2 weeks, 21: 3 weeks, 30: 1 month, 0: Never. |
|
movingAveragePriceWarehouses |
||
intakeCheckMultiBatchOfStorageLocation |
Batch/BBD per storage location rule. Accepted values: 0: Only one batch/BBD per variation per storage location, 1: Only one batch/BBD per storage location, 2: No limitation. |
Methods
public toArray()Returns this model as an array.
ItemVariationWarehouseDynamic
The stock model. There are 4 different stock terms used in plentymarkets. The physical stock, the net stock, the reserved stock and the stock reserved for listings.
Namespace
Plenty\Modules\StockManagement\Stock\Models
| Name | Type | Description |
|---|---|---|
itemId |
The ID of the item |
|
variationId |
The ID of the variation |
|
warehouseId |
The ID of the warehouse |
|
stockPhysical |
The physical stock |
|
reservedStock |
The reserved stock |
|
reservedEbay |
The stock reserved for ebay |
|
reorderDelta |
The reorder delta |
|
stockNet |
The net stock |
|
reordered |
The reordered quantity of a variation |
|
warehousePriority |
The priority of the warehouse |
|
reservedBundle |
Reserved bundle |
|
averagePurchasePrice |
The average purchase price |
|
averageSale |
The averageSale price |
|
updatedAt |
The time the stock was last updated |
Methods
public toArray()Returns this model as an array.
Stock
The stock model. There are 4 different stock terms used in plentymarkets. The physical stock, the net stock, the reserved stock and the stock reserved for listings.
Namespace
Plenty\Modules\StockManagement\Stock\Models
| Name | Type | Description |
|---|---|---|
itemId |
The ID of the item |
|
variationId |
The ID of the variation |
|
warehouseId |
The ID of the warehouse |
|
stockPhysical |
The physical stock |
|
reservedStock |
The reserved stock |
|
reservedEbay |
The stock reserved for ebay |
|
reorderDelta |
The reorder delta |
|
stockNet |
The net stock |
|
reordered |
The reordered quantity of a variation |
|
warehousePriority |
The priority of the warehouse |
|
reservedBundle |
Reserved bundle |
|
averagePurchasePrice |
The average purchase price |
|
averageSale |
The average sale |
|
updatedAt |
The time the stock was last updated |
Methods
public toArray()Returns this model as an array.
StockBatchBestBeforeDate
The stock batch best before date model contains all information about the batch and best before date.
Namespace
Plenty\Modules\StockManagement\Stock\Models
| Name | Type | Description |
|---|---|---|
batch |
||
bestBeforeDate |
Methods
public toArray()Returns this model as an array.
StockStorageLocation
The stock storage location model contains all information about the stock that is stored at one storage location.
Namespace
Plenty\Modules\StockManagement\Stock\Models
| Name | Type | Description |
|---|---|---|
itemId |
The ID of the item |
|
variationId |
The ID of the variation |
|
storageLocationId |
The ID of the storage location. |
|
warehouseId |
The ID of the warehouse that the storage location is in |
|
quantity |
The quantity stored at the storage location |
|
bestBeforeDate |
The best before date |
|
batch |
The batch |
|
updatedAt |
The day and time the stock was last updated |
|
storageLocation |
Deprecated! Use warehouseLocation instead |
|
warehouseLocation |
The storage location of the item |
|
variation |
The variation of the item |
Methods
public toArray()Returns this model as an array.
Warehouse
Contracts
WarehouseRepositoryContract
The WarehouseRepositoryContract is the interface for the warehouse repository. This interface allows you to either get one warehouse by specifying the id or to list all warehouses.
Namespace
Plenty\Modules\StockManagement\Warehouse\Contracts
Methods
public findById($warehouseId, $with = []):Plenty\Modules\StockManagement\Warehouse\Models\WarehouseReturn type: Warehouse
Get a warehouse
Name |
Type |
Description |
|
The id of the warehouse. |
|
|
The relations to load in the warehouse instance. repairWarehouse is the only relation currently available. |
public all($with = [], $columns = []):arrayList warehouses
Name |
Type |
Description |
|
The relations to load in the warehouse instance. repairWarehouse is the only relation currently available. |
|
|
The columns to load in the response |
public create($data):Plenty\Modules\StockManagement\Warehouse\Models\WarehouseReturn type: Warehouse
Create a warehouse
Name |
Type |
Description |
|
The request data. |
public allPaginated($columns = [], $page = 1, $itemsPerPage = 50, $filters = [], $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
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
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\StockManagement\Warehouse\Models
| Name | Type | Description |
|---|---|---|
id |
The id of the warehouse |
|
name |
The name of the warehouse |
|
warehouseKeeperName |
The name of the warehouse keeper name |
|
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> |
|
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.
Management
Contracts
RackManagementRepositoryContract
The RackManagementRepositoryContract is the interface for the rack management repository. This interface provides the functionality to manage the warehouse configuration for racks. Racks can be retrieved, created or updated here.
|
Deprecated! (since 2018-03)
Please use Plenty\Modules\Warehouse\Contracts\WarehouseLocationDimensionRepositoryContract instead |
Namespace
Plenty\Modules\StockManagement\Warehouse\Management\Contracts
Methods
public getRackById($rackId, $columns = [], $with = []):Plenty\Modules\StockManagement\Warehouse\Management\Models\RackReturn type: Rack
Find a rack by id.
Name |
Type |
Description |
|
The id of the rack. |
|
|
The attributes to be loaded. |
|
|
The relations to be loaded. Possible values are 'warehouse', 'shelves' and 'storageLocations'. |
public findRacks($page = 1, $itemsPerPage = 50, $columns = [], $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Find racks. The results can be filtered by warehouse id.
Name |
Type |
Description |
|
The requested page. |
|
|
Number of items per page. |
|
|
The attributes to be loaded. |
|
|
The relations to be loaded. Possible values are 'warehouse', 'shelves' and 'storageLocations'. |
public createRack($data, $warehouseId):Plenty\Modules\StockManagement\Warehouse\Management\Models\RackReturn type: Rack
Create a new rack.
Name |
Type |
Description |
|
The data to create a new rack. |
|
|
The id of the warehouse the rack shall belong to. |
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.
ShelfManagementRepositoryContract
The ShelfManagementRepositoryContract is the interface for the shelf management repository. This interface provides the functionality to manage the warehouse configuration for shelves. Shelves can be retrieved, created or updated here.
|
Deprecated! (since 2018-03)
Please use Plenty\Modules\Warehouse\Contracts\WarehouseLocationDimensionRepositoryContract instead |
Namespace
Plenty\Modules\StockManagement\Warehouse\Management\Contracts
Methods
public getShelfById($shelfId, $columns = [], $with = []):Plenty\Modules\StockManagement\Warehouse\Management\Models\ShelfReturn type: Shelf
Find a shelf by id.
Name |
Type |
Description |
|
The id of the shelf. |
|
|
The attributes to be loaded. |
|
|
The relations to be loaded. Possible values are 'warehouse', 'rack' and 'storageLocations'. |
public findShelves($page = 1, $itemsPerPage = 50, $columns = [], $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Find shelves. The results can be filtered by warehouse id and rack id.
Name |
Type |
Description |
|
The requested page. |
|
|
Number of items per page. |
|
|
The attributes to be loaded. |
|
|
The relations to be loaded. Possible values are 'warehouse', 'rack' and 'storageLocations'. |
public createShelf($data, $warehouseId, $rackId):Plenty\Modules\StockManagement\Warehouse\Management\Models\ShelfReturn type: Shelf
Create a new shelf.
Name |
Type |
Description |
|
The data to create a new shelf. |
|
|
The id of the warehouse the shelf shall belong to. |
|
|
The id of the rack the shelf shall belong to. |
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.
StorageLocationManagementRepositoryContract
The StorageLocationManagementRepositoryContract is the interface for the storage location management repository. This interface provides the functionality to manage the warehouse configuration for storage locations. Storage locations can be retrieved, created or updated here.
|
Deprecated! (since 2018-03)
Please use Plenty\Modules\Warehouse\Contracts\WarehouseLocationRepositoryContract instead |
Namespace
Plenty\Modules\StockManagement\Warehouse\Management\Contracts
Methods
public getStorageLocationById($storageLocationId, $columns = [], $with = []):Plenty\Modules\StockManagement\Warehouse\Management\Models\StorageLocationReturn type: StorageLocation
Find a storage location by id.
Name |
Type |
Description |
|
The id of the storage location. |
|
|
The attributes to be loaded. |
|
|
The relations to be loaded. Possible values are 'warehouse', 'rack' and 'shelf'. |
public findStorageLocations($page = 1, $itemsPerPage = 50, $columns = [], $with = []):Plenty\Repositories\Models\PaginatedResultReturn type: PaginatedResult
Find storage locations. The results can be filtered by warehouse id, rack id and shelf id.
Name |
Type |
Description |
|
The requested page. |
|
|
Number of items per page. |
|
|
The attributes to be loaded. |
|
|
The relations to be loaded. Possible values are 'warehouse', 'rack' and 'shelf'. |
public createStorageLocation($data, $warehouseId, $rackId, $shelfId):Plenty\Modules\StockManagement\Warehouse\Management\Models\StorageLocationReturn type: StorageLocation
Create a new storage location.
Name |
Type |
Description |
|
The data to create a new storage location. |
|
|
The id of the warehouse the storage location shall belong to. |
|
|
The id of the rack the storage location shall belong to. |
|
|
The id of the shelf the storage location shall belong to. |
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
Rack
The storage rack model
Namespace
Plenty\Modules\StockManagement\Warehouse\Management\Models
| Name | Type | Description |
|---|---|---|
id |
The id of the rack. |
|
name |
The name of the rack. |
|
position |
The position of the rack. |
|
warehouseId |
The id of the warehouse the rack belongs to. |
|
zone |
The zone of the rack. Numbers between 1 and 20 are valid. |
|
warehouse |
The warehouse this rack belongs to. |
|
shelves |
The shelves that belong to this rack. |
|
storageLocations |
The storage locations that belong to this rack. |
Methods
public toArray()Returns this model as an array.
Shelf
The storage shelf model
Namespace
Plenty\Modules\StockManagement\Warehouse\Management\Models
| Name | Type | Description |
|---|---|---|
id |
The id of the shelf. |
|
rackId |
The id of the rack the shelf belongs to. |
|
name |
The name of the shelf. |
|
level |
The level of the shelf. Numbers between 1 and 25 are valid. |
|
rack |
The rack this shelf belongs to. |
|
storageLocations |
The storage locations of this shelf. |
Methods
public toArray()Returns this model as an array.
StorageLocation
The storage location model
Namespace
Plenty\Modules\StockManagement\Warehouse\Management\Models
| Name | Type | Description |
|---|---|---|
id |
The id of the storage location. |
|
warehouseId |
The id of the warehouse the storage location belongs to. |
|
rackId |
The id of the rack the storage location belongs to. |
|
shelfId |
The id of the shelf the storage location belongs to. |
|
name |
The name of the storage location. |
|
type |
The type of the storage location. Valid strings are: 'small', 'medium', 'large', 'europallet'. |
|
position |
The position of the storage location. |
|
warehouse |
The warehouse this storage location belongs to. |
|
rack |
The rack this storage location belongs to. |
|
shelf |
The shelf this storage location belongs to. |
Methods
public toArray()Returns this model as an array.