Skip to content
Saleor
Esc
↑↓navigate↵open⌘Jpreview

Schema: Saleor 3.23.43Download SDLUpgrade guides

On this page

Warehouse Object

Represents warehouse.

type Warehouse implements Node & ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(key: String!): String
  privateMetafields(keys: [String!]): Metadata
  metadata: [MetadataItem!]!
  metafield(key: String!): String
  metafields(keys: [String!]): Metadata
  name: String!
  slug: String!
  email: String!
  isPrivate: Boolean!
  address: Address!
  companyName: String! @deprecated(reason: "Use `Address.companyName` instead.")
  clickAndCollectOption: WarehouseClickAndCollectOptionEnum!
  shippingZones(before: String, after: String, first: Int, last: Int): ShippingZoneCountableConnection!
  stocks(before: String, after: String, first: Int, last: Int): StockCountableConnection
  externalReference: String
}

Interfaces

Node, ObjectWithMetadata

Fields

id

id · ID!

The ID of the warehouse.

privateMetadata

privateMetadata · [MetadataItem!]!

List of private metadata items. Requires staff permissions to access.

privateMetafield

privateMetafield · String

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

privateMetafields

privateMetafields · Metadata

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

keys

keys · [String!]

metadata

metadata · [MetadataItem!]!

List of public metadata items. Can be accessed without permissions.

metafield

metafield · String

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

metafields

metafields · Metadata

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

keys

keys · [String!]

name

name · String!

Warehouse name.

slug

slug · String!

Warehouse slug.

email

email · String!

Warehouse email.

isPrivate

isPrivate · Boolean!

Determine if the warehouse is private.

address

address · Address!

Address of the warehouse.

companyName

companyName · String!

Warehouse company name.

clickAndCollectOption

clickAndCollectOption · WarehouseClickAndCollectOptionEnum!

Click and collect options: local, all or disabled.

shippingZones

shippingZones · ShippingZoneCountableConnection!

Shipping zones supported by the warehouse.

before

before · String

Return the elements in the list that come before the specified cursor.

after

after · String

Return the elements in the list that come after the specified cursor.

first

first · Int

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

last

last · Int

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

stocks

stocks · StockCountableConnection

Stocks that belong to this warehouse.

Added in Saleor 3.20
Requires one of the following permissions:MANAGE_PRODUCTSMANAGE_ORDERS

before

before · String

Return the elements in the list that come before the specified cursor.

after

after · String

Return the elements in the list that come after the specified cursor.

first

first · Int

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

last

last · Int

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

externalReference

externalReference · String

External ID of this warehouse.

Used by


Schema: Saleor 3.23.43. Download SDL.

Last updated on April 13, 2026

Was this page helpful?