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
  clickAndCollectOption: WarehouseClickAndCollectOptionEnum!
  shippingZones(
    before: String
    after: String
    first: Int
    last: Int
  ): ShippingZoneCountableConnection!
  stocks(
    before: String
    after: String
    first: Int
    last: Int
  ): StockCountableConnection
  externalReference: String
}

Fields

id ● ID!

The ID of the warehouse.

privateMetadata ● [MetadataItem!]!

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

privateMetafield ● String

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

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!

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 ● [String!]

metadata ● [MetadataItem!]!

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

metafield ● String

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!

metafields ● Metadata

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

keys ● [String!]

name ● String!

Warehouse name.

slug ● String!

Warehouse slug.

email ● String!

Warehouse email.

isPrivate ● Boolean!

Determine if the warehouse is private.

address ● Address!

Address of the warehouse.

clickAndCollectOption ● WarehouseClickAndCollectOptionEnum!

Click and collect options: local, all or disabled.

shippingZones ● ShippingZoneCountableConnection!

Shipping zones supported by the warehouse.

before ● String

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

after ● String

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

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 ● 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 ● StockCountableConnection

Stocks that belong to this warehouse.

Added in Saleor 3.20

Requires one of the following permissions: MANAGE_PRODUCTSMANAGE_ORDERS

before ● String

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

after ● String

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

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 ● 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 ● String

External ID of this warehouse.

Show deprecatedHide deprecated

companyName ● String!

DEPRECATED

Use Address.companyName instead.

Warehouse company name.

Interfaces

Node

An object with an ID

ObjectWithMetadata

Returned By

warehouse query

Member Of

Allocation object ● Channel object ● Checkout object ● Fulfillment object ● Order object ● OrderEvent object ● ProductVariantBackInStock object ● ProductVariantOutOfStock object ● ProductVariantStockUpdated object ● ShippingZone object ● Stock object ● WarehouseCountableEdge object ● WarehouseCreate object ● WarehouseCreated object ● WarehouseDelete object ● WarehouseDeleted object ● WarehouseMetadataUpdated object ● WarehouseShippingZoneAssign object ● WarehouseShippingZoneUnassign object ● WarehouseUpdate object ● WarehouseUpdated object

Implemented By

DeliveryMethod union