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
}
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.
key ● String!
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 ● [String!]
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.
key ● String!
metafields ● Metadata
Public metadata. Use keys to control which fields you want to include. The default is to include everything.
keys ● [String!]
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.
languageCode ● LanguageCodeEnum!
A language code to return the translation for shipping method.
channelListings ● [ShippingMethodChannelListing!]
List of channels available for the method.
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.
before ● String
Return the elements in the list that come before the specified cursor.
after ● String
Return the elements in the list that come after the specified cursor.
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 ● 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 ● 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.
taxClass ● TaxClass
Tax class assigned to this shipping method.
Interfaces
Node
An object with an ID
ObjectWithMetadata
Member Of
ShippingMethodChannelListingUpdate object ● ShippingMethodTranslatableContent object ● ShippingPriceCreate object ● ShippingPriceCreated object ● ShippingPriceDelete object ● ShippingPriceDeleted object ● ShippingPriceExcludeProducts object ● ShippingPriceRemoveProductFromExclude object ● ShippingPriceTranslate object ● ShippingPriceUpdate object ● ShippingPriceUpdated object ● ShippingZone object