Skip to main content
Version: 3.x

ShippingMethodType

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

type ShippingMethodType 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
name: String!
description: JSONString
type: ShippingMethodTypeEnum
translation(languageCode: LanguageCodeEnum!): ShippingMethodTranslation
channelListings: [ShippingMethodChannelListing!]
maximumOrderPrice: Money
minimumOrderPrice: Money
postalCodeRules: [ShippingMethodPostalCodeRule!]
excludedProducts(
before: String
after: String
first: Int
last: Int
): ProductCountableConnection
minimumOrderWeight: Weight
maximumOrderWeight: Weight
maximumDeliveryDays: Int
minimumDeliveryDays: Int
}

Fields

id (ID!)

Shipping method ID.

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.

name (String!)

Shipping method name.

description (JSONString)

Shipping method description.

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

type (ShippingMethodTypeEnum)

Type of the shipping method.

translation (ShippingMethodTranslation)

Returns translated shipping method fields for the given language code.

A language code to return the translation for shipping method.

channelListings ([ShippingMethodChannelListing!])

List of channels available for the method.

Requires one of the following permissions: MANAGE_SHIPPING.

maximumOrderPrice (Money)

The price of the cheapest variant (including discounts).

minimumOrderPrice (Money)

The price of the cheapest variant (including discounts).

postalCodeRules ([ShippingMethodPostalCodeRule!])

Postal code ranges rule of exclusion or inclusion of the shipping method.

excludedProducts (ProductCountableConnection)

List of excluded products for the shipping method.

Requires one of the following permissions: MANAGE_SHIPPING.

Return the elements in the list that come before the specified cursor.

Return the elements in the list that come after the specified cursor.

Return the first n elements from the list.

Return the last n elements from the list.

minimumOrderWeight (Weight)

Minimum order weight to use this shipping method.

maximumOrderWeight (Weight)

Maximum order weight to use this shipping method.

maximumDeliveryDays (Int)

Maximum number of days for delivery.

minimumDeliveryDays (Int)

Minimal number of days for delivery.

Interfaces

Node

An object with an ID

ObjectWithMetadata