Skip to main content
Version: 3.x

ShippingMethod

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
  minimumOrderPrice: Money
  active: Boolean!
  message: String
}
Expand ▼

Fields​

ShippingMethod.id ● ID! non-null scalar​

Unique ID of ShippingMethod available for Order.

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

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

ShippingMethod.privateMetafield ● String scalar​

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

Tip: Use GraphQL aliases to fetch multiple keys.

ShippingMethod.privateMetafield.key ● String! non-null scalar​

ShippingMethod.privateMetafields ● Metadata scalar​

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

ShippingMethod.privateMetafields.keys ● [String!] list scalar​

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

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

ShippingMethod.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

ShippingMethod.metafield.key ● String! non-null scalar​

ShippingMethod.metafields ● Metadata scalar​

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

ShippingMethod.metafields.keys ● [String!] list scalar​

ShippingMethod.type ● ShippingMethodTypeEnum deprecated enum​

DEPRECATED

This field will be removed in Saleor 4.0.

Type of the shipping method.

ShippingMethod.name ● String! non-null scalar​

Shipping method name.

ShippingMethod.description ● JSONString scalar​

Shipping method description.

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

ShippingMethod.maximumDeliveryDays ● Int scalar​

Maximum delivery days for this shipping method.

ShippingMethod.minimumDeliveryDays ● Int scalar​

Minimum delivery days for this shipping method.

ShippingMethod.maximumOrderWeight ● Weight deprecated object​

DEPRECATED

This field will be removed in Saleor 4.0.

Maximum order weight for this shipping method.

ShippingMethod.minimumOrderWeight ● Weight deprecated object​

DEPRECATED

This field will be removed in Saleor 4.0.

Minimum order weight for this shipping method.

ShippingMethod.translation ● ShippingMethodTranslation object​

Returns translated shipping method fields for the given language code.

ShippingMethod.translation.languageCode ● LanguageCodeEnum! non-null enum​

A language code to return the translation for shipping method.

ShippingMethod.price ● Money! non-null object​

The price of selected shipping method.

ShippingMethod.maximumOrderPrice ● Money object​

Maximum order price for this shipping method.

ShippingMethod.minimumOrderPrice ● Money object​

Minimal order price for this shipping method.

ShippingMethod.active ● Boolean! non-null scalar​

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

ShippingMethod.message ● String scalar​

Message connected to this shipping method.

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

Member of​

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

Implemented by​

DeliveryMethod union

Was this page helpful?