Choose a version:

Anchor to Discount Function APIDiscount Function API

The Discount Function API provides a unified schema for creating Function extensions. A single Function processes one discount (either code-based or automatic), but can apply savings across three discount classes: product, order, and shipping.

For example, one discount can simultaneously reduce both order total and delivery costs.

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

Note

You can activate a maximum of 25 Discount Functions on each store. All Discount Functions run concurrently, and have no knowledge of each other. The potential discount that a Function outputs can be combined with the candidate from another discount, in alignment with the combination and stacking rules set on the discount node.

Anchor to Use casesUse cases

Exclusions, where the discount doesn't apply to some cart lines in the order.
Tiered discounts on products, orders, and shipping when orders include qualifying item, subtotal, and delivery requirements.
Discount to cartlines that contain specific properties, such as an engraving on a ring.

Compatibility with Shopify surfaces

Supported (7)

Partially supported (4)

Unsupported (2)

B2B

Cart

Checkout

Create Order API

Draft Order (Admin)

Discount Functions with network access aren't supported on draft orders.

Draft Order (Checkout)

Discount Functions with network access aren't supported on draft orders.

Order Edit (Admin)

Order Edit (Checkout)

The Function isn't re-run when editing an order.

POS

Shopify Admin

Storefront

Storefront Accelerated Checkout

Subscription (Recurring Orders)

The Function isn't re-run when the recurring orders are created.

Fetch target Limited access

Off

The fetch target is limited to custom apps installed on Shopify Plus and Enterprise stores. You'll also need to request network access for Functions, as it's not currently available on development stores or in a development preview.

Was this section helpful?

Anchor to Getting startedGetting started

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

Terminal

shopify app generate extension -- template discount

Tutorial Build a Discount 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.

Note

You can't configure discount classes from a checkout UI extension. Discount classes are assigned based on their associated Discount Function targets: OrderDiscountCandidateTarget, ProductDiscountCandidateTarget, and DeliveryDiscountCandidateTarget.

Anchor to Cart run targetCart run target

cart.lines.discounts.generate.run

The run target calculates and applies discounts to cart lines, orders, and shipping based on the provided cart context and discount configuration, including metafields.

When your Function is executed, Shopify provides the cart context as input to the run target, including details about cart lines, prices, quantities, buyer identity, and optionally fetch results from external providers. The target returns an ordered list of operations for calculating discounts.

For example, you might use this to generate product and order discounts, and validate discounts.

Input

OBJECT

The Input object is the complete GraphQL schema that your Function can query as an input to generate discounts. Your Function only receives 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.

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.

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.

Anchor to key key • String: The key of the cart attribute to retrieve. For example, "gift_wrapping".

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".

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.

customer

•

Customer

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

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.

amount

•

Decimal!

non-null

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

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

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.

•

String

The customer's email address.

firstName

•

String

The customer's first name.

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.

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.

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.

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.

•

ID!

non-null

A globally-unique ID for the customer.

lastName

•

String

The customer's last name.

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.

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.

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.

numberOfOrders

•

Int!

non-null

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

•

String

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

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.

phone

•

String

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

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.

company

•

Company!

non-null

The company associated to the order or draft order.

createdAt

•

Date Time!

non-null

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

externalId

•

String

A unique externally-supplied ID for the company.

•

ID!

non-null

The ID of the company.

metafield

•

Metafield

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.

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.

name

•

String!

non-null

The name of the company.

updatedAt

•

Date Time!

non-null

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

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.

location

•

Company Location!

non-null

The company location associated to the order or draft order.

createdAt

•

Date Time!

non-null

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

externalId

•

String

A unique externally-supplied ID for the company.

•

ID!

non-null

The ID of the company.

locale

•

String

The preferred locale of the company location.

metafield

•

Metafield

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.

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.

name

•

String!

non-null

The name of the company location.

updatedAt

•

Date Time!

non-null

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

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.

subtotalAmount

•

Money V2!

non-null

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

amount

•

Decimal!

non-null

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

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.

totalAmount

•

Money V2!

non-null

The total amount for the customer to pay at checkout.

amount

•

Decimal!

non-null

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

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.

totalDutyAmount

•

Money V2

The duty charges for a customer to pay at checkout.

amount

•

Decimal!

non-null

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

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.

totalTaxAmount

•

Money V2

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

amount

•

Decimal!

non-null

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

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.

deliverableLines

•

[Deliverable Cart Line!]!

non-null

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

attribute

•

Attribute

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

Anchor to key key • String: The key of the cart attribute to retrieve. For example, "gift_wrapping".

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".

•

ID!

non-null

The ID of the cart line.

merchandise

•

Merchandise!

non-null

The item that the customer intends to purchase.

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.

isGiftCard

•

Boolean!

non-null

Whether the merchandise is a gift card.

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.

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.

weight

•

Float

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

weightUnit

•

Weight Unit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

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.

•

ID!

non-null

A globally-unique ID for the product variant.

metafield

•

Metafield

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.

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.

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.

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.

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.

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.

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.

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.

•

ID!

non-null

A globally-unique ID for the product.

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.

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.

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.

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.

isGiftCard

•

Boolean!

non-null

Whether the product is a gift card.

metafield

•

Metafield

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.

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.

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.

title

•

String!

non-null

vendor

•

String

The name of the product's vendor.

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.

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.

title

•

String

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

weight

•

Float

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

weightUnit

•

Weight Unit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

quantity

•

Int!

non-null

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

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.

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.

attribute

•

Attribute

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

Anchor to key key • String: The key of the cart attribute to retrieve. For example, "gift_wrapping".

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".

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.

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.

amount

•

Decimal!

non-null

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

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.

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.

amount

•

Decimal!

non-null

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

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.

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.

amount

•

Decimal!

non-null

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

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.

totalAmount

•

Money V2!

non-null

The total cost of items in a cart.

amount

•

Decimal!

non-null

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

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.

•

ID!

non-null

The ID of the cart line.

merchandise

•

Merchandise!

non-null

The item that the customer intends to purchase.

Custom Product

• OBJECT

isGiftCard

•

Boolean!

non-null

Whether the merchandise is a gift card.

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.

title

•

String!

non-null

weight

•

Float

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

weightUnit

•

Weight Unit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

Product Variant

• OBJECT

•

ID!

non-null

A globally-unique ID for the product variant.

metafield

•

Metafield

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.

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.

product

•

Product!

non-null

handle

•

Handle!

non-null

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.

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.

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.

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.

•

ID!

non-null

A globally-unique ID for the product.

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.

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.

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.

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.

isGiftCard

•

Boolean!

non-null

Whether the product is a gift card.

metafield

•

Metafield

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.

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.

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.

title

•

String!

non-null

vendor

•

String

The name of the product's vendor.

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.

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.

title

•

String

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

weight

•

Float

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

weightUnit

•

Weight Unit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

quantity

•

Int!

non-null

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

sellingPlanAllocation

•

Selling Plan Allocation

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

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.

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.

amount

•

Decimal!

non-null

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

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.

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.

amount

•

Decimal!

non-null

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

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.

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'.

description

•

String

The description of the selling plan.

•

ID!

non-null

A globally-unique identifier.

metafield

•

Metafield

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.

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.

name

•

String!

non-null

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

recurringDeliveries

•

Boolean!

non-null

Whether purchasing the selling plan will result in multiple deliveries.

deliveryAddress

•

Mailing Address

The shipping or destination address associated with the delivery group.

address1

•

String

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

address2

•

String

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

city

•

String

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

company

•

String

The name of the customer's company or organization.

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

firstName

•

String

The first name of the customer.

lastName

•

String

The last name of the customer.

latitude

•

Float

The approximate latitude of the address.

longitude

•

Float

The approximate longitude of the address.

name

•

String

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

phone

•

String

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

provinceCode

•

String

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

zip

•

String

The zip or postal code of the address.

market

•

Market

Deprecated

handle

•

Handle!

non-null

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

•

ID!

non-null

A globally-unique identifier.

metafield

•

Metafield

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.

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.

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.

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.

code

•

String

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

cost

•

Money V2!

non-null

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

amount

•

Decimal!

non-null

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

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.

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

description

•

String

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

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.

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.

•

ID!

non-null

A globally-unique ID for the delivery group.

selectedDeliveryOption

•

Cart Delivery Option

Information about the delivery option that the customer has selected.

code

•

String

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

cost

•

Money V2!

non-null

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

amount

•

Decimal!

non-null

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

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.

deliveryMethodType

•

Delivery Method!

non-null

LOCAL, NONE, PICK_UP, PICKUP_POINT, RETAIL, SHIPPING

description

•

String

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

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.

title

•

String

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.

attribute

•

Attribute

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

Anchor to key key • String: The key of the cart attribute to retrieve. For example, "gift_wrapping".

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".

cost

•

Cart Line Cost!

non-null

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.

amount

•

Decimal!

non-null

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

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.

compareAtAmountPerQuantity

•

Money V2

amount

•

Decimal!

non-null

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

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.

subtotalAmount

•

Money V2!

non-null

amount

•

Decimal!

non-null

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

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.

totalAmount

•

Money V2!

non-null

The total cost of items in a cart.

amount

•

Decimal!

non-null

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

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.

•

ID!

non-null

The ID of the cart line.

merchandise

•

Merchandise!

non-null

The item that the customer intends to purchase.

Custom Product

• OBJECT

isGiftCard

•

Boolean!

non-null

Whether the merchandise is a gift card.

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.

title

•

String!

non-null

weight

•

Float

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

weightUnit

•

Weight Unit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

Product Variant

• OBJECT

•

ID!

non-null

A globally-unique ID for the product variant.

metafield

•

Metafield

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.

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.

product

•

Product!

non-null

handle

•

Handle!

non-null

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.

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.

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.

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.

•

ID!

non-null

A globally-unique ID for the product.

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.

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.

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.

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.

isGiftCard

•

Boolean!

non-null

Whether the product is a gift card.

metafield

•

Metafield

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.

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.

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.

title

•

String!

non-null

vendor

•

String

The name of the product's vendor.

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.

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.

title

•

String

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

weight

•

Float

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

weightUnit

•

Weight Unit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

quantity

•

Int!

non-null

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

sellingPlanAllocation

•

Selling Plan Allocation

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

priceAdjustments

•

[Selling Plan Allocation Price Adjustment!]!

non-null

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.

amount

•

Decimal!

non-null

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

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.

price

•

Money V2!

non-null

amount

•

Decimal!

non-null

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

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.

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'.

description

•

String

The description of the selling plan.

•

ID!

non-null

A globally-unique identifier.

metafield

•

Metafield

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.

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.

name

•

String!

non-null

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

recurringDeliveries

•

Boolean!

non-null

Whether purchasing the selling plan will result in multiple deliveries.

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

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

key

•

Localized Field Key!

non-null

The key of the localized field.

title

•

String!

non-null

The title of the localized field.

value

•

String

The value of the localized field.

discount

•

Discount!

non-null

The discount node that owns the Shopify Function. Discounts are a way for merchants to promote sales and special offers, or as customer loyalty rewards. A single discount can be automatic or code-based, and can be applied to a cart lines, orders, and delivery.

discountClasses

•

[Discount Class!]!

non-null

The discount classes) that the discountNode) supports.

ORDER, PRODUCT, SHIPPING

metafield

•

Metafield

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.

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.

fetchResult

•

Http Response

The result of the fetch target. Refer to network access for Shopify Functions. This input is only available in the cart.lines.discounts.generate.run and cart.delivery-options.discounts.generate.run extension targets.

body

•

String

The HTTP response body as a plain string. Use this field when the body is not in JSON format.

•

Http Response Header

An HTTP header.

Anchor to name name • String! required: A case-insensitive header name.

Anchor to name name • String! non-null: Header name.
Anchor to value value • String! non-null: Header value.

jsonBody

•

JSON

The HTTP response body parsed as JSON. If the body is valid JSON, it will be parsed and returned as a JSON object. If parsing fails, then raw body is returned as a string. Use this field when you expect the response to be JSON, or when you're dealing with mixed response types, meaning both JSON and non-JSON. Using this field reduces function instruction consumption and ensures that the data is formatted in logs. To prevent increasing the function target input size unnecessarily, avoid querying both body and jsonBody simultaneously.

status

•

Int!

non-null

The HTTP status code.

headers

•

[Http Response Header!]!

non-null Deprecated

Anchor to name name • String! non-null: Header name.
Anchor to value value • String! non-null: Header value.

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.

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.

isoCode

•

Country Code!

non-null

The ISO code of the country.

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.

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

market

•

Market!

non-null Deprecated

handle

•

Handle!

non-null

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

•

ID!

non-null

A globally-unique identifier.

metafield

•

Metafield

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.

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.

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.

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.

shop

•

Shop!

non-null

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

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.

metafield

•

Metafield

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.

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.

triggeringDiscountCode

•

String

The discount code entered by a customer, which caused the Discount Function) to run. This input is only available in the cart.lines.discounts.generate.run and cart.delivery-options.discounts.generate.run extension targets.

Anchor to Cart run FunctionCart run Function

The Function processes input schema data to calculate and allocate discounts across cart lines. The Function handles both fixed and percentage-based discounts while respecting discount caps and generating any messages associated with the discount, such as error messages associated with validation.

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

Cart Lines Discounts Generate Run Result

OBJECT

The CartLinesDiscountsGenerateRunResult object is the output of the Function run target. The object contains the operations to generate, validate, and apply discounts to the cart.

operations

•

[Cart Operation!]!

non-null

The list of operations to apply discounts to the cart.

enteredDiscountCodesAccept

•

Entered Discount Codes Accept Operation

An operation that selects which entered discount codes to accept. Use this to validate discount codes from external systems.

codes

•

[Discount Code!]!

non-null

The list of discount codes to accept.

Anchor to code code • String! non-null: The discount code.

orderDiscountsAdd

•

Order Discounts Add Operation

An operation that applies order discounts to a cart that share a selection strategy.

candidates

•

[Order Discount Candidate!]!

non-null

The list of discounts that can be applied to an order.

associatedDiscountCode

•

Associated Discount Code

The discount code associated with this discount candidate, for code-based discounts.

Anchor to code code • String! non-null: The discount code.

conditions

•

[Condition!]

The conditions that must be satisfied for an order to be eligible for a discount candidate.

cartLineMinimumQuantity

•

Cart Line Minimum Quantity

The condition for checking the minimum quantity of products across a group of cart lines.

Anchor to ids ids • [ID!]! non-null: Cart line IDs with a merchandise line price that's included to calculate the minimum quantity purchased to receive the discount.
Anchor to minimumQuantity minimumQuantity • Int! non-null: The minimum quantity of a cart line to be eligible for a discount candidate.

cartLineMinimumSubtotal

•

Cart Line Minimum Subtotal

The condition for checking the minimum subtotal of products across a group of cart lines.

Anchor to ids ids • [ID!]! non-null: Cart line IDs with a merchandise line price that's included to calculate the minimum subtotal purchased to receive the discount.
Anchor to minimumAmount minimumAmount • Decimal! non-null: The minimum subtotal amount of the cart line to be eligible for a discount candidate.

orderMinimumSubtotal

•

Order Minimum Subtotal

The condition for checking the minimum subtotal amount of the order.

Anchor to excludedCartLineIds excludedCartLineIds • [ID!]! non-null: Cart line IDs with a merchandise line price that's excluded to calculate the minimum subtotal amount of the order.
Anchor to minimumAmount minimumAmount • Decimal! non-null: The minimum subtotal amount of the order to be eligible for the discount.

message

•

String

A notification on the Cart page informs customers about available discounts. If an automatic discount applies, the notification displays this message, such as "Save 20% on all t-shirts." If a discount code is entered, the notification displays the code instead.

targets

•

[Order Discount Candidate Target!]!

non-null

The targets of the order discount candidate.

orderSubtotal

•

Order Subtotal Target

A method for applying a discount to the entire order subtotal. The subtotal is the total amount of the order before any taxes, shipping fees, or discounts are applied. For example, if a customer places an order for a t-shirt and a pair of shoes, then the subtotal is the sum of the prices of those items.

Anchor to excludedCartLineIds excludedCartLineIds • [ID!]! non-null: The list of excluded cart line IDs. These cart lines are excluded from the order subtotal calculation when calculating the maximum value of the discount.

value

•

Order Discount Candidate Value!

non-null

The value of the order discount candidate.

fixedAmount

•

Fixed Amount

A fixed amount value.

Anchor to amount amount • Decimal! non-null: The fixed amount value of the discount, in the currency of the cart.

The amount must be greater than or equal to 0.

percentage

•

Percentage

A percentage value.

Anchor to value value • Decimal! non-null: The percentage value.

The value is validated against: >= 0 and <= 100.

selectionStrategy

•

Order Discount Selection Strategy!

non-null

The strategy that's applied to the list of discounts.

FIRST, MAXIMUM

productDiscountsAdd

•

Product Discounts Add Operation

An operation that applies product discounts to a cart that share a selection strategy.

candidates

•

[Product Discount Candidate!]!

non-null

The list of products that are eligible for the discount.

associatedDiscountCode

•

Associated Discount Code

The discount code associated with this discount candidate, for code-based discounts.

Anchor to code code • String! non-null: The discount code.

message

•

String

targets

•

[Product Discount Candidate Target!]!

non-null

The targets of the discount to be applied to a cart line.

cartLine

•

Cart Line Target

A method for applying a discount to a specific line item in the cart. 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 id id • ID! non-null: The ID of the targeted cart line.
Anchor to quantity quantity • Int: The number of line items that are being discounted. The default value is null, which represents the quantity of the matching line items.

The value is validated against: > 0.

value

•

Product Discount Candidate Value!

non-null

The value of the discount to be applied to a cart line. For example, a fixed amount of $5 off or percentage value of 20% off.

fixedAmount

•

Product Discount Candidate Fixed Amount

The fixed-amount value of the discount to be applied to a cart line. For example, if the cart total is $100 and the discount is $10, then the fixed amount is $10.

Anchor to amount amount • Decimal! non-null: The fixed-amount value of the discount to be applied to a cart line, in the currency of the cart. The amount must be greater than or equal to 0.
Anchor to appliesToEachItem appliesToEachItem • Boolean: Whether to apply the value of each eligible discount to each eligible cart line.

The default value is false, which causes the value to be applied once across the entitled items. When the value is true, the value will be applied to each of the entitled items.

percentage

•

Percentage

A percentage value.

Anchor to value value • Decimal! non-null: The percentage value.

The value is validated against: >= 0 and <= 100.

selectionStrategy

•

Product Discount Selection Strategy!

non-null

The strategy that's applied to the list of products that are eligible for the cart line discount.

ALL, FIRST, MAXIMUM

Anchor to Delivery run targetDelivery run target

cart.delivery-options.discounts.generate.run

The run target that's responsible for generating the discount on shipping costs using either Shopify data, hardcoded values, or fetch results from external providers. The target returns an ordered list of operations to be applied to the cart.

The run target evaluates carts against discount rules, calculates applicable reductions, and returns the final discount. This target generates and returns a shipping discount to potentially apply to the cart.

Input

OBJECT

The Input object is the complete GraphQL schema that your Function receives to generate discounts for a delivery option or delivery group. Your Function only receives 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.

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.

attribute

•

Attribute

Anchor to key key • String: The key of the cart attribute to retrieve. For example, "gift_wrapping".

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".

buyerIdentity

•

Buyer Identity

customer

•

Customer

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

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.

amount

•

Decimal!

non-null

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

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.

displayName

•

String!

non-null

•

String

The customer's email address.

firstName

•

String

The customer's first name.

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.

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.

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.

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.

•

ID!

non-null

A globally-unique ID for the customer.

lastName

•

String

The customer's last name.

metafield

•

Metafield

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.

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.

numberOfOrders

•

Int!

non-null

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

•

String

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

isAuthenticated

•

Boolean!

non-null

phone

•

String

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

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.

company

•

Company!

non-null

The company associated to the order or draft order.

createdAt

•

Date Time!

non-null

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

externalId

•

String

A unique externally-supplied ID for the company.

•

ID!

non-null

The ID of the company.

metafield

•

Metafield

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.

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.

name

•

String!

non-null

The name of the company.

updatedAt

•

Date Time!

non-null

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

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.

location

•

Company Location!

non-null

The company location associated to the order or draft order.

createdAt

•

Date Time!

non-null

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

externalId

•

String

A unique externally-supplied ID for the company.

•

ID!

non-null

The ID of the company.

locale

•

String

The preferred locale of the company location.

metafield

•

Metafield

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.

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.

name

•

String!

non-null

The name of the company location.

updatedAt

•

Date Time!

non-null

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

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.

subtotalAmount

•

Money V2!

non-null

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

amount

•

Decimal!

non-null

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

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.

totalAmount

•

Money V2!

non-null

The total amount for the customer to pay at checkout.

amount

•

Decimal!

non-null

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

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.

totalDutyAmount

•

Money V2

The duty charges for a customer to pay at checkout.

amount

•

Decimal!

non-null

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

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.

totalTaxAmount

•

Money V2

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

amount

•

Decimal!

non-null

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

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.

deliverableLines

•

[Deliverable Cart Line!]!

non-null

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

attribute

•

Attribute

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

Anchor to key key • String: The key of the cart attribute to retrieve. For example, "gift_wrapping".

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".

•

ID!

non-null

The ID of the cart line.

merchandise

•

Merchandise!

non-null

The item that the customer intends to purchase.

Custom Product

• OBJECT

isGiftCard

•

Boolean!

non-null

Whether the merchandise is a gift card.

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.

title

•

String!

non-null

weight

•

Float

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

weightUnit

•

Weight Unit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

Product Variant

• OBJECT

•

ID!

non-null

A globally-unique ID for the product variant.

metafield

•

Metafield

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.

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.

product

•

Product!

non-null

handle

•

Handle!

non-null

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.

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.

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.

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.

•

ID!

non-null

A globally-unique ID for the product.

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.

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.

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.

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.

isGiftCard

•

Boolean!

non-null

Whether the product is a gift card.

metafield

•

Metafield

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.

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.

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.

title

•

String!

non-null

vendor

•

String

The name of the product's vendor.

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.

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.

title

•

String

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

weight

•

Float

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

weightUnit

•

Weight Unit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

quantity

•

Int!

non-null

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

deliveryGroups

•

[Cart Delivery Group!]!

non-null

cartLines

•

[Cart Line!]!

non-null

attribute

•

Attribute

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

Anchor to key key • String: The key of the cart attribute to retrieve. For example, "gift_wrapping".

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".

cost

•

Cart Line Cost!

non-null

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.

amount

•

Decimal!

non-null

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

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.

compareAtAmountPerQuantity

•

Money V2

amount

•

Decimal!

non-null

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

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.

subtotalAmount

•

Money V2!

non-null

amount

•

Decimal!

non-null

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

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.

totalAmount

•

Money V2!

non-null

The total cost of items in a cart.

amount

•

Decimal!

non-null

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

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.

•

ID!

non-null

The ID of the cart line.

merchandise

•

Merchandise!

non-null

The item that the customer intends to purchase.

Custom Product

• OBJECT

isGiftCard

•

Boolean!

non-null

Whether the merchandise is a gift card.

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.

title

•

String!

non-null

weight

•

Float

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

weightUnit

•

Weight Unit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

Product Variant

• OBJECT

•

ID!

non-null

A globally-unique ID for the product variant.

metafield

•

Metafield

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.

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.

product

•

Product!

non-null

handle

•

Handle!

non-null

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.

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.

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.

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.

•

ID!

non-null

A globally-unique ID for the product.

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.

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.

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.

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.

isGiftCard

•

Boolean!

non-null

Whether the product is a gift card.

metafield

•

Metafield

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.

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.

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.

title

•

String!

non-null

vendor

•

String

The name of the product's vendor.

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.

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.

title

•

String

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

weight

•

Float

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

weightUnit

•

Weight Unit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

quantity

•

Int!

non-null

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

sellingPlanAllocation

•

Selling Plan Allocation

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

priceAdjustments

•

[Selling Plan Allocation Price Adjustment!]!

non-null

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.

amount

•

Decimal!

non-null

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

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.

price

•

Money V2!

non-null

amount

•

Decimal!

non-null

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

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.

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'.

description

•

String

The description of the selling plan.

•

ID!

non-null

A globally-unique identifier.

metafield

•

Metafield

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.

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.

name

•

String!

non-null

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

recurringDeliveries

•

Boolean!

non-null

Whether purchasing the selling plan will result in multiple deliveries.

deliveryAddress

•

Mailing Address

The shipping or destination address associated with the delivery group.

address1

•

String

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

address2

•

String

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

city

•

String

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

company

•

String

The name of the customer's company or organization.

countryCode

•

Country Code

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

firstName

•

String

The first name of the customer.

lastName

•

String

The last name of the customer.

latitude

•

Float

The approximate latitude of the address.

longitude

•

Float

The approximate longitude of the address.

name

•

String

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

phone

•

String

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

provinceCode

•

String

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

zip

•

String

The zip or postal code of the address.

market

•

Market

Deprecated

handle

•

Handle!

non-null

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

•

ID!

non-null

A globally-unique identifier.

metafield

•

Metafield

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.

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.

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.

deliveryOptions

•

[Cart Delivery Option!]!

non-null

code

•

String

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

cost

•

Money V2!

non-null

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

amount

•

Decimal!

non-null

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

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.

deliveryMethodType

•

Delivery Method!

non-null

LOCAL, NONE, PICK_UP, PICKUP_POINT, RETAIL, SHIPPING

description

•

String

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

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.

title

•

String

•

ID!

non-null

A globally-unique ID for the delivery group.

selectedDeliveryOption

•

Cart Delivery Option

Information about the delivery option that the customer has selected.

code

•

String

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

cost

•

Money V2!

non-null

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

amount

•

Decimal!

non-null

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

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.

deliveryMethodType

•

Delivery Method!

non-null

LOCAL, NONE, PICK_UP, PICKUP_POINT, RETAIL, SHIPPING

description

•

String

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

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.

title

•

String

lines

•

[Cart Line!]!

non-null

attribute

•

Attribute

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

Anchor to key key • String: The key of the cart attribute to retrieve. For example, "gift_wrapping".

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".

cost

•

Cart Line Cost!

non-null

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.

amount

•

Decimal!

non-null

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

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.

compareAtAmountPerQuantity

•

Money V2

amount

•

Decimal!

non-null

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

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.

subtotalAmount

•

Money V2!

non-null

amount

•

Decimal!

non-null

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

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.

totalAmount

•

Money V2!

non-null

The total cost of items in a cart.

amount

•

Decimal!

non-null

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

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.

•

ID!

non-null

The ID of the cart line.

merchandise

•

Merchandise!

non-null

The item that the customer intends to purchase.

Custom Product

• OBJECT

isGiftCard

•

Boolean!

non-null

Whether the merchandise is a gift card.

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.

title

•

String!

non-null

weight

•

Float

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

weightUnit

•

Weight Unit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

Product Variant

• OBJECT

•

ID!

non-null

A globally-unique ID for the product variant.

metafield

•

Metafield

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.

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.

product

•

Product!

non-null

handle

•

Handle!

non-null

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.

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.

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.

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.

•

ID!

non-null

A globally-unique ID for the product.

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.

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.

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.

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.

isGiftCard

•

Boolean!

non-null

Whether the product is a gift card.

metafield

•

Metafield

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.

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.

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.

title

•

String!

non-null

vendor

•

String

The name of the product's vendor.

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.

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.

title

•

String

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

weight

•

Float

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

weightUnit

•

Weight Unit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

quantity

•

Int!

non-null

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

sellingPlanAllocation

•

Selling Plan Allocation

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

priceAdjustments

•

[Selling Plan Allocation Price Adjustment!]!

non-null

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.

amount

•

Decimal!

non-null

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

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.

price

•

Money V2!

non-null

amount

•

Decimal!

non-null

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

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.

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'.

description

•

String

The description of the selling plan.

•

ID!

non-null

A globally-unique identifier.

metafield

•

Metafield

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.

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.

name

•

String!

non-null

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

recurringDeliveries

•

Boolean!

non-null

Whether purchasing the selling plan will result in multiple deliveries.

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

keys

•

[Localized Field Key!]!

required Default:[]

The keys of the localized fields to retrieve.

Fields

key

•

Localized Field Key!

non-null

The key of the localized field.

title

•

String!

non-null

The title of the localized field.

value

•

String

The value of the localized field.

discount

•

Discount!

non-null

discountClasses

•

[Discount Class!]!

non-null

The discount classes) that the discountNode) supports.

ORDER, PRODUCT, SHIPPING

metafield

•

Metafield

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.

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.

fetchResult

•

Http Response

body

•

String

The HTTP response body as a plain string. Use this field when the body is not in JSON format.

•

Http Response Header

An HTTP header.

Anchor to name name • String! required: A case-insensitive header name.

Anchor to name name • String! non-null: Header name.
Anchor to value value • String! non-null: Header value.

jsonBody

•

JSON

status

•

Int!

non-null

The HTTP status code.

headers

•

[Http Response Header!]!

non-null Deprecated

Anchor to name name • String! non-null: Header name.
Anchor to value value • String! non-null: Header value.

localization

•

Localization!

non-null

country

•

Country!

non-null

isoCode

•

Country Code!

non-null

The ISO code of the country.

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.

isoCode

•

Language Code!

non-null

The ISO code.

market

•

Market!

non-null Deprecated

handle

•

Handle!

non-null

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

•

ID!

non-null

A globally-unique identifier.

metafield

•

Metafield

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.

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.

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.

presentmentCurrencyRate

•

Decimal!

non-null

shop

•

Shop!

non-null

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

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.

metafield

•

Metafield

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.

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.

triggeringDiscountCode

•

String

Anchor to Delivery run FunctionDelivery run Function

The Function processes input schema data to calculate and allocate shipping discounts across cart lines, handling both fixed and percentage-based discounts while respecting discount caps and displaying messages associated with the discount.

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

Cart Delivery Options Discounts Generate Run Result

OBJECT

The CartDeliveryOptionsDiscountsGenerateRunResult object is the output of the Function run target. The object contains the operations to generate, validate, and apply shipping discounts to the cart.

operations

•

[Delivery Operation!]!

non-null

An ordered list of operations to generate delivery discounts, such as validating and applying discounts to the cart.

deliveryDiscountsAdd

•

Delivery Discounts Add Operation

Applies delivery discounts to a cart that share a method for determining which shipping and delivery discounts to apply when multiple discounts are eligible.

candidates

•

[Delivery Discount Candidate!]!

non-null

The list of discounts that are eligible to be applied to a delivery.

associatedDiscountCode

•

Associated Discount Code

The discount code that's eligible to be applied to a delivery.

Anchor to code code • String! non-null: The discount code.

message

•

String

targets

•

[Delivery Discount Candidate Target!]!

non-null

The targets of the discount that are eligible to be applied to a delivery.

deliveryGroup

•

Delivery Group Target

A method for applying a discount to a delivery group. 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.

Anchor to id id • ID! non-null: The ID of the target delivery group.

deliveryOption

•

Delivery Option Target

A method for applying a discount to a delivery option within a delivery group. Delivery options are the different ways that customers can choose to have their orders shipped. Examples of delivery options include express shipping or standard shipping.

Anchor to handle handle • Handle! non-null: The handle of the target delivery option.

value

•

Delivery Discount Candidate Value!

non-null

The value of the discount that's eligible to be applied to a delivery.

fixedAmount

•

Fixed Amount

A fixed amount value.

Anchor to amount amount • Decimal! non-null: The fixed amount value of the discount, in the currency of the cart.

The amount must be greater than or equal to 0.

percentage

•

Percentage

A percentage value.

Anchor to value value • Decimal! non-null: The percentage value.

The value is validated against: >= 0 and <= 100.

selectionStrategy

•

Delivery Discount Selection Strategy!

non-null

The method for determining which shipping and delivery discounts to apply when multiple discounts are eligible. For example, when the "ALL" strategy is selected, every shipping and delivery discount that qualifies is applied to the cart (for example, free shipping on orders over $50 and $5 off express shipping). This controls how shipping and delivery discounts interact when multiple conditions are satisfied simultaneously.

ALL

enteredDiscountCodesAccept

•

Entered Discount Codes Accept Operation

An operation that selects which entered discount codes to accept. Use this to validate discount codes from external systems.

codes

•

[Discount Code!]!

non-null

The list of discount codes to accept.

Anchor to code code • String! non-null: The discount code.

Examples

Apply a percentage-off shipping discount.
Create a tiered discount based on line subtotals
Create a dynamic discount from discount codes
Apply a collection-based order discount
Apply a discount to custom products
Apply a discount to the first cart line
Create a Buy X get Y discount
Create loyalty program discounts
Create an order discount with exclusions
Create combined multi-type discounts
Create a configurable discount with metafields
Create discounts managed by external services
Create a free shipping discount with currency thresholds

Input query

›

⌄

query Input {

cart {

cost {

subtotalAmount {

amount

}

deliveryGroups {

deliveryOptions {

handle

cost {

amount

}

discount {

metafield ( namespace: "$app:delivery-discounts", key: "configuration" ) {

jsonValue

}

Input object (response)

JSON

›

⌄

{

"cart": {

"cost": {

"subtotalAmount": {

"amount": "120.00"

}

"lines": [

{

"id": "gid://shopify/CartLine/0",

"cost": {

"subtotalAmount": {

"amount": "120.00"

}

"quantity": 1

}

"deliveryGroups": [

{

"deliveryOptions": [

{

"handle": "standard",

"cost": {

"amount": "10.00"

}

{

"handle": "express",

"cost": {

"amount": "20.00"

}

]

}

]

"discount": {

"metafield": {

"jsonValue": {

"tiers": [

{

"threshold": 50.0,

"percentage": 10.0

{

"threshold": 100.0,

"percentage": 15.0

}

]

}

Function code

›

⌄

use super :: schema ;

use shopify_function :: prelude ::* ;

use shopify_function :: Result ;

# [ derive ( Deserialize , Default ) ]

pub struct DiscountTier {

threshold: f64 ,

percentage: f64 ,

}

# [ derive ( Deserialize , Default ) ]

pub struct Configuration {

tiers: Vec< DiscountTier> ,

}

# [ shopify_function ]

fn cart_delivery_options_discounts_generate_run ( input: schema :: cart_delivery_options_discounts_generate_run :: Input ) -> Result< schema :: CartDeliveryOptionsDiscountsGenerateRunResult> {

// Parse configuration from metafield

let config: & Configuration = match input. discount ( ). metafield ( ) {

Some ( metafield ) => metafield. json_value ( ) ,

None => return Ok ( schema :: CartDeliveryOptionsDiscountsGenerateRunResult { operations: vec ! [ ] } ) ,

} ;

// Get cart subtotal

let subtotal = input. cart ( ). cost ( ). subtotal_amount ( ). amount ( ). 0 ;

// Find the highest applicable tier

let applicable_tier = config. tiers. iter ( )

. filter (| tier| subtotal >= tier. threshold )

. max_by (| a , b| a. threshold. partial_cmp ( & b. threshold ). unwrap_or ( std :: cmp :: Ordering :: Equal ) ) ;

// If no tier applies, return empty operations

let Some ( tier ) = applicable_tier else {

return Ok ( schema :: CartDeliveryOptionsDiscountsGenerateRunResult { operations: vec ! [ ] } ) ;

} ;

let mut operations = vec ! [ ] ;

// Process each delivery group

for delivery_group in input. cart ( ). delivery_groups ( ) {

// Find the cheapest delivery option

if let Some ( cheapest_option ) = delivery_group. delivery_options ( ). iter ( )

. min_by (| a , b| {

let a_cost = a. cost ( ). amount ( ). 0 ;

let b_cost = b. cost ( ). amount ( ). 0 ;

a_cost. partial_cmp ( & b_cost ). unwrap_or ( std :: cmp :: Ordering :: Equal )

} ) {

// Add discount operation for the cheapest option

operations. push ( schema :: DeliveryOperation :: DeliveryDiscountsAdd ( schema :: DeliveryDiscountsAddOperation {

selection_strategy: schema :: DeliveryDiscountSelectionStrategy :: All ,

candidates: vec ! [ schema :: DeliveryDiscountCandidate {

targets: vec ! [ schema :: DeliveryDiscountCandidateTarget :: DeliveryOption (

schema :: DeliveryOptionTarget {

handle: cheapest_option. handle ( ). clone ( ) ,

} ,

) ] ,

value: schema :: DeliveryDiscountCandidateValue :: Percentage ( schema :: Percentage {

value: Decimal ( tier. percentage ) ,

} ) ,

message: Some ( format ! ( "{}% off shipping" , tier. percentage ) ) ,

associated_discount_code: None ,

} ] ,

} ) ) ;

}

Ok ( schema :: CartDeliveryOptionsDiscountsGenerateRunResult { operations } )

}

use super::schema; use shopify_function::prelude::*; use shopify_function::Result; #[derive(Deserialize, Default)] pub struct DiscountTier { threshold: f64, percentage: f64, } #[derive(Deserialize, Default)] pub struct Configuration { tiers: Vec<DiscountTier>, } #[shopify_function] fn cart_delivery_options_discounts_generate_run(input: schema::cart_delivery_options_discounts_generate_run::Input) -> Result<schema::CartDeliveryOptionsDiscountsGenerateRunResult> { // Parse configuration from metafield let config: &Configuration = match input.discount().metafield() { Some(metafield) => metafield.json_value(), None => return Ok(schema::CartDeliveryOptionsDiscountsGenerateRunResult { operations: vec![] }), }; // Get cart subtotal let subtotal = input.cart().cost().subtotal_amount().amount().0; // Find the highest applicable tier let applicable_tier = config.tiers.iter() .filter(|tier| subtotal >= tier.threshold) .max_by(|a, b| a.threshold.partial_cmp(&b.threshold).unwrap_or(std::cmp::Ordering::Equal)); // If no tier applies, return empty operations let Some(tier) = applicable_tier else { return Ok(schema::CartDeliveryOptionsDiscountsGenerateRunResult { operations: vec![] }); }; let mut operations = vec![]; // Process each delivery group for delivery_group in input.cart().delivery_groups() { // Find the cheapest delivery option if let Some(cheapest_option) = delivery_group.delivery_options().iter() .min_by(|a, b| { let a_cost = a.cost().amount().0; let b_cost = b.cost().amount().0; a_cost.partial_cmp(&b_cost).unwrap_or(std::cmp::Ordering::Equal) }) { // Add discount operation for the cheapest option operations.push(schema::DeliveryOperation::DeliveryDiscountsAdd(schema::DeliveryDiscountsAddOperation { selection_strategy: schema::DeliveryDiscountSelectionStrategy::All, candidates: vec![schema::DeliveryDiscountCandidate { targets: vec![schema::DeliveryDiscountCandidateTarget::DeliveryOption( schema::DeliveryOptionTarget { handle: cheapest_option.handle().clone(), }, )], value: schema::DeliveryDiscountCandidateValue::Percentage(schema::Percentage { value: Decimal(tier.percentage), }), message: Some(format!("{}% off shipping", tier.percentage)), associated_discount_code: None, }], })); } } Ok(schema::CartDeliveryOptionsDiscountsGenerateRunResult { operations }) }

use super::schema; use shopify_function::prelude::*; use shopify_function::Result; #[derive(Deserialize, Default)] pub struct DiscountTier { threshold: f64, percentage: f64, } #[derive(Deserialize, Default)] pub struct Configuration { tiers: Vec<DiscountTier>, } #[shopify_function] fn cart_delivery_options_discounts_generate_run(input: schema::cart_delivery_options_discounts_generate_run::Input) -> Result<schema::CartDeliveryOptionsDiscountsGenerateRunResult> { // Parse configuration from metafield let config: &Configuration = match input.discount().metafield() { Some(metafield) => metafield.json_value(), None => return Ok(schema::CartDeliveryOptionsDiscountsGenerateRunResult { operations: vec![] }), }; // Get cart subtotal let subtotal = input.cart().cost().subtotal_amount().amount().0; // Find the highest applicable tier let applicable_tier = config.tiers.iter() .filter(|tier| subtotal >= tier.threshold) .max_by(|a, b| a.threshold.partial_cmp(&b.threshold).unwrap_or(std::cmp::Ordering::Equal)); // If no tier applies, return empty operations let Some(tier) = applicable_tier else { return Ok(schema::CartDeliveryOptionsDiscountsGenerateRunResult { operations: vec![] }); }; let mut operations = vec![]; // Process each delivery group for delivery_group in input.cart().delivery_groups() { // Find the cheapest delivery option if let Some(cheapest_option) = delivery_group.delivery_options().iter() .min_by(|a, b| { let a_cost = a.cost().amount().0; let b_cost = b.cost().amount().0; a_cost.partial_cmp(&b_cost).unwrap_or(std::cmp::Ordering::Equal) }) { // Add discount operation for the cheapest option operations.push(schema::DeliveryOperation::DeliveryDiscountsAdd(schema::DeliveryDiscountsAddOperation { selection_strategy: schema::DeliveryDiscountSelectionStrategy::All, candidates: vec![schema::DeliveryDiscountCandidate { targets: vec![schema::DeliveryDiscountCandidateTarget::DeliveryOption( schema::DeliveryOptionTarget { handle: cheapest_option.handle().clone(), }, )], value: schema::DeliveryDiscountCandidateValue::Percentage(schema::Percentage { value: Decimal(tier.percentage), }), message: Some(format!("{}% off shipping", tier.percentage)), associated_discount_code: None, }], })); } } Ok(schema::CartDeliveryOptionsDiscountsGenerateRunResult { operations }) }

Function run result

JSON

Was this section helpful?

Anchor to ValidationsValidations

The following is a summary of validations that are run on Functions results. Violating any of the following checks will yield an error when the Function runs:

There can only be one of each operation (addDiscountCodeValidations, addDeliveryDiscounts, addOrderDiscounts, or addProductDiscounts) in a single Function result.
addDiscountCodeValidations.codes must only contain discount codes that are a subset of enteredDiscountCodes.
The associatedDiscountCode.code field in the addProductDiscounts, addOrderDiscounts and addDeliveryDiscounts operations must only contain discount codes that are a subset of addDiscountCodeValidations.codes.

Was this section helpful?

Anchor to Migrate from deprecated Discount Function APIsMigrate from deprecated Discount Function APIs

The following sections outline the changes to the Product Discount, Order Discount, and Shipping Discount Function APIs, and how you can migrate from Shopify Scripts to Discount Functions.

Anchor to Product Discount Function API and Order Discount Function APIProduct Discount Function API and Order Discount Function API

The Product Discount Function API and Order Discount Function API are now merged into the Discount Function API in the cart.lines.discounts.generate.run target. The target returns a CartLinesDiscountsGenerateRunResult object, which returns an operations field that includes fields that aren't present in the deprecated FunctionRunResult object. The following table outlines key changes:

Anchor to Input queryInput query

Product Discount Function API and Order Discount Function API	Discount Function API	Description	Available in run target	Available in fetch target
`discounts`	`operations`	Lists of discount operations to be applied	Yes	No
`discountApplicationStrategy`	`ProductDiscountSelectionStrategy` or `OrderDiscountSelectionStrategy`	Specifies which outputs to apply `FIRST`, `MAXIMUM`, or `ALL` (product discounts only)	No	Yes
N/A	`candidates`	The list of product or order discount candidates to be applied.	Yes	No
N/A	`associatedDiscountCode`	A list of valid discount codes that correspond to external discounts. This can only be used by Functions with network access.	No	Yes
N/A	`orderDiscountsAdd`	A group of order discounts that share a selection strategy.	Yes	No
N/A	`productDiscountsAdd`	A group of product discounts that share a selection strategy.	Yes	No

Anchor to CartLinesDiscountsGenerateRunResult outputCart Lines Discounts Generate Run Result output

Product Discount Function API and Order Discount Function API	Discount Function API	Description	Available in run target	Available in fetch target
`discounts`	`operations`	Lists of discount operations to be applied	Yes	No
`discountApplicationStrategy`	`ProductDiscountSelectionStrategy` or `OrderDiscountSelectionStrategy`	Specifies which outputs to apply FIRST, MAXIMUM, or ALL (product discounts only)	No	Yes
N/A	`candidates`	The list of product or order discount candidates to be applied.	Yes	No
N/A	`associatedDiscountCode`	A list of valid discount codes that correspond to external discounts. This can only be used by Functions with network access.	No	Yes
N/A	`orderDiscountsAdd`	A group of order discounts that share a selection strategy.	Yes	No
N/A	`productDiscountsAdd`	A group of product discounts that share a selection strategy.	Yes	No

Anchor to Shipping Discount Function APIShipping Discount Function API

The Shipping Discount Function API is now merged into the Discount Function API in the cart.delivery-options.discounts.generate.run target. The target returns a CartDeliveryOptionsDiscountsGenerateRunResult object, which includes fields that aren't present in the deprecated FunctionRunResult object. The following table outlines key changes:

Anchor to Input queryInput query

Shipping Discount Function API	Discount Function API	Description	Available in run target	Available in fetch target
N/A	`enteredDiscountCodes`	The discounts entered at checkout by the buyer	No	Yes
`discountNode`	`discount`	The discount associated to the Function that can be queried by the input query	Yes	Yes
N/A	`triggeringDiscountCode`	The discount code that triggered the Function	Yes	Yes

Anchor to CartDeliveryOptionsDiscountsGenerateRunResultCart Delivery Options Discounts Generate Run Result

Shipping Discount Function API	Discount Function API	Description	Available in run target	Available in fetch target
`discounts`	`operations`	Lists of discount operations to be applied	Yes	No
N/A	`deliveryDiscountsAdd`	A group of delivery discounts that share a selection strategy.	Yes	No
N/A	`enteredDiscountCodesAccept`	A list of valid discount codes that correspond to external discounts.	No	Yes
N/A	`candidates`	The list of delivery discount candidates to be applied.	Yes	No
N/A	`selectionStrategy`	The strategy that's applied to the list of discounts.	Yes	No
`productVariant`	`cartLineIds`	Target identifiers for the discount application	Yes	No

Anchor to Migrate from line item scripts to Discount FunctionsMigrate from line item scripts to Discount Functions

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

Shopify Scripts method	Description	Shopify Functions target	Additional context
`change_line_price`	Applies a discount to a cart line such as a loyalty discount on a product by specifying a new reduced price, and a message either set by the developer or the merchant in the Function's configuration.	Discount	Apply order discounts or product discounts by specifying the `OrderDiscountCandidateValue` or `ProductDiscountCandidateValue` (`percentage` or `fixedAmount` off), and an optional message.
`split`	Splits a product into multiple lines so that you can apply discounts to partial quantities. For example, if a customer has five t-shirts in their cart, you can apply a discount to only two items while keeping the other three at full price	Discount	Use the optional `quantity` field in the `ProductDiscountCandidateTarget` object to limit the number of units the discount may be applied to.
`change_properties`	Adds or changes a line item property	Not available	Refer to applyAttributeChange in the checkout UI extensions API to apply attribute changes.
`reject`	Disallows a discounts code from being applied at checkout	Not available	Use a Discount Function that contains the necessary logic. For example, you can use conditions to exclude a discount from applying, such as preventing a discount code when cart value is below $50 or when specific products are in the cart.

Anchor to Migrate from shipping scripts to Discount FunctionsMigrate from shipping scripts to Discount Functions

To migrate an existing shipping script to Shopify Functions, then you can use the following mapping:

Shopify Scripts method	Description	Shopify Functions target
`apply_discount`	Applies a discount to a shipping rate	Shipping discounts

Was this section helpful?