ShippingMethod

Represents a shipping method within a shipping zone.

type ShippingMethod implements Node, ObjectWithMetadata {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  name: String!
  type: ShippingMethodTypeEnum!
  currency: String!
  priceAmount: Decimal!
  price: Money!
  minimumOrderPrice: Money
  maximumOrderPrice: Money
  minimumOrderWeight: Weight
  maximumOrderWeight: Weight
  requiresSecondaryAddress: Boolean! @deprecated
}

Fields

ShippingMethod.id ● ID! non-null scalar

The Globally Unique ID of this object

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

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

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

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

ShippingMethod.name ● String! non-null scalar

Name of the shipping method

ShippingMethod.type ● ShippingMethodTypeEnum! non-null enum

Type of shipping method: price or weight

ShippingMethod.currency ● String! non-null scalar

Currency code

ShippingMethod.priceAmount ● Decimal! non-null scalar

Shipping price amount

ShippingMethod.price ● Money! non-null object

Shipping price

ShippingMethod.minimumOrderPrice ● Money object

Minimum order price for this method

ShippingMethod.maximumOrderPrice ● Money object

Maximum order price for this method

ShippingMethod.minimumOrderWeight ● Weight object

Minimum order weight for this method

ShippingMethod.maximumOrderWeight ● Weight object

Maximum order weight for this method

ShippingMethod.requiresSecondaryAddress ● Boolean! deprecated non-null scalar

DEPRECATED

This field will always return False and will be removed soon.

Deprecated: This field will always return False and will be removed soon.

Interfaces

Node interface

An object with a Globally Unique ID

ObjectWithMetadata interface

An object that supports metadata.

Member Of

Checkout object ● CheckoutSellerShipping object ● MultiSellerShippingMethod object ● NauticalOrder object ● Order object ● ShippingPriceCreate object ● ShippingPriceDelete object ● ShippingPriceUpdate object ● ShippingZone object