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
name: String!
description: JSONString
maximumDeliveryDays: Int
minimumDeliveryDays: Int
maximumOrderWeight: Weight
minimumOrderWeight: Weight
translation(languageCode: LanguageCodeEnum!): ShippingMethodTranslation
price: Money!
maximumOrderPrice: Money
minimumOrderPrice: Money
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.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

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.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

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.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

metafields (Metadata)

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

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

type (ShippingMethodTypeEnum)

Type of the shipping method.

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.

maximumOrderWeight (Weight)

Maximum order weight for this shipping method.

minimumOrderWeight (Weight)

Minimum order weight for this shipping method.

translation (ShippingMethodTranslation)

Returns translated shipping method fields for the given language code.

A language code to return the translation for shipping method.

price (Money!)

The price of selected shipping method.

maximumOrderPrice (Money)

Maximum order price for this shipping method.

minimumOrderPrice (Money)

Minimal order price for this shipping method.

active (Boolean!)

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

message (String)

Message connected to this shipping method.

Interfaces

Node

An object with an ID

ObjectWithMetadata