Skip to main content

Warehouse

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!
  externalReference: String
}

Fields​

Warehouse.id ● ID! non-null scalar​

Warehouse.privateMetadata ● [MetadataItem!]! non-null object​

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

Warehouse.privateMetafield ● String scalar​

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

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
Warehouse.privateMetafield.key ● String! non-null scalar​

Warehouse.privateMetafields ● Metadata scalar​

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

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
Warehouse.privateMetafields.keys ● [String!] list scalar​

Warehouse.metadata ● [MetadataItem!]! non-null object​

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

Warehouse.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
Warehouse.metafield.key ● String! non-null scalar​

Warehouse.metafields ● Metadata scalar​

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

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
Warehouse.metafields.keys ● [String!] list scalar​

Warehouse.name ● String! non-null scalar​

Warehouse.slug ● String! non-null scalar​

Warehouse.email ● String! non-null scalar​

Warehouse.isPrivate ● Boolean! non-null scalar​

Warehouse.address ● Address! non-null object​

Warehouse.companyName ● String! deprecated non-null scalar​

DEPRECATED

This field will be removed in Saleor 4.0. Use Address.companyName instead.

Warehouse company name.

Warehouse.clickAndCollectOption ● WarehouseClickAndCollectOptionEnum! non-null enum​

Click and collect options: local, all or disabled.

Added in Saleor 3.1

Warehouse.shippingZones ● ShippingZoneCountableConnection! non-null object​

Warehouse.shippingZones.before ● String scalar​

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

Warehouse.shippingZones.after ● String scalar​

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

Warehouse.shippingZones.first ● Int scalar​

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

Warehouse.shippingZones.last ● Int scalar​

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

Warehouse.externalReference ● String scalar​

External ID of this warehouse.

Added in Saleor 3.10

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

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

Was this page helpful?