Skip to main content

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

The ID of shipping zone.

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

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

ShippingZone.privateMetafield ● String scalar miscellaneous​

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

ShippingZone.privateMetafields ● Metadata scalar miscellaneous​

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

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

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

ShippingZone.metafield ● String scalar miscellaneous​

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

ShippingZone.metafields ● Metadata scalar miscellaneous​

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

ShippingZone.name ● String! non-null scalar miscellaneous​

Shipping zone name.

ShippingZone.default ● Boolean! non-null scalar miscellaneous​

Indicates if the shipping zone is default one.

ShippingZone.priceRange ● MoneyRange object miscellaneous​

Lowest and highest prices for the shipping.

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

List of countries available for the method.

ShippingZone.shippingMethods ● [ShippingMethodType!] list object shipping​

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

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

List of warehouses for shipping zone.

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

List of channels for shipping zone.

ShippingZone.description ● String scalar miscellaneous​

Description of a shipping zone.

Interfaces​

Node interface miscellaneous​

An object with an ID

ObjectWithMetadata interface miscellaneous​

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