Skip to main content

shippingZone Query

Look up a shipping zone by ID.

Requires the MANAGE_SHIPPINGpermission.
shippingZone(
  id: ID!
  channel: String
): ShippingZone
Details
type ShippingZone 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!
  default: Boolean!
  priceRange: MoneyRange
  countries: [CountryDisplay!]!
  shippingMethods: [ShippingMethodType!]
  warehouses: [Warehouse!]!
  channels: [Channel!]!
  description: String
}

Arguments​

id ● ID!​

ID of the shipping zone.

channel ● String​

Slug of a channel for which the data should be returned.

Type​

ShippingZone​

Represents a shipping zone in the shop. Zones are the concept used only for grouping shipping methods in the dashboard, and are never exposed to the customers directly.