Choose a version:

Anchor to Order Routing Location Rule Function APIOrder Routing Location Rule Function API

Order routing determines the location to fulfill each item in a cart. A set of rules are used to evaluate an order and prioritize fulfillment locations. Shopify selects the location with the highest priority ranking to fulfill the order.

Location rules let you send items to different fulfillment locations during order routing. For example, Product A can go to Location X, and Product B can go to Location Y. If a product has multiple units, such as four units of Product A, then three can go to Location X and one to Location Y. To define custom order routing rules, you can only use the Order Routing Location Rule Function API.

Shopify Functions enable you to customize Shopify's backend logic. The Order Routing Location Rule API integrates this logic into the checkout flow, as well as for draft orders, order editing, and order imports. You can also access this logic using the API after checkout, or re-trigger it in the Shopify admin.

Use the API to prioritize locations for order routing, with associated data such as buyer identity, fulfillment groups, and location addresses.

Beta

The Order Routing Location Rule API is only available by request for merchants that have a Shopify Plus plan.

Merchants must be enrolled in the Partners program to deploy their own custom apps and location rules.

Anchor to Use casesUse cases

Fulfill orders from the nearest location that serves the shop's market.
Prioritize a group of locations for order routing, such as warehouses or retail stores.
Rank locations relative to each other based on product metafields.
Deprioritize a location if it's exceeded the maximum daily order capacity.
Prioritize locations that can fulfill items faster or have a certain inventory rotation level.

Compatibility with Shopify surfaces

Supported (8)

Partially supported (3)

Unsupported (2)

Draft Order (Checkout)

Order Edit (Admin)

This option is available only for new items.

Order Edit (Checkout)

POS

POS is available only when shipping to a customer.

Shopify Admin

Storefront

This option is available only with Buy with Prime.

Storefront Accelerated Checkout

Subscription (Recurring Orders)

Was this section helpful?

Anchor to Getting startedGetting started

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

TutorialBuild an Order Routing Location Rule Function

Was this section helpful?

Anchor to TargetsTargets

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

Anchor to Run targetRun target

purchase.order-routing-location-rule.run

The run target ranks locations using Shopify data or hardcoded values. Locations must be associated with a fulfillment group to be ranked. The target returns a list of operations to be applied to locations associated with fulfillment groups.

For example, you might use this to prioritize warehouses over storefront locations. Locations in the first group will be prioritized over locations in the second group.

Input

OBJECT

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

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 keykey • String: The key of the cart attribute to retrieve. For example, "gift_wrapping".

Anchor to keykey • String! non-null: The key or name of the attribute. For example, "customer_first_order".
Anchor to valuevalue • String: The value of the attribute. For example, "true".

buyerIdentity

•

BuyerIdentity

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

•

MoneyV2!

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

•

CurrencyCode!

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, 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

•

[HasTagResponse!]!

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 tagstags • [String!]! required: 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 hasTaghasTag • Boolean! non-null: Whether the Shopify resource has the tag.
Anchor to tagtag • 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 namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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

•

PurchasingCompany

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

•

DateTime!

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 namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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

•

DateTime!

non-null

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

contact

•

CompanyContact

The company contact associated to the order or draft order.

Anchor to createdAtcreatedAt • DateTime! non-null: The date and time (ISO 8601 format) at which the company contact was created in Shopify.
Anchor to idid • ID! non-null: The ID of the company.
Anchor to localelocale • String: The company contact's locale (language).
Anchor to titletitle • String: The company contact's job title.
Anchor to updatedAtupdatedAt • DateTime! non-null: The date and time (ISO 8601 format) at which the company contact was last modified.

location

•

CompanyLocation!

non-null

The company location associated to the order or draft order.

createdAt

•

DateTime!

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 namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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

•

DateTime!

non-null

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

cost

•

CartCost!

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

•

MoneyV2!

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

•

CurrencyCode!

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

•

MoneyV2!

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

•

CurrencyCode!

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

•

MoneyV2

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

•

CurrencyCode!

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

•

MoneyV2

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

•

CurrencyCode!

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

•

[DeliverableCartLine!]!

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 keykey • String: The key of the cart attribute to retrieve. For example, "gift_wrapping".

Anchor to keykey • String! non-null: The key or name of the attribute. For example, "customer_first_order".
Anchor to valuevalue • 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.

CustomProduct

•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

•

WeightUnit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

ProductVariant

•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 namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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

•

[HasTagResponse!]!

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 tagstags • [String!]! required: 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 hasTaghasTag • Boolean! non-null: Whether the Shopify resource has the tag.
Anchor to tagtag • 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

•

[CollectionMembership!]!

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 idsids • [ID!]! required: 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 collectionIdcollectionId • ID! non-null: A globally-unique ID for the collection.
Anchor to isMemberisMember • 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 namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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.

gates

•

[GateSubject!]!

non-nullDeprecated

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

•

WeightUnit!

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

•

[CartDeliveryGroup!]!

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

•

[CartLine!]!

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 keykey • String: The key of the cart attribute to retrieve. For example, "gift_wrapping".

Anchor to keykey • String! non-null: The key or name of the attribute. For example, "customer_first_order".
Anchor to valuevalue • String: The value of the attribute. For example, "true".

cost

•

CartLineCost!

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

•

MoneyV2!

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

•

CurrencyCode!

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

•

MoneyV2

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

•

CurrencyCode!

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

•

MoneyV2!

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

•

CurrencyCode!

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

•

MoneyV2!

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

•

CurrencyCode!

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.

CustomProduct

•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

•

WeightUnit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

ProductVariant

•OBJECT

•

ID!

non-null

A globally-unique ID for the product variant.

metafield

•

Metafield

Anchor to namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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

•

[HasTagResponse!]!

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 tagstags • [String!]! required: 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 hasTaghasTag • Boolean! non-null: Whether the Shopify resource has the tag.
Anchor to tagtag • 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

•

[CollectionMembership!]!

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 idsids • [ID!]! required: 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 collectionIdcollectionId • ID! non-null: A globally-unique ID for the collection.
Anchor to isMemberisMember • 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 namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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.

gates

•

[GateSubject!]!

non-nullDeprecated

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

•

WeightUnit!

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

•

SellingPlanAllocation

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

priceAdjustments

•

[SellingPlanAllocationPriceAdjustment!]!

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

•

MoneyV2!

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

•

CurrencyCode!

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

•

MoneyV2!

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

•

CurrencyCode!

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

•

SellingPlan!

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 namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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

•

MailingAddress

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

•

CountryCode

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

deliveryOptions

•

[CartDeliveryOption!]!

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

•

MoneyV2!

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

•

CurrencyCode!

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

•

DeliveryMethod!

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

•

CartDeliveryOption

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

•

MoneyV2!

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

•

CurrencyCode!

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

•

DeliveryMethod!

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

•

[CartLine!]!

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 keykey • String: The key of the cart attribute to retrieve. For example, "gift_wrapping".

Anchor to keykey • String! non-null: The key or name of the attribute. For example, "customer_first_order".
Anchor to valuevalue • String: The value of the attribute. For example, "true".

cost

•

CartLineCost!

non-null

amountPerQuantity

•

MoneyV2!

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

•

CurrencyCode!

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

•

MoneyV2

amount

•

Decimal!

non-null

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

currencyCode

•

CurrencyCode!

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

•

MoneyV2!

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

•

CurrencyCode!

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

•

MoneyV2!

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

•

CurrencyCode!

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.

CustomProduct

•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

•

WeightUnit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

ProductVariant

•OBJECT

•

ID!

non-null

A globally-unique ID for the product variant.

metafield

•

Metafield

Anchor to namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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

•

[HasTagResponse!]!

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 tagstags • [String!]! required: 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 hasTaghasTag • Boolean! non-null: Whether the Shopify resource has the tag.
Anchor to tagtag • 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

•

[CollectionMembership!]!

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 idsids • [ID!]! required: 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 collectionIdcollectionId • ID! non-null: A globally-unique ID for the collection.
Anchor to isMemberisMember • 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 namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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.

gates

•

[GateSubject!]!

non-nullDeprecated

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

•

WeightUnit!

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

•

SellingPlanAllocation

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

priceAdjustments

•

[SellingPlanAllocationPriceAdjustment!]!

non-null

perDeliveryPrice

•

MoneyV2!

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

•

CurrencyCode!

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

•

MoneyV2!

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

•

CurrencyCode!

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

•

SellingPlan!

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 namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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

•

[LocalizedField!]!

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

•

[LocalizedFieldKey!]!

required

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

•

LocalizedFieldKey!

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.

retailLocation

•

Location

The physical location where a retail order is created or completed.

address

•

LocationAddress!

non-null

The address of this location.

Anchor to address1address1 • String: The first line of the address for the location.
Anchor to address2address2 • String: The second line of the address for the location.
Anchor to citycity • String: The city of the location.
Anchor to countrycountry • String: The country of the location.
Anchor to countryCodecountryCode • String: The country code of the location.
Anchor to formattedformatted • [String!]! non-null: A formatted version of the address for the location.
Anchor to latitudelatitude • Float: The approximate latitude coordinates of the location.
Anchor to longitudelongitude • Float: The approximate longitude coordinates of the location.
Anchor to phonephone • String: The phone number of the location.
Anchor to provinceprovince • String: The province of the location.
Anchor to provinceCodeprovinceCode • String: The code for the province, state, or district of the address of the location.
Anchor to zipzip • String: The ZIP code of the location.

handle

•

Handle!

non-null

The location handle.

•

ID!

non-null

The location id.

localPickup

•

LocalPickup!

non-null

Local pickup settings associated with a location.

Anchor to enabledenabled • Boolean! non-null: Whether local pickup is enabled for the location.

metafield

•

Metafield

Anchor to namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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 location.

fulfillmentGroups

•

[FulfillmentGroup!]!

non-null

A list of fulfillment locations that contain one or more items to be shipped together. Each item in the cart is assigned to one fulfillment group.

deliveryAddress

•

MailingAddress

The delivery address for the fulfillment 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

•

CountryCode

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

The fulfillment group handle.

inventoryLocationHandles

•

[Handle!]!

non-null

A list of inventory location handles for the fulfillment group.

lines

•

[CartLine!]!

non-null

A list of lines containing information about the items that are part of the fulfillment group.

attribute

•

Attribute

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

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

Anchor to keykey • String! non-null: The key or name of the attribute. For example, "customer_first_order".
Anchor to valuevalue • String: The value of the attribute. For example, "true".

cost

•

CartLineCost!

non-null

amountPerQuantity

•

MoneyV2!

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

•

CurrencyCode!

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

•

MoneyV2

amount

•

Decimal!

non-null

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

currencyCode

•

CurrencyCode!

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

•

MoneyV2!

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

•

CurrencyCode!

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

•

MoneyV2!

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

•

CurrencyCode!

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.

CustomProduct

•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

•

WeightUnit!

non-null

The unit of measurement for weight.

GRAMS, KILOGRAMS, OUNCES, POUNDS

ProductVariant

•OBJECT

•

ID!

non-null

A globally-unique ID for the product variant.

metafield

•

Metafield

Anchor to namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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

•

[HasTagResponse!]!

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 tagstags • [String!]! required: 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 hasTaghasTag • Boolean! non-null: Whether the Shopify resource has the tag.
Anchor to tagtag • 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

•

[CollectionMembership!]!

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 idsids • [ID!]! required: 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 collectionIdcollectionId • ID! non-null: A globally-unique ID for the collection.
Anchor to isMemberisMember • 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 namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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.

gates

•

[GateSubject!]!

non-nullDeprecated

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

•

WeightUnit!

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

•

SellingPlanAllocation

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

priceAdjustments

•

[SellingPlanAllocationPriceAdjustment!]!

non-null

perDeliveryPrice

•

MoneyV2!

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

•

CurrencyCode!

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

•

MoneyV2!

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

•

CurrencyCode!

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

•

SellingPlan!

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 namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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.

deliveryGroup

•

CartDeliveryGroup!

non-nullDeprecated

•

ID!

non-nullDeprecated

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

•

CountryCode!

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

•

LanguageCode!

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-nullDeprecated

locationRule

•

OrderRoutingLocationRule!

non-null

The backend logic that the Function uses to route orders. It includes the metafields that are associated with the customization.

metafield

•

Metafield

Anchor to namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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.

locations

•

[Location!]!

non-null

A list of all geographical locations where the inventory is stored, including warehouses, retail locations, and distribution centers. The list captures the locations that can fulfill items in the cart.

address

•

LocationAddress!

non-null

The address of this location.

Anchor to address1address1 • String: The first line of the address for the location.
Anchor to address2address2 • String: The second line of the address for the location.
Anchor to citycity • String: The city of the location.
Anchor to countrycountry • String: The country of the location.
Anchor to countryCodecountryCode • String: The country code of the location.
Anchor to formattedformatted • [String!]! non-null: A formatted version of the address for the location.
Anchor to latitudelatitude • Float: The approximate latitude coordinates of the location.
Anchor to longitudelongitude • Float: The approximate longitude coordinates of the location.
Anchor to phonephone • String: The phone number of the location.
Anchor to provinceprovince • String: The province of the location.
Anchor to provinceCodeprovinceCode • String: The code for the province, state, or district of the address of the location.
Anchor to zipzip • String: The ZIP code of the location.

handle

•

Handle!

non-null

The location handle.

•

ID!

non-null

The location id.

localPickup

•

LocalPickup!

non-null

Local pickup settings associated with a location.

Anchor to enabledenabled • Boolean! non-null: Whether local pickup is enabled for the location.

metafield

•

Metafield

Anchor to namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • 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 location.

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

•

LocalTime!

non-null

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

Anchor to datedate • Date! non-null: The current date relative to the parent object.
Anchor to dateTimeAfterdateTimeAfter • 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 dateTimeBeforedateTimeBefore • Boolean! non-null: Returns true if the current date and time is before the given date and time, and false otherwise.
Anchor to dateTimeBetweendateTimeBetween • Boolean! non-null: Returns true if the current date and time is between the two given date and times, and false otherwise.
Anchor to timeAftertimeAfter • Boolean! non-null: Returns true if the current time is at or past the given time, and false otherwise.
Anchor to timeBeforetimeBefore • Boolean! non-null: Returns true if the current time is at or past the given time, and false otherwise.
Anchor to timeBetweentimeBetween • Boolean! non-null: Returns true if the current time is between the two given times, and false otherwise.

metafield

•

Metafield

Anchor to namespacenamespace • 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 keykey • 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 jsonValuejsonValue • JSON! non-null: The data that's stored in the metafield, using JSON format.
Anchor to typetype • String! non-null: The type of data that the metafield stores in the value field.
Anchor to valuevalue • String! non-null: The data that's stored in the metafield. The data is always stored as a string, regardless of the metafield's type.

Anchor to FunctionFunction

The logic that processes the input data. The Function generates a list of operations that rank locations. Each location is associated with a fulfillment group.

Each operation specifies how to rank locations. Shopify processes your response to determine how to best fulfill and ship orders.

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

FunctionRunResult

OBJECT

The FunctionRunResult object is the output of the Function run target. The object contains the operations that rank locations for each fulfillment group.

operations

•

[Operation!]!

non-null

The ordered list of operations that rank locations for each fulfillment group, which includes one or more items to be shipped together. The locations with the highest ranking are selected to fulfill the order.

rank

•

FulfillmentGroupRankedLocations!

non-null

A request to rank the locations associated with a fulfillment group. The ranking determines the priority in which the locations are selected to fulfill the order.

fulfillmentGroupHandle

•

Handle!

non-null

The identifier for the fulfillment group.

rankings

•

[RankedLocation!]!

non-null

The ranked locations for this fulfillment group.

Anchor to locationHandlelocationHandle • Handle! non-null: The location handle.
Anchor to rankrank • Int! non-null: The location's rank.

Examples

Create a location priority rule for perishable products
Deprioritize fulfillment locations for age-restricted products
Prioritize locations for B2B orders
Prioritize locations based on delivery address

Input query

query Input {

fulfillmentGroups {

handle

inventoryLocationHandles

lines {

merchandise {

__typename

... on ProductVariant {

product {

hasTags(tags: ["perishable"]) {

hasTag

tag

}

locations {

handle

metafield(namespace: "custom", key: "is_perishable") {

jsonValue

}

Input object (response)

JSON

{

"fulfillmentGroups": [

{

"handle": "1",

"inventoryLocationHandles": [

"91260846373",

"91260879141"

"lines": [

{

"merchandise": {

"__typename": "ProductVariant",

"product": {

"id": "gid://shopify/Product/9837211844901",

"hasTags": [

{

"hasTag": true,

"tag": "perishable"

}

]

}

]

}

"locations": [

{

"handle": "91260846373",

"metafield": {

"jsonValue": {

"isPerishable": true

}

{

"handle": "91260879141",

"metafield": null

}

]

}

Function code

use crate::schema;

use shopify_function::prelude::*;

use shopify_function::Result;

use std::collections::HashMap;

#[derive(Deserialize, PartialEq)]

#[shopify_function(rename_all = "camelCase")]

pub struct Configuration {

is_perishable: bool,

}

#[shopify_function]

fn run(input: schema::run::Input) -> Result<schema::FunctionRunResult> {

// Create a map of location handles to their perishable status

let mut perishable_locations = HashMap::new();

for location in input.locations() {

let is_perishable = match &location.metafield() {

Some(metafield) => {

let metafield_value = metafield.json_value();

metafield_value.is_perishable

}

None => {

false

}

};

perishable_locations.insert(location.handle().clone(), is_perishable);

}

let operations = input

.fulfillment_groups()

.iter()

.map(|group| {

// Check if any products in this group have the perishable tag

let has_perishable_product = group

.lines()

.iter()

.filter_map(|line| {

match &line.merchandise() {

schema::run::input::fulfillment_groups::lines::Merchandise::ProductVariant(variant) => {

Some(variant.product())

_ => None,

}

})

.any(|product| {

product.has_tags().iter().any(|tag_resp| *tag_resp.has_tag())

});

let rankings = group

.inventory_location_handles()

.iter()

.map(|location_handle| {

let mut rank = 0;

// If we have perishable products, prioritize locations with perishable:true metafield

if has_perishable_product {

// Locations that can handle perishables get rank 0, others get rank 1 (lower priority)

if let Some(is_perishable_location) = perishable_locations.get(location_handle) {

if !is_perishable_location {

rank = 1; // Deprioritize locations that can't handle perishables

}

} else {

rank = 1; // If location not found in our map, deprioritize it

}

schema::RankedLocation {

location_handle: location_handle.clone(),

rank,

}

})

.collect::<Vec<schema::RankedLocation>>();

schema::Operation {

rank: schema::FulfillmentGroupRankedLocations {

fulfillment_group_handle: group.handle().clone(),

rankings,

}

})

.collect();

Ok(schema::FunctionRunResult { operations })

}

use crate::schema;
use shopify_function::prelude::*;
use shopify_function::Result;
use std::collections::HashMap;

#[derive(Deserialize, PartialEq)]
#[shopify_function(rename_all = "camelCase")]
pub struct Configuration {
    is_perishable: bool,
}

#[shopify_function]
fn run(input: schema::run::Input) -> Result<schema::FunctionRunResult> {
    // Create a map of location handles to their perishable status
    let mut perishable_locations = HashMap::new();

    for location in input.locations() {

        let is_perishable = match &location.metafield() {
            Some(metafield) => {
                let metafield_value = metafield.json_value();
                metafield_value.is_perishable
            }
            None => {
                false
            }
        };

        perishable_locations.insert(location.handle().clone(), is_perishable);
    }

    let operations = input
        .fulfillment_groups()
        .iter()
        .map(|group| {
            // Check if any products in this group have the perishable tag
            let has_perishable_product = group
                .lines()
                .iter()
                .filter_map(|line| {
                    match &line.merchandise() {
                        schema::run::input::fulfillment_groups::lines::Merchandise::ProductVariant(variant) => {
                            Some(variant.product())
                        },
                        _ => None,
                    }
                })
                .any(|product| {
                    product.has_tags().iter().any(|tag_resp| *tag_resp.has_tag())
                });

            let rankings = group
                .inventory_location_handles()
                .iter()
                .map(|location_handle| {
                    let mut rank = 0;

                    // If we have perishable products, prioritize locations with perishable:true metafield
                    if has_perishable_product {
                        // Locations that can handle perishables get rank 0, others get rank 1 (lower priority)
                        if let Some(is_perishable_location) = perishable_locations.get(location_handle) {
                            if !is_perishable_location {
                                rank = 1; // Deprioritize locations that can't handle perishables
                            }
                        } else {
                            rank = 1; // If location not found in our map, deprioritize it
                        }
                    }

                    schema::RankedLocation {
                        location_handle: location_handle.clone(),
                        rank,
                    }
                })
                .collect::<Vec<schema::RankedLocation>>();

            schema::Operation {
                rank: schema::FulfillmentGroupRankedLocations {
                    fulfillment_group_handle: group.handle().clone(),
                    rankings,
                },
            }
        })
        .collect();

    Ok(schema::FunctionRunResult { operations })
}

use crate::schema;
use shopify_function::prelude::*;
use shopify_function::Result;
use std::collections::HashMap;

#[derive(Deserialize, PartialEq)]
#[shopify_function(rename_all = "camelCase")]
pub struct Configuration {
    is_perishable: bool,
}

#[shopify_function]
fn run(input: schema::run::Input) -> Result<schema::FunctionRunResult> {
    // Create a map of location handles to their perishable status
    let mut perishable_locations = HashMap::new();

    for location in input.locations() {

        let is_perishable = match &location.metafield() {
            Some(metafield) => {
                let metafield_value = metafield.json_value();
                metafield_value.is_perishable
            }
            None => {
                false
            }
        };

        perishable_locations.insert(location.handle().clone(), is_perishable);
    }

    let operations = input
        .fulfillment_groups()
        .iter()
        .map(|group| {
            // Check if any products in this group have the perishable tag
            let has_perishable_product = group
                .lines()
                .iter()
                .filter_map(|line| {
                    match &line.merchandise() {
                        schema::run::input::fulfillment_groups::lines::Merchandise::ProductVariant(variant) => {
                            Some(variant.product())
                        },
                        _ => None,
                    }
                })
                .any(|product| {
                    product.has_tags().iter().any(|tag_resp| *tag_resp.has_tag())
                });

            let rankings = group
                .inventory_location_handles()
                .iter()
                .map(|location_handle| {
                    let mut rank = 0;

                    // If we have perishable products, prioritize locations with perishable:true metafield
                    if has_perishable_product {
                        // Locations that can handle perishables get rank 0, others get rank 1 (lower priority)
                        if let Some(is_perishable_location) = perishable_locations.get(location_handle) {
                            if !is_perishable_location {
                                rank = 1; // Deprioritize locations that can't handle perishables
                            }
                        } else {
                            rank = 1; // If location not found in our map, deprioritize it
                        }
                    }

                    schema::RankedLocation {
                        location_handle: location_handle.clone(),
                        rank,
                    }
                })
                .collect::<Vec<schema::RankedLocation>>();

            schema::Operation {
                rank: schema::FulfillmentGroupRankedLocations {
                    fulfillment_group_handle: group.handle().clone(),
                    rankings,
                },
            }
        })
        .collect();

    Ok(schema::FunctionRunResult { operations })
}

Function run result

JSON

Was this section helpful?

Anchor to How fulfillment groups are rankedHow fulfillment groups are ranked

For each fulfillment group, Shopify first sorts the output of each Function based on the locationRule priority. Shopify then takes the first output, and sorts the locations of the fulfillment group based on the rank.

If there are ties between the rankings, then Shopify breaks them using the ranks from the second output, and so on. If there are no ties, then only the output of the first locationRule is considered.

Was this section helpful?