Skip to main content

Warehouse

A location where stock is held.

type Warehouse {
address: WarehouseAddress
capacity: Int
code: String!
contactEmail: String
contactPhone: String
createdAt: DateTime!
deletedAt: DateTime
deletedBy: String
enteredBy: String!
id: ID!
metadata: JSON!
name: String!
organizationId: String!
status: WarehouseStatus!
taxRegistrationNumber: String
type: String!
updatedAt: DateTime!
updatedBy: String!
zones: [Zone!]
}

Fields​

Warehouse.address ● WarehouseAddress object​

The address of the warehouse.

Warehouse.capacity ● Int scalar​

The storage capacity of the warehouse.

Warehouse.code ● String! non-null scalar​

The warehouse code, unique within the organization.

Warehouse.contactEmail ● String scalar​

The contact email address.

Warehouse.contactPhone ● String scalar​

The contact phone number.

Warehouse.createdAt ● DateTime! non-null scalar​

When the record was created.

Warehouse.deletedAt ● DateTime scalar​

When the record was deleted. Empty while the record is live.

Warehouse.deletedBy ● String scalar​

The ID of the user who deleted the record.

Warehouse.enteredBy ● String! non-null scalar​

The ID of the user who created the record.

Warehouse.id ● ID! non-null scalar​

The unique ID of this record.

Warehouse.metadata ● JSON! non-null scalar​

Additional data attached to the record, as JSON.

Warehouse.name ● String! non-null scalar​

The warehouse name.

Warehouse.organizationId ● String! non-null scalar​

The ID of the organization the record belongs to.

Warehouse.status ● WarehouseStatus! non-null enum​

Whether the warehouse is in use.

Warehouse.taxRegistrationNumber ● String scalar​

The tax registration number of this location. When blank, the organization's number is used on the documents the warehouse issues.

Warehouse.type ● String! non-null scalar​

The kind of warehouse, such as main, branch or distribution.

Warehouse.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

Warehouse.updatedBy ● String! non-null scalar​

The ID of the user who last changed the record.

Warehouse.zones ● [Zone!] list object​

The zones inside the warehouse.

Returned By​

createWarehouse mutation ● defaultWarehouse query ● removeWarehouse mutation ● updateWarehouse mutation ● warehouse query ● warehouses query

Member Of​

Inventory object ● ProductInventory object ● ProductReturn object ● Quote object ● QuoteItem object ● SalesOrder object ● SalesOrderItem object ● StockMovement object