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
}Interfaces
Fields
id
id · ID!
The ID of shipping zone.
privateMetadata
privateMetadata · [MetadataItem!]!
List of private metadata items. Requires staff permissions to access.
privateMetafield
privateMetafield · String
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
key
key · String!
privateMetafields
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
keys · [String!]
metadata
metadata · [MetadataItem!]!
List of public metadata items. Can be accessed without permissions.
metafield
metafield · String
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
key
key · String!
metafields
metafields · Metadata
Public metadata. Use keys to control which fields you want to include. The default is to include everything.
keys
keys · [String!]
name
name · String!
Shipping zone name.
default
default · Boolean!
Indicates if the shipping zone is default one.
priceRange
priceRange · MoneyRange
Lowest and highest prices for the shipping.
countries
countries · [CountryDisplay!]!
List of countries available for the method.
shippingMethods
shippingMethods · [ShippingMethodType!]
List of shipping methods available for orders shipped to countries within this shipping zone.
warehouses
warehouses · [Warehouse!]!
List of warehouses for shipping zone.
channels
channels · [Channel!]!
List of channels for shipping zone.
description
description · String
Description of a shipping zone.
Used by
- ShippingPriceCreate (objects)
- ShippingPriceCreated (objects)
- ShippingPriceDelete (objects)
- ShippingPriceDeleted (objects)
- ShippingPriceUpdate (objects)
- ShippingPriceUpdated (objects)
- ShippingZoneCountableEdge (objects)
- ShippingZoneCreate (objects)
- ShippingZoneCreated (objects)
- ShippingZoneDelete (objects)
- ShippingZoneDeleted (objects)
- ShippingZoneMetadataUpdated (objects)
- ShippingZoneUpdate (objects)
- ShippingZoneUpdated (objects)
- shippingZone (queries)
Schema: Saleor 3.23.43. Download SDL.