Docs
Dashboard

ShippingMethod

Object

Represents a shipping method.

#

Fields


channels
ChannelConnection!

Gets a list of channels associated with the specified shipping zone.

description
String

The description of the shipping method.

id
ID!

The unique identifier for the shipping method.

metadata
[MetadataItem!]!

Gets the metadata associated with the shipping method.

name
String!

The name of the shipping method.

predicate
String

The predicate of the shipping method, which defines the conditions under which the shipping method is applicable.

Thor predicates are boolean expressions. Cart discounts and shipping rules evaluate against cart context; product discounts evaluate against price and product context. Cart predicate language and product predicate language.
rates
ShippingMethodRateConnection!

A list of shipping method rates associated with the shipping method.

shippingZones
ShippingZoneConnection!

A list of shipping zones associated with the shipping method.

sku
String

The SKU of the shipping method.

#

Queries


Retrieves a shipping method by its ID.

Retrieves a paginated list of shipping methods.

#

Mutations


Creates a new shipping method with the specified name and SKU.

Deletes a shipping method by its ID.

Adds a shipping method rate to an existing shipping method.

Deletes a shipping method rate from an existing shipping method by its ID.

Reorders rates within a shipping method.

Updates an existing shipping method with the specified ID.