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
}

Interfaces

Node, ObjectWithMetadata

Fields

id

id · ID!

Unique ID of ShippingMethod available for Order.

privateMetadata

privateMetadata · [MetadataItem!]!

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

privateMetafield

privateMetafield · String

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

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

privateMetafields

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

keys · [String!]

metadata

metadata · [MetadataItem!]!

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

metafield

metafield · String

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

metafields

metafields · Metadata

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

keys

keys · [String!]

type

type · ShippingMethodTypeEnum

Type of the shipping method.

name

name · String!

Shipping method name.

description

description · JSONString

Shipping method description.

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

maximumDeliveryDays

maximumDeliveryDays · Int

Maximum delivery days for this shipping method.

minimumDeliveryDays

minimumDeliveryDays · Int

Minimum delivery days for this shipping method.

maximumOrderWeight

maximumOrderWeight · Weight

Maximum order weight for this shipping method.

minimumOrderWeight

minimumOrderWeight · Weight

Minimum order weight for this shipping method.

translation

translation · ShippingMethodTranslation

Returns translated shipping method fields for the given language code.

languageCode

languageCode · LanguageCodeEnum!

A language code to return the translation for shipping method.

price

price · Money!

The price of selected shipping method.

maximumOrderPrice

maximumOrderPrice · Money

Maximum order price for this shipping method.

minimumOrderPrice

minimumOrderPrice · Money

Minimal order price for this shipping method.

active

active · Boolean!

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

message

message · String

Message connected to this shipping method.

Used by

• Checkout (objects)
• CheckoutFilterShippingMethods (objects)
• ShippingListMethodsForCheckout (objects)
• Delivery (objects)
• Shop (objects)
• DeliveryMethod (unions)
• Order (objects)
• OrderFilterShippingMethods (objects)
• ShippingMethodsPerCountry (objects)

Schema: Saleor 3.23.43. Download SDL.