Skip to main content

Warehouse

Warehouse facility for inventory storage and logistics operations.

Represents a physical or virtual warehouse location used for storing inventory, processing orders, and managing logistics operations. Includes operational settings, business hours, and address information.

type Warehouse {
  id: ID!
  name: String!
  description: String!
  notes: String!
  isActive: Boolean!
  isStore: Boolean!
  isPickupLocation: Boolean!
  shopId: Int
  addressId: Int
  businessHours: [BusinessHours!]!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  address: WarehouseAddress
}

Fields​

Warehouse.id ● ID! non-null scalar​

Unique identifier for the warehouse.

Primary key used to reference this warehouse throughout the system and for all warehouse-related operations.

Warehouse.name ● String! non-null scalar​

Warehouse name for identification and display.

Human-readable name used to identify the warehouse in user interfaces, reports, and operational documents. Maximum 255 characters.

Warehouse.description ● String! non-null scalar​

Detailed description of the warehouse facility.

Comprehensive description providing additional context about the warehouse's purpose, capabilities, or special characteristics. Maximum 255 characters.

Warehouse.notes ● String! non-null scalar​

Internal notes and operational information.

Free-form text for storing internal notes, special instructions, or operational details about the warehouse. Not visible to external users. Maximum 255 characters.

Warehouse.isActive ● Boolean! non-null scalar​

Operational status of the warehouse.

Indicates whether the warehouse is currently active and available for operations. Inactive warehouses are excluded from inventory allocation and order fulfillment.

Warehouse.isStore ● Boolean! non-null scalar​

Store designation for customer-facing operations.

Indicates whether this warehouse also functions as a retail store location, enabling customer visits, in-store pickup, and retail operations.

Warehouse.isPickupLocation ● Boolean! non-null scalar​

Customer pickup location availability.

Indicates whether customers can collect their orders from this warehouse location, enabling click-and-collect and pickup services.

Warehouse.shopId ● Int scalar​

Associated shop identifier for retail operations.

References the shop configuration when this warehouse serves as a retail location, linking warehouse operations to specific shop settings and branding.

Warehouse.addressId ● Int scalar​

Primary address identifier for the warehouse.

References the main address record containing location details, contact information, and shipping address for this warehouse facility.

Warehouse.businessHours ● [BusinessHours!]! non-null object​

Operating hours for each day of the week.

Defines when the warehouse is operational for receiving, processing, and shipping orders. Used for scheduling operations and customer communication about availability.

Warehouse.createdAt ● DateTime! non-null scalar​

Warehouse creation timestamp.

Date and time when this warehouse was initially created in the system, used for auditing and operational history tracking.

Warehouse.lastModifiedAt ● DateTime! non-null scalar​

Last modification timestamp.

Date and time when any warehouse information was last updated, used for change tracking and synchronization purposes.

Warehouse.address ● WarehouseAddress object​

Complete address information for the warehouse.

Detailed address record including street address, city, postal code, country, and contact information for the warehouse facility.

Returned By​

warehouse query ● warehouseCreate mutation ● warehouseDelete mutation ● warehouseUpdate mutation

Member Of​

Carrier object ● CartPostageData object ● InventoryResponse object ● OrderPostageData object ● TenderPostage object ● WarehousesResponse object