ShippingMethod

Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers.

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

Fields

ShippingMethod.id ● ID! non-null scalar

The ID of the object

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

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

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

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

ShippingMethod.name ● String! non-null scalar

ShippingMethod.price ● Money object

ShippingMethod.minimumOrderPrice ● Money object

ShippingMethod.maximumOrderPrice ● Money object

ShippingMethod.minimumOrderWeight ● Weight object

ShippingMethod.maximumOrderWeight ● Weight object

ShippingMethod.type ● ShippingMethodTypeEnum enum

Type of the shipping method.

ShippingMethod.requiresSecondaryAddress ● Boolean scalar

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

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Member Of

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