Skip to main content

ShippingZone Object

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.

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
}

Fields​

id ● ID!​

The ID of shipping zone.

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!​

Shipping zone name.

default ● Boolean!​

Indicates if the shipping zone is default one.

priceRange ● MoneyRange​

Lowest and highest prices for the shipping.

countries ● [CountryDisplay!]!​

List of countries available for the method.

shippingMethods ● [ShippingMethodType!]​

List of shipping methods available for orders shipped to countries within this shipping zone.

warehouses ● [Warehouse!]!​

List of warehouses for shipping zone.

channels ● [Channel!]!​

List of channels for shipping zone.

description ● String​

Description of a shipping zone.

Interfaces​

Node​

An object with an ID

ObjectWithMetadata​

Returned By​

shippingZone query

Member Of​

ShippingPriceCreate object ● ShippingPriceCreated object ● ShippingPriceDelete object ● ShippingPriceDeleted object ● ShippingPriceUpdate object ● ShippingPriceUpdated object ● ShippingZoneCountableEdge object ● ShippingZoneCreate object ● ShippingZoneCreated object ● ShippingZoneDelete object ● ShippingZoneDeleted object ● ShippingZoneMetadataUpdated object ● ShippingZoneUpdate object ● ShippingZoneUpdated object