Skip to main content

ShippingMethod Object

Shipping methods that can be used as means of shipping for orders and checkouts.

type ShippingMethod 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
  type: ShippingMethodTypeEnum @deprecated
  name: String!
  description: JSONString
  maximumDeliveryDays: Int
  minimumDeliveryDays: Int
  maximumOrderWeight: Weight @deprecated
  minimumOrderWeight: Weight @deprecated
  translation(
    languageCode: LanguageCodeEnum!
  ): ShippingMethodTranslation
  price: Money!
  maximumOrderPrice: Money @deprecated
  minimumOrderPrice: Money @deprecated
  active: Boolean!
  message: String
}

Fields​

id ● ID!​

Unique ID of ShippingMethod available for Order.

privateMetadata ● [MetadataItem!]!​

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

privateMetafield ● String​

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

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 ● [String!]​

metadata ● [MetadataItem!]!​

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

metafield ● String​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

metafields ● Metadata​

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

keys ● [String!]​

name ● String!​

Shipping method name.

description ● JSONString​

Shipping method description.

Rich text format. For reference see https://editorjs.io/

maximumDeliveryDays ● Int​

Maximum delivery days for this shipping method.

minimumDeliveryDays ● Int​

Minimum delivery days for this shipping method.

translation ● ShippingMethodTranslation​

Returns translated shipping method fields for the given language code.

languageCode ● LanguageCodeEnum!​

A language code to return the translation for shipping method.

price ● Money!​

The price of selected shipping method.

active ● Boolean!​

Describes if this shipping method is active and can be selected.

message ● String​

Message connected to this shipping method.

Show deprecated

Interfaces​

Node​

An object with an ID

ObjectWithMetadata​

Member Of​

Checkout object ● CheckoutFilterShippingMethods object ● Delivery object ● Order object ● OrderFilterShippingMethods object ● ShippingListMethodsForCheckout object ● ShippingMethodsPerCountry object ● Shop object

Implemented By​

DeliveryMethod union