Warehouse
A physical or logical place where stock can live. Warehouses contain bin locations and aggregate stock records used by inbound, outbound and availability computations.
type Warehouse implements Node {
id: ID!
code: String!
name: String!
isStockAvailableForSale: Boolean!
pickingPosition: Int
timezone: String
status: WarehouseStatus
binLocations(
first: Int = 10
after: String
filter: BinLocationFilterInput
): BinLocationConnection
stocks(
first: Int = 10
after: String
filter: StockFilterInput
): StockConnection
warehouseStocks(
first: Int = 10
after: String
filter: WarehouseStockFilterInput
): WarehouseStockConnection
productWarehouseConfigurations(
first: Int = 10
after: String
filter: ProductWarehouseConfigurationFilterInput
): ProductWarehouseConfigurationConnection
}
Fields
Warehouse.id ● ID! non-null scalar
Global identifier for this entity.
Warehouse.code ● String! non-null scalar
Short, human-readable warehouse code (e.g. HQ, DE-01). Unique across the shop.
Warehouse.name ● String! non-null scalar
Display name shown in admin grids and pick lists.
Warehouse.isStockAvailableForSale ● Boolean! non-null scalar
When true, stock in this warehouse counts towards availability. Set to false for staging, quarantine or supplier-consignment warehouses.
Warehouse.pickingPosition ● Int scalar
Optional ordering hint used when generating pick routes across multiple warehouses. Lower numbers are picked first.
Warehouse.timezone ● String scalar
IANA timezone identifier (e.g. Europe/Berlin) used to interpret cut-off times for picking and dispatch.
Warehouse.status ● WarehouseStatus enum
Lifecycle state of the warehouse — see the WarehouseStatus enum for the meaning of each value.
Warehouse.binLocations ● BinLocationConnection object
Warehouse.binLocations.first ● Int scalar
Warehouse.binLocations.after ● String scalar
Warehouse.binLocations.filter ● BinLocationFilterInput input
Warehouse.stocks ● StockConnection object
Warehouse.stocks.first ● Int scalar
Warehouse.stocks.after ● String scalar
Warehouse.stocks.filter ● StockFilterInput input
Warehouse.warehouseStocks ● WarehouseStockConnection object
Warehouse.warehouseStocks.first ● Int scalar
Warehouse.warehouseStocks.after ● String scalar
Warehouse.warehouseStocks.filter ● WarehouseStockFilterInput input
Warehouse.productWarehouseConfigurations ● ProductWarehouseConfigurationConnection object
Warehouse.productWarehouseConfigurations.first ● Int scalar
Warehouse.productWarehouseConfigurations.after ● String scalar
Warehouse.productWarehouseConfigurations.filter ● ProductWarehouseConfigurationFilterInput input
Interfaces
Node interface
Any entity that can be loaded by its global id through the node(id: ID!) query.
Returned By
createWarehouse mutation ● warehouse query
Member Of
BinLocation object ● GoodsReceipt object ● ProductWarehouseConfiguration object ● Stock object ● SupplierOrder object ● WarehouseEdge object ● WarehouseStock object