Skip to main content

Anchor to Delivery Customization Function APIDelivery Customization Function API

A delivery customization enables you to rename, sort, and hide the delivery options available to customers during checkout. Examples of delivery options include shipping carriers, local delivery, or pickup options. To customize delivery options in checkout, you can only use the Delivery Customization Function API.

Shopify Functions enable you to customize Shopify's backend logic. The Delivery Customization API integrates this logic into the checkout flow.

Use the API to display unique delivery options to customers, with associated data such as buyer identity, delivery groups, delivery addresses, and cost.

Note

You can activate a maximum of 25 Delivery Customization Functions on each store.

Anchor to Use casesUse cases

  • Hide delivery options for certain products or customers.
  • Reorder delivery options according to user preference.
  • Hide delivery options for PO Box addresses.
  • Add messaging to delivery option titles.
Compatibility with Shopify surfaces
Supported  (4)
Partially supported  (1)
Unsupported  (8)
B2B
Cart
Checkout
Create Order API
Draft Order   (Admin)
Draft Order   (Checkout)
Order Edit   (Admin)
Order Edit   (Checkout)
POS
POS is only available when shipping to a store.
Shopify Admin
Storefront
Storefront Accelerated Checkout
Subscription   (Recurring Orders)
Was this section helpful?

Anchor to Getting startedGetting started

Scaffolding the Function using Shopify CLI will automatically configure your TOML file. You can alter the default configuration to customize the way your Function operates.

Tutorial Build a Delivery Customization Function
Was this section helpful?

Anchor to TargetsTargets

A target is an identifier in shopify.extension.toml that specifies where you're injecting code into Shopify Function APIs, or other parts of the Shopify platform. Each target is composed of three to four namespaces. The name begins with a broad Shopify context and ends with the behavior of the extensible element.

Anchor to Run targetRun target

purchase.delivery-customization.run

The run target renames, sorts, and hides delivery options that are available to customers at checkout, using Shopify data or hardcoded values. The target returns a list of operations to be applied to delivery options.

For example, you might use this to hide a "Same-Day Delivery" option for B2B customers.

Anchor to InputInput
OBJECT

The Input object is the complete GraphQL schema that your Function can query as input to customize delivery options. Your Function receives only the fields that you request in the input query. To optimize performance, we highly recommend that you request only the fields that your Function requires.

Anchor to cart cart
•
Cart!
non-null

The cart where the Function is running. A cart contains the merchandise that a customer intends to purchase and information about the customer, such as the customer's email address and phone number.

Anchor to attribute attribute
•
Attribute

The custom attributes associated with a cart to store additional information. Cart attributes allow you to collect specific information from customers on the Cart page, such as order notes, gift wrapping requests, or custom product details. Attributes are stored as key-value pairs.

Arguments

Anchor to key key
•
String

The key of the cart attribute to retrieve. For example, "gift_wrapping".

Fields

Anchor to key key
•
String!
non-null

The key or name of the attribute. For example, "customer_first_order".

Anchor to value value
•
String

The value of the attribute. For example, "true".

Anchor to buyerIdentity buyerIdentity
•
Buyer Identity

Information about the customer that's interacting with the cart. It includes details such as the customer's email and phone number, and the total amount of money the customer has spent in the store. This information helps personalize the checkout experience and ensures that accurate pricing and delivery options are displayed to customers.

Anchor to customer customer
•
Customer

The customer that's interacting with the cart. A customer is a buyer who has an account with the store.

Anchor to amountSpent amountSpent
•
Money V2!
non-null

The total amount that the customer has spent on orders. The amount is converted from the shop's currency to the currency of the cart using a market rate.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to displayName displayName
•
String!
non-null

The full name of the customer, based on the values for firstName and lastName. If firstName and lastName aren't specified, then the value is the customer's email address. If the email address isn't specified, then the value is the customer's phone number.

Anchor to email email
•
String

The customer's email address.

Anchor to firstName firstName
•
String

The customer's first name.

Anchor to hasAnyTag hasAnyTag
•
Boolean!
non-null

Whether the customer is associated with any of the specified tags. The customer must have at least one tag from the list to return true.

Anchor to hasTags hasTags
•
[Has Tag Response!]!
non-null

Whether the customer is associated with the specified tags. The customer must have all of the tags in the list to return true.

Arguments

Anchor to tags tags
•
[String!]!
required Default:[]

A comma-separated list of searchable keywords that are associated with the customer. For example, "VIP, Gold" returns customers with both the VIP and Gold tags.

Fields

Anchor to hasTag hasTag
•
Boolean!
non-null

Whether the Shopify resource has the tag.

Anchor to tag tag
•
String!
non-null

A searchable keyword that's associated with a Shopify resource, such as a product or customer. For example, a merchant might apply the sports and summer tags to products that are associated with sportswear for summer.

Anchor to id id
•
ID!
non-null

A globally-unique ID for the customer.

Anchor to lastName lastName
•
String

The customer's last name.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to numberOfOrders numberOfOrders
•
Int!
non-null

The total number of orders that the customer has made at the store.

Anchor to email email
•
String

The email address of the customer that's interacting with the cart.

Anchor to isAuthenticated isAuthenticated
•
Boolean!
non-null

Whether the customer is authenticated through their customer account. If the customer is authenticated, then the customer field returns the customer's information. If the customer isn't authenticated, then the customer field returns null.

Anchor to phone phone
•
String

The phone number of the customer that's interacting with the cart.

Anchor to purchasingCompany purchasingCompany
•
Purchasing Company

The company of a B2B customer that's interacting with the cart. Used to manage and track purchases made by businesses rather than individual customers.

Anchor to company company
•
Company!
non-null

The company associated to the order or draft order.

Anchor to createdAt createdAt
•
Date Time!
non-null

The date and time (ISO 8601 format) at which the company was created in Shopify.

Anchor to externalId externalId
•
String

A unique externally-supplied ID for the company.

Anchor to id id
•
ID!
non-null

The ID of the company.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to name name
•
String!
non-null

The name of the company.

Anchor to updatedAt updatedAt
•
Date Time!
non-null

The date and time (ISO 8601 format) at which the company was last modified.

Anchor to contact contact
•
Company Contact

The company contact associated to the order or draft order.

Anchor to createdAt createdAt
•
Date Time!
non-null

The date and time (ISO 8601 format) at which the company contact was created in Shopify.

Anchor to id id
•
ID!
non-null

The ID of the company.

Anchor to locale locale
•
String

The company contact's locale (language).

Anchor to title title
•
String

The company contact's job title.

Anchor to updatedAt updatedAt
•
Date Time!
non-null

The date and time (ISO 8601 format) at which the company contact was last modified.

Anchor to location location
•
Company Location!
non-null

The company location associated to the order or draft order.

Anchor to createdAt createdAt
•
Date Time!
non-null

The date and time (ISO 8601 format) at which the company location was created in Shopify.

Anchor to externalId externalId
•
String

A unique externally-supplied ID for the company.

Anchor to id id
•
ID!
non-null

The ID of the company.

Anchor to locale locale
•
String

The preferred locale of the company location.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to name name
•
String!
non-null

The name of the company location.

Anchor to updatedAt updatedAt
•
Date Time!
non-null

The date and time (ISO 8601 format) at which the company location was last modified.

Anchor to cost cost
•
Cart Cost!
non-null

A breakdown of the costs that the customer will pay at checkout. It includes the total amount, the subtotal before taxes and duties, the tax amount, and duty charges.

Anchor to subtotalAmount subtotalAmount
•
Money V2!
non-null

The amount for the customer to pay at checkout, excluding taxes and discounts.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to totalAmount totalAmount
•
Money V2!
non-null

The total amount for the customer to pay at checkout.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to totalDutyAmount totalDutyAmount
•
Money V2

The duty charges for a customer to pay at checkout.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to totalTaxAmount totalTaxAmount
•
Money V2

The total tax amount for the customer to pay at checkout.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to deliverableLines deliverableLines
•
[Deliverable Cart Line!]!
non-null

The items in a cart that are eligible for fulfillment and can be delivered to the customer.

Anchor to attribute attribute
•
Attribute

The custom attributes associated with a cart to store additional information. Cart attributes allow you to collect specific information from customers on the Cart page, such as order notes, gift wrapping requests, or custom product details. Attributes are stored as key-value pairs.

Cart line attributes are equivalent to the line_item object in Liquid.

Arguments

Anchor to key key
•
String

The key of the cart attribute to retrieve. For example, "gift_wrapping".

Fields

Anchor to key key
•
String!
non-null

The key or name of the attribute. For example, "customer_first_order".

Anchor to value value
•
String

The value of the attribute. For example, "true".

Anchor to id id
•
ID!
non-null

The ID of the cart line.

Anchor to merchandise merchandise
•
Merchandise!
non-null

The item that the customer intends to purchase.

Anchor to CustomProduct
Custom Product
• OBJECT

A custom product represents a product that doesn't map to Shopify's standard product categories. For example, you can use a custom product to manage gift cards, shipping requirements, localized product information, or weight measurements and conversions.

Anchor to isGiftCard isGiftCard
•
Boolean!
non-null

Whether the merchandise is a gift card.

Anchor to requiresShipping requiresShipping
•
Boolean!
non-null

Whether the item needs to be shipped to the customer. For example, a digital gift card doesn't need to be shipped, but a t-shirt does need to be shipped.

Anchor to title title
•
String!
non-null

The localized name for the product that displays to customers. The title is used to construct the product's handle, which is a unique, human-readable string of the product's title. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

Anchor to weight weight
•
Float

The product variant's weight, in the system of measurement set in the weightUnit field.

Anchor to weightUnit weightUnit
•
Weight Unit!
non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS
Anchor to ProductVariant
Product Variant
• OBJECT

A specific version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.

Anchor to id id
•
ID!
non-null

A globally-unique ID for the product variant.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to product product
•
Product!
non-null

The product associated with the product variant. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another. The product associated with the product variant would be the t-shirt itself.

Anchor to handle handle
•
Handle!
non-null

A unique, human-readable string of the product's title. A handle can contain letters, hyphens (-), and numbers, but not spaces. The handle is used in the online store URL for the product. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

Anchor to hasAnyTag hasAnyTag
•
Boolean!
non-null

Whether the product is associated with any of the specified tags. The product must have at least one tag from the list to return true.

Anchor to hasTags hasTags
•
[Has Tag Response!]!
non-null

Whether the product is associated with the specified tags. The product must have all of the tags in the list to return true.

Arguments

Anchor to tags tags
•
[String!]!
required Default:[]

A comma-separated list of searchable keywords that are associated with the product. For example, "sports, summer" returns products with both the sports and summer tags.

Fields

Anchor to hasTag hasTag
•
Boolean!
non-null

Whether the Shopify resource has the tag.

Anchor to tag tag
•
String!
non-null

A searchable keyword that's associated with a Shopify resource, such as a product or customer. For example, a merchant might apply the sports and summer tags to products that are associated with sportswear for summer.

Anchor to id id
•
ID!
non-null

A globally-unique ID for the product.

Anchor to inAnyCollection inAnyCollection
•
Boolean!
non-null

Whether the product is in any of the specified collections. The product must be in at least one collection from the list to return true.

A collection is a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire and accessories.

Anchor to inCollections inCollections
•
[Collection Membership!]!
non-null

Whether the product is in the specified collections. The product must be in all of the collections in the list to return true.

A collection is a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire and accessories.

Arguments

Anchor to ids ids
•
[ID!]!
required Default:[]

A comma-separated list of globally-unique collection IDs that are associated with the product. For example, gid://shopify/Collection/123, gid://shopify/Collection/456.

Fields

Anchor to collectionId collectionId
•
ID!
non-null

A globally-unique ID for the collection.

Anchor to isMember isMember
•
Boolean!
non-null

Whether the product is in the specified collection.

Anchor to isGiftCard isGiftCard
•
Boolean!
non-null

Whether the product is a gift card.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to productType productType
•
String

A custom category for a product. Product types allow merchants to define categories other than the ones available in Shopify's standard product categories.

Anchor to title title
•
String!
non-null

The localized name for the product that displays to customers. The title is used to construct the product's handle, which is a unique, human-readable string of the product's title. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

Anchor to vendor vendor
•
String

The name of the product's vendor.

Anchor to requiresShipping requiresShipping
•
Boolean!
non-null

Whether the item needs to be shipped to the customer. For example, a digital gift card doesn't need to be shipped, but a t-shirt does need to be shipped.

Anchor to sku sku
•
String

A case-sensitive identifier for the product variant in the merchant's store. For example, "BBC-1". A product variant must have a SKU to be connected to a fulfillment service.

Anchor to title title
•
String

The localized name for the product variant that displays to customers.

Anchor to weight weight
•
Float

The product variant's weight, in the system of measurement set in the weightUnit field.

Anchor to weightUnit weightUnit
•
Weight Unit!
non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS
Anchor to quantity quantity
•
Int!
non-null

The quantity of the item that the customer intends to purchase.

Anchor to deliveryGroups deliveryGroups
•
[Cart Delivery Group!]!
non-null

A collection of items that are grouped by shared delivery characteristics. Delivery groups streamline fulfillment by organizing items that can be shipped together, based on the customer's shipping address. For example, if a customer orders a t-shirt and a pair of shoes that can be shipped together, then the items are included in the same delivery group.

In the Order Discount and Product Discount legacy APIs, the cart.deliveryGroups input is always an empty array. This means you can't access delivery groups when creating Order Discount or Product Discount Functions. If you need to apply discounts to shipping costs, then use the Discount Function API instead.

Anchor to cartLines cartLines
•
[Cart Line!]!
non-null

Information about items in a cart that a customer intends to purchase. A cart line is an entry in the customer's cart that represents a single unit of a product variant. For example, if a customer adds two different sizes of the same t-shirt to their cart, then each size is represented as a separate cart line.

Anchor to attribute attribute
•
Attribute

The custom attributes associated with a cart to store additional information. Cart attributes allow you to collect specific information from customers on the Cart page, such as order notes, gift wrapping requests, or custom product details. Attributes are stored as key-value pairs.

Cart line attributes are equivalent to the line_item object in Liquid.

Arguments

Anchor to key key
•
String

The key of the cart attribute to retrieve. For example, "gift_wrapping".

Fields

Anchor to key key
•
String!
non-null

The key or name of the attribute. For example, "customer_first_order".

Anchor to value value
•
String

The value of the attribute. For example, "true".

Anchor to cost cost
•
Cart Line Cost!
non-null

The cost of an item in a cart that the customer intends to purchase. Cart lines are entries in the customer's cart that represent a single unit of a product variant. For example, if a customer adds two different sizes of the same t-shirt to their cart, then each size is represented as a separate cart line.

Anchor to amountPerQuantity amountPerQuantity
•
Money V2!
non-null

The cost of a single unit. For example, if a customer purchases three units of a product that are priced at $10 each, then the amountPerQuantity is $10.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to compareAtAmountPerQuantity compareAtAmountPerQuantity
•
Money V2

The cost of a single unit before any discounts are applied. This field is used to calculate and display savings for customers. For example, if a product's compareAtAmountPerQuantity is $25 and its current price is $20, then the customer sees a $5 discount. This value can change based on the buyer's identity and is null when the value is hidden from buyers.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to subtotalAmount subtotalAmount
•
Money V2!
non-null

The cost of items in the cart before applying any discounts to certain items. This amount serves as the starting point for calculating any potential savings customers might receive through promotions or discounts.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to totalAmount totalAmount
•
Money V2!
non-null

The total cost of items in a cart.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to id id
•
ID!
non-null

The ID of the cart line.

Anchor to merchandise merchandise
•
Merchandise!
non-null

The item that the customer intends to purchase.

Anchor to CustomProduct
Custom Product
• OBJECT

A custom product represents a product that doesn't map to Shopify's standard product categories. For example, you can use a custom product to manage gift cards, shipping requirements, localized product information, or weight measurements and conversions.

Anchor to isGiftCard isGiftCard
•
Boolean!
non-null

Whether the merchandise is a gift card.

Anchor to requiresShipping requiresShipping
•
Boolean!
non-null

Whether the item needs to be shipped to the customer. For example, a digital gift card doesn't need to be shipped, but a t-shirt does need to be shipped.

Anchor to title title
•
String!
non-null

The localized name for the product that displays to customers. The title is used to construct the product's handle, which is a unique, human-readable string of the product's title. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

Anchor to weight weight
•
Float

The product variant's weight, in the system of measurement set in the weightUnit field.

Anchor to weightUnit weightUnit
•
Weight Unit!
non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS
Anchor to ProductVariant
Product Variant
• OBJECT

A specific version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.

Anchor to id id
•
ID!
non-null

A globally-unique ID for the product variant.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to product product
•
Product!
non-null

The product associated with the product variant. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another. The product associated with the product variant would be the t-shirt itself.

Anchor to handle handle
•
Handle!
non-null

A unique, human-readable string of the product's title. A handle can contain letters, hyphens (-), and numbers, but not spaces. The handle is used in the online store URL for the product. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

Anchor to hasAnyTag hasAnyTag
•
Boolean!
non-null

Whether the product is associated with any of the specified tags. The product must have at least one tag from the list to return true.

Anchor to hasTags hasTags
•
[Has Tag Response!]!
non-null

Whether the product is associated with the specified tags. The product must have all of the tags in the list to return true.

Arguments

Anchor to tags tags
•
[String!]!
required Default:[]

A comma-separated list of searchable keywords that are associated with the product. For example, "sports, summer" returns products with both the sports and summer tags.

Fields

Anchor to hasTag hasTag
•
Boolean!
non-null

Whether the Shopify resource has the tag.

Anchor to tag tag
•
String!
non-null

A searchable keyword that's associated with a Shopify resource, such as a product or customer. For example, a merchant might apply the sports and summer tags to products that are associated with sportswear for summer.

Anchor to id id
•
ID!
non-null

A globally-unique ID for the product.

Anchor to inAnyCollection inAnyCollection
•
Boolean!
non-null

Whether the product is in any of the specified collections. The product must be in at least one collection from the list to return true.

A collection is a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire and accessories.

Anchor to inCollections inCollections
•
[Collection Membership!]!
non-null

Whether the product is in the specified collections. The product must be in all of the collections in the list to return true.

A collection is a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire and accessories.

Arguments

Anchor to ids ids
•
[ID!]!
required Default:[]

A comma-separated list of globally-unique collection IDs that are associated with the product. For example, gid://shopify/Collection/123, gid://shopify/Collection/456.

Fields

Anchor to collectionId collectionId
•
ID!
non-null

A globally-unique ID for the collection.

Anchor to isMember isMember
•
Boolean!
non-null

Whether the product is in the specified collection.

Anchor to isGiftCard isGiftCard
•
Boolean!
non-null

Whether the product is a gift card.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to productType productType
•
String

A custom category for a product. Product types allow merchants to define categories other than the ones available in Shopify's standard product categories.

Anchor to title title
•
String!
non-null

The localized name for the product that displays to customers. The title is used to construct the product's handle, which is a unique, human-readable string of the product's title. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

Anchor to vendor vendor
•
String

The name of the product's vendor.

Anchor to requiresShipping requiresShipping
•
Boolean!
non-null

Whether the item needs to be shipped to the customer. For example, a digital gift card doesn't need to be shipped, but a t-shirt does need to be shipped.

Anchor to sku sku
•
String

A case-sensitive identifier for the product variant in the merchant's store. For example, "BBC-1". A product variant must have a SKU to be connected to a fulfillment service.

Anchor to title title
•
String

The localized name for the product variant that displays to customers.

Anchor to weight weight
•
Float

The product variant's weight, in the system of measurement set in the weightUnit field.

Anchor to weightUnit weightUnit
•
Weight Unit!
non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS
Anchor to quantity quantity
•
Int!
non-null

The quantity of the item that the customer intends to purchase.

Anchor to sellingPlanAllocation sellingPlanAllocation
•
Selling Plan Allocation

The selling plan associated with the cart line, including information about how a product variant can be sold and purchased.

Anchor to priceAdjustments priceAdjustments
•
[Selling Plan Allocation Price Adjustment!]!
non-null

A list of price adjustments, with a maximum of two. When there are two, the first price adjustment goes into effect at the time of purchase, while the second one starts after a certain number of orders. A price adjustment represents how a selling plan affects pricing when a variant is purchased with a selling plan. Prices display in the customer's currency if the shop is configured for it.

Anchor to perDeliveryPrice perDeliveryPrice
•
Money V2!
non-null

The effective price for a single delivery. For example, for a prepaid subscription plan that includes 6 deliveries at the price of $48.00, the per delivery price is $8.00.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to price price
•
Money V2!
non-null

The price of the variant when it's purchased with a selling plan For example, for a prepaid subscription plan that includes 6 deliveries of $10.00 granola, where the customer gets 20% off, the price is 6 x $10.00 x 0.80 = $48.00.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to sellingPlan sellingPlan
•
Selling Plan!
non-null

A representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'.

Anchor to description description
•
String

The description of the selling plan.

Anchor to id id
•
ID!
non-null

A globally-unique identifier.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to name name
•
String!
non-null

The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'.

Anchor to recurringDeliveries recurringDeliveries
•
Boolean!
non-null

Whether purchasing the selling plan will result in multiple deliveries.

Anchor to deliveryAddress deliveryAddress
•
Mailing Address

The shipping or destination address associated with the delivery group.

Anchor to address1 address1
•
String

The first line of the address. Typically the street address or PO Box number.

Anchor to address2 address2
•
String

The second line of the address. Typically the number of the apartment, suite, or unit.

Anchor to city city
•
String

The name of the city, district, village, or town.

Anchor to company company
•
String

The name of the customer's company or organization.

Anchor to countryCode countryCode
•
Country Code

The two-letter code for the country of the address. For example, US.

AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MK, ML, MM, MN, MO, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PS, PT, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW, ZZ
Anchor to firstName firstName
•
String

The first name of the customer.

Anchor to lastName lastName
•
String

The last name of the customer.

Anchor to latitude latitude
•
Float

The approximate latitude of the address.

Anchor to longitude longitude
•
Float

The approximate longitude of the address.

Anchor to name name
•
String

The full name of the customer, based on firstName and lastName.

Anchor to phone phone
•
String

A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.

Anchor to provinceCode provinceCode
•
String

The alphanumeric code for the region. For example, ON.

Anchor to zip zip
•
String

The zip or postal code of the address.

Anchor to market market
•
Market
Deprecated
Anchor to handle handle
•
Handle!
non-null

A human-readable unique string for the market automatically generated from its title.

Anchor to id id
•
ID!
non-null

A globally-unique identifier.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to regions regions
•
[Market Region!]!
non-null

A geographic region which comprises a market.

Anchor to name name
•
String

The name of the region in the language of the current localization.

Anchor to deliveryOptions deliveryOptions
•
[Cart Delivery Option!]!
non-null

The delivery options available for the delivery group. Delivery options are the different ways that customers can choose to have their orders shipped. Examples include express shipping or standard shipping.

Anchor to code code
•
String

A unique identifier that represents the delivery option offered to customers. For example, Canada Post Expedited.

Anchor to cost cost
•
Money V2!
non-null

The amount that the customer pays if they select the delivery option.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to deliveryMethodType deliveryMethodType
•
Delivery Method!
non-null

The delivery method associated with the delivery option. A delivery method is a way that merchants can fulfill orders from their online stores. Delivery methods include shipping to an address, local pickup, and shipping to a pickup point, all of which are natively supported by Shopify checkout.

LOCAL, NONE, PICK_UP, PICKUP_POINT, RETAIL, SHIPPING
Anchor to description description
•
String

A single-line description of the delivery option, with HTML tags removed.

Anchor to handle handle
•
Handle!
non-null

A unique, human-readable identifier of the delivery option's title. A handle can contain letters, hyphens (-), and numbers, but not spaces. For example, standard-shipping.

Anchor to title title
•
String

The name of the delivery option that displays to customers. The title is used to construct the delivery option's handle. For example, if a delivery option is titled "Standard Shipping", then the handle is standard-shipping.

Anchor to id id
•
ID!
non-null

A globally-unique ID for the delivery group.

Anchor to selectedDeliveryOption selectedDeliveryOption
•
Cart Delivery Option

Information about the delivery option that the customer has selected.

Anchor to code code
•
String

A unique identifier that represents the delivery option offered to customers. For example, Canada Post Expedited.

Anchor to cost cost
•
Money V2!
non-null

The amount that the customer pays if they select the delivery option.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to deliveryMethodType deliveryMethodType
•
Delivery Method!
non-null

The delivery method associated with the delivery option. A delivery method is a way that merchants can fulfill orders from their online stores. Delivery methods include shipping to an address, local pickup, and shipping to a pickup point, all of which are natively supported by Shopify checkout.

LOCAL, NONE, PICK_UP, PICKUP_POINT, RETAIL, SHIPPING
Anchor to description description
•
String

A single-line description of the delivery option, with HTML tags removed.

Anchor to handle handle
•
Handle!
non-null

A unique, human-readable identifier of the delivery option's title. A handle can contain letters, hyphens (-), and numbers, but not spaces. For example, standard-shipping.

Anchor to title title
•
String

The name of the delivery option that displays to customers. The title is used to construct the delivery option's handle. For example, if a delivery option is titled "Standard Shipping", then the handle is standard-shipping.

Anchor to lines lines
•
[Cart Line!]!
non-null

The items in a cart that the customer intends to purchase. A cart line is an entry in the customer's cart that represents a single unit of a product variant. For example, if a customer adds two different sizes of the same t-shirt to their cart, then each size is represented as a separate cart line.

Anchor to attribute attribute
•
Attribute

The custom attributes associated with a cart to store additional information. Cart attributes allow you to collect specific information from customers on the Cart page, such as order notes, gift wrapping requests, or custom product details. Attributes are stored as key-value pairs.

Cart line attributes are equivalent to the line_item object in Liquid.

Arguments

Anchor to key key
•
String

The key of the cart attribute to retrieve. For example, "gift_wrapping".

Fields

Anchor to key key
•
String!
non-null

The key or name of the attribute. For example, "customer_first_order".

Anchor to value value
•
String

The value of the attribute. For example, "true".

Anchor to cost cost
•
Cart Line Cost!
non-null

The cost of an item in a cart that the customer intends to purchase. Cart lines are entries in the customer's cart that represent a single unit of a product variant. For example, if a customer adds two different sizes of the same t-shirt to their cart, then each size is represented as a separate cart line.

Anchor to amountPerQuantity amountPerQuantity
•
Money V2!
non-null

The cost of a single unit. For example, if a customer purchases three units of a product that are priced at $10 each, then the amountPerQuantity is $10.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to compareAtAmountPerQuantity compareAtAmountPerQuantity
•
Money V2

The cost of a single unit before any discounts are applied. This field is used to calculate and display savings for customers. For example, if a product's compareAtAmountPerQuantity is $25 and its current price is $20, then the customer sees a $5 discount. This value can change based on the buyer's identity and is null when the value is hidden from buyers.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to subtotalAmount subtotalAmount
•
Money V2!
non-null

The cost of items in the cart before applying any discounts to certain items. This amount serves as the starting point for calculating any potential savings customers might receive through promotions or discounts.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to totalAmount totalAmount
•
Money V2!
non-null

The total cost of items in a cart.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to id id
•
ID!
non-null

The ID of the cart line.

Anchor to merchandise merchandise
•
Merchandise!
non-null

The item that the customer intends to purchase.

Anchor to CustomProduct
Custom Product
• OBJECT

A custom product represents a product that doesn't map to Shopify's standard product categories. For example, you can use a custom product to manage gift cards, shipping requirements, localized product information, or weight measurements and conversions.

Anchor to isGiftCard isGiftCard
•
Boolean!
non-null

Whether the merchandise is a gift card.

Anchor to requiresShipping requiresShipping
•
Boolean!
non-null

Whether the item needs to be shipped to the customer. For example, a digital gift card doesn't need to be shipped, but a t-shirt does need to be shipped.

Anchor to title title
•
String!
non-null

The localized name for the product that displays to customers. The title is used to construct the product's handle, which is a unique, human-readable string of the product's title. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

Anchor to weight weight
•
Float

The product variant's weight, in the system of measurement set in the weightUnit field.

Anchor to weightUnit weightUnit
•
Weight Unit!
non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS
Anchor to ProductVariant
Product Variant
• OBJECT

A specific version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.

Anchor to id id
•
ID!
non-null

A globally-unique ID for the product variant.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to product product
•
Product!
non-null

The product associated with the product variant. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another. The product associated with the product variant would be the t-shirt itself.

Anchor to handle handle
•
Handle!
non-null

A unique, human-readable string of the product's title. A handle can contain letters, hyphens (-), and numbers, but not spaces. The handle is used in the online store URL for the product. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

Anchor to hasAnyTag hasAnyTag
•
Boolean!
non-null

Whether the product is associated with any of the specified tags. The product must have at least one tag from the list to return true.

Anchor to hasTags hasTags
•
[Has Tag Response!]!
non-null

Whether the product is associated with the specified tags. The product must have all of the tags in the list to return true.

Arguments

Anchor to tags tags
•
[String!]!
required Default:[]

A comma-separated list of searchable keywords that are associated with the product. For example, "sports, summer" returns products with both the sports and summer tags.

Fields

Anchor to hasTag hasTag
•
Boolean!
non-null

Whether the Shopify resource has the tag.

Anchor to tag tag
•
String!
non-null

A searchable keyword that's associated with a Shopify resource, such as a product or customer. For example, a merchant might apply the sports and summer tags to products that are associated with sportswear for summer.

Anchor to id id
•
ID!
non-null

A globally-unique ID for the product.

Anchor to inAnyCollection inAnyCollection
•
Boolean!
non-null

Whether the product is in any of the specified collections. The product must be in at least one collection from the list to return true.

A collection is a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire and accessories.

Anchor to inCollections inCollections
•
[Collection Membership!]!
non-null

Whether the product is in the specified collections. The product must be in all of the collections in the list to return true.

A collection is a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire and accessories.

Arguments

Anchor to ids ids
•
[ID!]!
required Default:[]

A comma-separated list of globally-unique collection IDs that are associated with the product. For example, gid://shopify/Collection/123, gid://shopify/Collection/456.

Fields

Anchor to collectionId collectionId
•
ID!
non-null

A globally-unique ID for the collection.

Anchor to isMember isMember
•
Boolean!
non-null

Whether the product is in the specified collection.

Anchor to isGiftCard isGiftCard
•
Boolean!
non-null

Whether the product is a gift card.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to productType productType
•
String

A custom category for a product. Product types allow merchants to define categories other than the ones available in Shopify's standard product categories.

Anchor to title title
•
String!
non-null

The localized name for the product that displays to customers. The title is used to construct the product's handle, which is a unique, human-readable string of the product's title. For example, if a product is titled "Black Sunglasses", then the handle is black-sunglasses.

Anchor to vendor vendor
•
String

The name of the product's vendor.

Anchor to requiresShipping requiresShipping
•
Boolean!
non-null

Whether the item needs to be shipped to the customer. For example, a digital gift card doesn't need to be shipped, but a t-shirt does need to be shipped.

Anchor to sku sku
•
String

A case-sensitive identifier for the product variant in the merchant's store. For example, "BBC-1". A product variant must have a SKU to be connected to a fulfillment service.

Anchor to title title
•
String

The localized name for the product variant that displays to customers.

Anchor to weight weight
•
Float

The product variant's weight, in the system of measurement set in the weightUnit field.

Anchor to weightUnit weightUnit
•
Weight Unit!
non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS
Anchor to quantity quantity
•
Int!
non-null

The quantity of the item that the customer intends to purchase.

Anchor to sellingPlanAllocation sellingPlanAllocation
•
Selling Plan Allocation

The selling plan associated with the cart line, including information about how a product variant can be sold and purchased.

Anchor to priceAdjustments priceAdjustments
•
[Selling Plan Allocation Price Adjustment!]!
non-null

A list of price adjustments, with a maximum of two. When there are two, the first price adjustment goes into effect at the time of purchase, while the second one starts after a certain number of orders. A price adjustment represents how a selling plan affects pricing when a variant is purchased with a selling plan. Prices display in the customer's currency if the shop is configured for it.

Anchor to perDeliveryPrice perDeliveryPrice
•
Money V2!
non-null

The effective price for a single delivery. For example, for a prepaid subscription plan that includes 6 deliveries at the price of $48.00, the per delivery price is $8.00.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to price price
•
Money V2!
non-null

The price of the variant when it's purchased with a selling plan For example, for a prepaid subscription plan that includes 6 deliveries of $10.00 granola, where the customer gets 20% off, the price is 6 x $10.00 x 0.80 = $48.00.

Anchor to amount amount
•
Decimal!
non-null

A monetary value in decimal format, allowing for precise representation of cents or fractional currency. For example, 12.99.

Anchor to currencyCode currencyCode
•
Currency Code!
non-null

The three-letter currency code that represents a world currency used in a store. Currency codes include standard standard ISO 4217 codes, legacy codes, and non-standard codes. For example, USD.

AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLP, CNY, COP, CRC, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JEP, JMD, JOD, JPY, KES, KGS, KHR, KID, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDC, UYU, UZS, VED, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, XXX, YER, ZAR, ZMW, BYR, STD, VEF
Anchor to sellingPlan sellingPlan
•
Selling Plan!
non-null

A representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'.

Anchor to description description
•
String

The description of the selling plan.

Anchor to id id
•
ID!
non-null

A globally-unique identifier.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to name name
•
String!
non-null

The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'.

Anchor to recurringDeliveries recurringDeliveries
•
Boolean!
non-null

Whether purchasing the selling plan will result in multiple deliveries.

Anchor to localizedFields localizedFields
•
[Localized Field!]!
non-null

The additional fields on the Cart page that are required for international orders in specific countries, such as customs information or tax identification numbers.

Arguments

Anchor to keys keys
•
[Localized Field Key!]!
required Default:[]

The keys of the localized fields to retrieve.

SHIPPING_CREDENTIAL_BR, SHIPPING_CREDENTIAL_CL, SHIPPING_CREDENTIAL_CN, SHIPPING_CREDENTIAL_CO, SHIPPING_CREDENTIAL_CR, SHIPPING_CREDENTIAL_EC, SHIPPING_CREDENTIAL_ES, SHIPPING_CREDENTIAL_GT, SHIPPING_CREDENTIAL_ID, SHIPPING_CREDENTIAL_KR, SHIPPING_CREDENTIAL_MX, SHIPPING_CREDENTIAL_MY, SHIPPING_CREDENTIAL_PE, SHIPPING_CREDENTIAL_PT, SHIPPING_CREDENTIAL_PY, SHIPPING_CREDENTIAL_TR, SHIPPING_CREDENTIAL_TW, SHIPPING_CREDENTIAL_TYPE_CO, TAX_CREDENTIAL_BR, TAX_CREDENTIAL_CL, TAX_CREDENTIAL_CO, TAX_CREDENTIAL_CR, TAX_CREDENTIAL_EC, TAX_CREDENTIAL_ES, TAX_CREDENTIAL_GT, TAX_CREDENTIAL_ID, TAX_CREDENTIAL_IT, TAX_CREDENTIAL_MX, TAX_CREDENTIAL_MY, TAX_CREDENTIAL_PE, TAX_CREDENTIAL_PT, TAX_CREDENTIAL_PY, TAX_CREDENTIAL_TR, TAX_CREDENTIAL_TYPE_CO, TAX_CREDENTIAL_TYPE_MX, TAX_CREDENTIAL_USE_MX, TAX_EMAIL_IT

Fields

Anchor to key key
•
Localized Field Key!
non-null

The key of the localized field.

SHIPPING_CREDENTIAL_BR, SHIPPING_CREDENTIAL_CL, SHIPPING_CREDENTIAL_CN, SHIPPING_CREDENTIAL_CO, SHIPPING_CREDENTIAL_CR, SHIPPING_CREDENTIAL_EC, SHIPPING_CREDENTIAL_ES, SHIPPING_CREDENTIAL_GT, SHIPPING_CREDENTIAL_ID, SHIPPING_CREDENTIAL_KR, SHIPPING_CREDENTIAL_MX, SHIPPING_CREDENTIAL_MY, SHIPPING_CREDENTIAL_PE, SHIPPING_CREDENTIAL_PT, SHIPPING_CREDENTIAL_PY, SHIPPING_CREDENTIAL_TR, SHIPPING_CREDENTIAL_TW, SHIPPING_CREDENTIAL_TYPE_CO, TAX_CREDENTIAL_BR, TAX_CREDENTIAL_CL, TAX_CREDENTIAL_CO, TAX_CREDENTIAL_CR, TAX_CREDENTIAL_EC, TAX_CREDENTIAL_ES, TAX_CREDENTIAL_GT, TAX_CREDENTIAL_ID, TAX_CREDENTIAL_IT, TAX_CREDENTIAL_MX, TAX_CREDENTIAL_MY, TAX_CREDENTIAL_PE, TAX_CREDENTIAL_PT, TAX_CREDENTIAL_PY, TAX_CREDENTIAL_TR, TAX_CREDENTIAL_TYPE_CO, TAX_CREDENTIAL_TYPE_MX, TAX_CREDENTIAL_USE_MX, TAX_EMAIL_IT
Anchor to title title
•
String!
non-null

The title of the localized field.

Anchor to value value
•
String

The value of the localized field.

Anchor to deliveryCustomization deliveryCustomization
•
Delivery Customization!
non-null

The backend logic that the Function is running to define how delivery options are sorted, hidden, or renamed. It includes the metafields that are associated with the customization.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to localization localization
•
Localization!
non-null

The regional and language settings that determine how the Function handles currency, numbers, dates, and other locale-specific values during discount calculations. These settings are based on the store's configured localization practices.

Anchor to country country
•
Country!
non-null

The country for which the store is customized, reflecting local preferences and regulations. Localization might influence the language, currency, and product offerings available in a store to enhance the shopping experience for customers in that region.

Anchor to isoCode isoCode
•
Country Code!
non-null

The ISO code of the country.

AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AR, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MK, ML, MM, MN, MO, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PS, PT, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VN, VU, WF, WS, XK, YE, YT, ZA, ZM, ZW, ZZ
Anchor to language language
•
Language!
non-null

The language for which the store is customized, ensuring content is tailored to local customers. This includes product descriptions and customer communications that resonate with the target audience.

Anchor to isoCode isoCode
•
Language Code!
non-null

The ISO code.

AF, AK, AM, AR, AS, AZ, BE, BG, BM, BN, BO, BR, BS, CA, CE, CKB, CS, CU, CY, DA, DE, DZ, EE, EL, EN, EO, ES, ET, EU, FA, FF, FI, FIL, FO, FR, FY, GA, GD, GL, GU, GV, HA, HE, HI, HR, HU, HY, IA, ID, IG, II, IS, IT, JA, JV, KA, KI, KK, KL, KM, KN, KO, KS, KU, KW, KY, LB, LG, LN, LO, LT, LU, LV, MG, MI, MK, ML, MN, MR, MS, MT, MY, NB, ND, NE, NL, NN, NO, OM, OR, OS, PA, PL, PS, PT, PT_BR, PT_PT, QU, RM, RN, RO, RU, RW, SA, SC, SD, SE, SG, SI, SK, SL, SN, SO, SQ, SR, SU, SV, SW, TA, TE, TG, TH, TI, TK, TO, TR, TT, UG, UK, UR, UZ, VI, VO, WO, XH, YI, YO, ZH, ZH_CN, ZH_TW, ZU
Anchor to market market
•
Market!
non-null Deprecated
Anchor to handle handle
•
Handle!
non-null

A human-readable unique string for the market automatically generated from its title.

Anchor to id id
•
ID!
non-null

A globally-unique identifier.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to regions regions
•
[Market Region!]!
non-null

A geographic region which comprises a market.

Anchor to name name
•
String

The name of the region in the language of the current localization.

Anchor to presentmentCurrencyRate presentmentCurrencyRate
•
Decimal!
non-null

The exchange rate used to convert discounts between the shop's default currency and the currency that displays to the customer during checkout. For example, if a store operates in USD but a customer is viewing discounts in EUR, then the presentment currency rate handles this conversion for accurate pricing.

Anchor to shop shop
•
Shop!
non-null

Information about the shop where the Function is running, including the shop's timezone setting and associated metafields.

Anchor to localTime localTime
•
Local Time!
non-null

The current time based on the store's timezone setting.

Anchor to date date
•
Date!
non-null

The current date relative to the parent object.

Anchor to dateTimeAfter dateTimeAfter
•
Boolean!
non-null

Returns true if the current date and time is at or past the given date and time, and false otherwise.

Anchor to dateTimeBefore dateTimeBefore
•
Boolean!
non-null

Returns true if the current date and time is before the given date and time, and false otherwise.

Anchor to dateTimeBetween dateTimeBetween
•
Boolean!
non-null

Returns true if the current date and time is between the two given date and times, and false otherwise.

Anchor to timeAfter timeAfter
•
Boolean!
non-null

Returns true if the current time is at or past the given time, and false otherwise.

Anchor to timeBefore timeBefore
•
Boolean!
non-null

Returns true if the current time is at or past the given time, and false otherwise.

Anchor to timeBetween timeBetween
•
Boolean!
non-null

Returns true if the current time is between the two given times, and false otherwise.

Anchor to metafield metafield
•
Metafield

A custom field that stores additional information about a Shopify resource, such as products, orders, and many more. Using metafields with Shopify Functions enables you to customize the checkout experience.

Arguments

Anchor to namespace namespace
•
String

A category that organizes a group of metafields. Namespaces are used to prevent naming conflicts between different apps or different parts of the same app. If omitted, then the app-reserved namespace is used.

Anchor to key key
•
String!
required

The unique identifier for the metafield within its namespace. A metafield is composed of a namespace and a key, in the format namespace.key.

Fields

Anchor to jsonValue jsonValue
•
JSON!
non-null

The data that's stored in the metafield, using JSON format.

Anchor to type type
•
String!
non-null

The type of data that the metafield stores in the value field.

Anchor to value value
•
String!
non-null

The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to Run FunctionRun Function

The logic that processes the input data to generate a standardized list of operations that generate delivery customizations.

Each operation specifies a delivery customization. Shopify processes your response to modify delivery options during checkout, including data such as location details, the company associated with the order, and products.

This return must follow the schema defined in the FunctionRunResult object.

Anchor to FunctionRunResultFunction Run Result
OBJECT

The FunctionRunResult object is the output of the Function run target. The object contains the operations to apply to delivery options in checkout.

Anchor to operations operations
•
[Operation!]!
non-null

The ordered list of operations to apply to the list of delivery options.

Anchor to hide hide
•
Hide Operation

An operation that hides a delivery option from a list that's offered to customers at checkout.

Anchor to deliveryOptionHandle deliveryOptionHandle
•
Handle!
non-null

The handle of the delivery option to hide.

Anchor to move move
•
Move Operation

An operation that sorts a list of delivery options that are offered to customers at checkout.

If you reorder shipping delivery options, then you are prohibited. from automatically selecting higher-priced delivery alternatives by default. The cheapest shipping delivery option must always be the first option selected.

Anchor to deliveryOptionHandle deliveryOptionHandle
•
Handle!
non-null

The handle of the delivery option to move.

Anchor to index index
•
Int!
non-null

The target index within the delivery group to move the delivery option to.

Anchor to rename rename
•
Rename Operation

An operation that renames a delivery option that's offered to customers at checkout.

The carrier name is automatically prepended to the delivery option title at checkout when using the RenameOperation object, and can't be altered or omitted through the API. For example, if the carrier name is UPS and the option is Standard, then you could change UPS Standard to UPS Standard Shipping, but you couldn't change UPS Standard to Standard Shipping.

Anchor to deliveryOptionHandle deliveryOptionHandle
•
Handle!
non-null

The handle of the delivery option to rename.

Anchor to title title
•
String!
non-null

The new name for the delivery option.

Was this section helpful?

Anchor to Migrating from Shopify Scripts to Shopify FunctionsMigrating from Shopify Scripts to Shopify Functions

If you want to migrate an existing shipping script to Shopify Functions, then you can use the following mappings:

Mappings for migrating from Shopify Scripts to Shopify Functions
Shopify Scripts method Description Shopify Functions operation Additional context
change_name Changes the name of a delivery option rename The carrier name is automatically prepended to the delivery option title at checkout and can't be altered or omitted. For example, if the carrier name is UPS and the delivery option is Standard, then you could change UPS Standard to UPS Standard Shipping, but you couldn't change UPS Standard to Standard Shipping.
sort Sorts the delivery options based on some criteria, typically to place one delivery option at the top or bottom of a list move Moves delivery options instead of sorting them. When reordering shipping delivery options, you're prohibited from automatically selecting higher-priced delivery alternatives by default. The cheapest shipping delivery option must always be the first option selected.
delete_if Removes a delivery option from checkout hide
Was this section helpful?