ShippingMethodType Object

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
  taxClass: TaxClass
}

Interfaces

Node, ObjectWithMetadata

Fields

id

id · ID!

Shipping method ID.

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!]

name

name · String!

Shipping method name.

description

description · JSONString

Shipping method description.

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

type

type · ShippingMethodTypeEnum

Type of the 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.

channelListings

channelListings · [ShippingMethodChannelListing!]

List of channels available for the method.

maximumOrderPrice

maximumOrderPrice · Money

The price of the cheapest variant (including discounts).

minimumOrderPrice

minimumOrderPrice · Money

The price of the cheapest variant (including discounts).

postalCodeRules

postalCodeRules · [ShippingMethodPostalCodeRule!]

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

excludedProducts

excludedProducts · ProductCountableConnection

List of excluded products for the shipping method.

before

before · String

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

after

after · String

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

first

first · Int

Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

last

last · Int

Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.

minimumOrderWeight

minimumOrderWeight · Weight

Minimum order weight to use this shipping method.

maximumOrderWeight

maximumOrderWeight · Weight

Maximum order weight to use this shipping method.

maximumDeliveryDays

maximumDeliveryDays · Int

Maximum number of days for delivery.

minimumDeliveryDays

minimumDeliveryDays · Int

Minimal number of days for delivery.

taxClass

taxClass · TaxClass

Tax class assigned to this shipping method.

Used by

• ShippingMethodChannelListingUpdate (objects)
• ShippingMethodTranslatableContent (objects)
• ShippingPriceCreate (objects)
• ShippingPriceCreated (objects)
• ShippingPriceDelete (objects)
• ShippingPriceDeleted (objects)
• ShippingPriceExcludeProducts (objects)
• ShippingPriceRemoveProductFromExclude (objects)
• ShippingPriceTranslate (objects)
• ShippingPriceUpdate (objects)
• ShippingPriceUpdated (objects)
• ShippingZone (objects)

Schema: Saleor 3.23.43. Download SDL.