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!]!
  metadata: [MetadataItem!]!
  name: String!
  seller: Seller!
  warehouses: [Warehouse!]!
  priceRange: MoneyRange!
  countries: [CountryDisplay!]!
  shippingMethods: [ShippingMethod!]!
  countryAreas: [ShippingZoneCountryArea!]!
}

Fields

ShippingZone.id ● ID! non-null scalar

The ID of the object

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

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

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

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

ShippingZone.name ● String! non-null scalar

ShippingZone.seller ● Seller! non-null object

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

List of warehouses for shipping zone.

ShippingZone.priceRange ● MoneyRange! non-null object

Lowest and highest prices for the shipping.

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

List of countries available for the method.

ShippingZone.shippingMethods ● [ShippingMethod!]! non-null object

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

ShippingZone.countryAreas ● [ShippingZoneCountryArea!]! non-null object

List of country areas this shipping zone is limited to.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Returned By

shippingZone query

Member Of

ShippingPriceCreate object ● ShippingPriceDelete object ● ShippingPriceUpdate object ● ShippingZoneCountableEdge object ● ShippingZoneCreate object ● ShippingZoneDelete object ● ShippingZoneUpdate object