CartShippingMethod

Describes a cart shipping method, including type, title, pickup availability, address, fees, and additional information.

Type Definition


type CartShippingMethod {
  title: String
  type: String
  pickupAvailability: String
  pickupAddress: Address
  info: String
  description: String
  fee: Float
  price: Float
  netPrice: Float
  tax: Float
  rate: Float
  ratePercentage: Float
  metafields: [Metafield]!
  metafield: Metafield
}

Fields

Field	Type	Description
title	String	Returns the title.
type	String	Returns the type.
pickupAvailability	String	Returns the pickup availability as a string if it’s available.
pickupAddress	Address	Returns the pickup address.
info	String	Returns additional information about the shipping method.
description	String	Returns the description.
fee	Float	Returns the shipping fee in customer’s currency.
price	Float	Returns the shipping price in customer’s currency.
netPrice	Float	Returns the shipping price without tax in customer’s currency.
tax	Float	Returns the tax amount in customer’s currency.
rate	Float	Returns the tax rate in decimals.
ratePercentage	Float	Returns the tax rate.
metafields	[Metafield]!	Metafields stored on this resource.
metafield	Metafield	A single metafield by namespace and key.

Relationships

CartShippingMethod contains a reference to an Address object through the pickupAddress field, which represents the location where the customer can pick up their order. It also includes Metafield objects through the metafields and metafield fields, allowing for custom metadata to be stored and retrieved on the shipping method.

Example


{
  title
  type
  pickupAvailability
  pickupAddress {
    formatted
  }
  info
  description
  fee
  price
  netPrice
  tax
  rate
  ratePercentage
  metafields {
    namespace
    key
    value
  }
  metafield(namespace: "custom", key: "method_info") {
    value
  }
}

Implements

This type does not implement any interfaces.