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

id (ID!)

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.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

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.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

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.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

metafields (Metadata)

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

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

name (String!)

default (Boolean!)

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