ShippingZone

Represents a shipping zone for organizing shipping methods by region.

type ShippingZone implements Node, ObjectWithMetadata {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  name: String!
  seller: Seller
  countries: [CountryDisplay!]!
  shippingMethods: [ShippingMethod!]!
  warehouses: [Warehouse!]!
  countryAreas: [ShippingZoneCountryArea!]!
  priceRange: MoneyRange!
  default: Boolean!
}

Fields

ShippingZone.id ● ID! non-null scalar

The Globally Unique ID of this object

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

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

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

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

ShippingZone.name ● String! non-null scalar

Name of the shipping zone

ShippingZone.seller ● Seller object

The seller associated with this shipping zone

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 this zone

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

List of warehouses for shipping zone

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

List of country areas this shipping zone is limited to

ShippingZone.priceRange ● MoneyRange! non-null object

Lowest and highest prices for the shipping

ShippingZone.default ● Boolean! non-null scalar

Whether this is the default shipping zone

Interfaces

Node interface

An object with a Globally Unique ID

ObjectWithMetadata interface

An object that supports metadata.

Returned By

shippingZone query

Member Of

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