Skip to main content
Version: 3.x

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.

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​

ShippingZone.id ● ID! non-null scalar​

The ID of shipping zone.

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

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

ShippingZone.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
ShippingZone.privateMetafield.key ● String! non-null scalar​

ShippingZone.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
ShippingZone.privateMetafields.keys ● [String!] list scalar​

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

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

ShippingZone.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
ShippingZone.metafield.key ● String! non-null scalar​

ShippingZone.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
ShippingZone.metafields.keys ● [String!] list scalar​

ShippingZone.name ● String! non-null scalar​

Shipping zone name.

ShippingZone.default ● Boolean! non-null scalar​

Indicates if the shipping zone is default one.

ShippingZone.priceRange ● MoneyRange object​

Lowest and highest prices for the shipping.

ShippingZone.countries ● [CountryDisplay!]! non-null object​

List of countries available for the method.

ShippingZone.shippingMethods ● [ShippingMethodType!] list object​

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

ShippingZone.warehouses ● [Warehouse!]! non-null object​

List of warehouses for shipping zone.

ShippingZone.channels ● [Channel!]! non-null object​

List of channels for shipping zone.

ShippingZone.description ● String scalar​

Description of a shipping zone.

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

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

Was this page helpful?