MetafieldParentResource

The article's author.

The blog that the article belongs to.

List of comments posted on the article.

Stripped content of the article, single line with HTML tags removed.

The content of the article, complete with HTML formatting.

Stripped excerpt of the article, single line with HTML tags removed.

The excerpt of the article, complete with HTML formatting.

A human-friendly unique string for the Article automatically generated from its title.

A globally-unique ID.

The image associated with the article.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.

The date and time when the article was published.

The article’s SEO information.

A categorization that a article can be tagged with.

The article’s name.

URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

Find an article by its handle.

List of the blog's articles.

The authors who have contributed to the blog.

A human-friendly unique string for the Blog automatically generated from its title.

A globally-unique ID.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.

The blog's SEO information.

The blogs’s title.

The gift cards that have been applied to the cart.

An attribute associated with the cart.

The attributes associated with the cart. Attributes are represented as key-value pairs.

Information about the buyer that's interacting with the cart.

The URL of the checkout for the cart.

The estimated costs that the buyer will pay at checkout. The costs are subject to change and changes will be reflected at checkout. The cost field uses the buyerIdentity field to determine international pricing.

The date and time when the cart was created.

The delivery properties of the cart.

The delivery groups available for the cart, based on the buyer identity default delivery address preference or the default address of the logged-in customer.

The discounts that have been applied to the entire cart.

The case-insensitive discount codes that the customer added at checkout.

A globally-unique ID.

A list of lines containing information about the items the customer intends to purchase.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

A note that's associated with the cart. For example, the note can be a personalized message to the buyer.

The total number of items in the cart.

The date and time when the cart was updated.

Stripped description of the collection, single line with HTML tags removed.

The description of the collection, complete with HTML formatting.

A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

A globally-unique ID.

Image associated with the collection.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.

List of products in the collection.

The collection's SEO information.

The collection’s name. Limit of 255 characters.

URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

The date and time when the collection was last modified.

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

A unique externally-supplied ID for the company.

A globally-unique ID.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The name of the company.

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

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

A unique externally-supplied ID for the company.

A globally-unique ID.

The preferred locale of the company location.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The name of the company location.

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

Indicates whether the customer has consented to be sent marketing material via email.

A list of addresses for the customer.

The date and time when the customer was created.

The customer’s default address.

The customer’s name, email or phone number.

The customer’s email address.

The customer’s first name.

A unique ID for the customer.

The customer’s last name.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The number of orders that the customer has made at the store in their lifetime.

The orders associated with the customer.

The customer’s phone number.

A comma separated list of tags that have been added to the customer. Additional access scope required: unauthenticated_read_customer_tags.

The date and time when the customer information was updated.

The address of the location.

A globally-unique ID.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The name of the location.

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

A globally-unique ID.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The address associated with the payment method.

The date and time when the order was canceled. Returns null if the order wasn't canceled.

The reason for the order's cancellation. Returns null if the order wasn't canceled.

The code of the currency used for the payment.

The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes aren't included unless the order is a taxes-included order.

The total cost of duties for the order, including refunds.

The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed.

The total cost of shipping, excluding shipping lines that have been refunded or removed. Taxes aren't included unless the order is a taxes-included order.

The total of all taxes applied to the order, excluding taxes for returned line items.

A list of the custom attributes added to the order. For example, whether an order is a customer's first.

The locale code in which this specific order happened.

The unique URL that the customer can use to access the order.

Discounts that have been applied on the order.

Whether the order has had any edits applied or not.

The customer's email address.

The financial status of the order.

The fulfillment status for the order.

A globally-unique ID.

List of the order’s line items.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

Unique identifier for the order that appears on the order. For example, #1000 or _Store1001.

A unique numeric identifier for the order for use by shop owner and customer.

The total cost of duties charged at checkout.

The total price of the order before any applied edits.

The customer's phone number for receiving SMS notifications.

The date and time when the order was imported. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on current date and time.

The address to where the order will be shipped.

The discounts that have been allocated onto the shipping line by discount applications.

The unique URL for the order's status page.

Price of the order before shipping and taxes.

List of the order’s successful fulfillments.

The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).

The total amount that has been refunded.

The total cost of shipping.

The total cost of taxes.

The description of the page, complete with HTML formatting.

Summary of the page body.

The timestamp of the page creation.

A human-friendly unique string for the page automatically generated from its title.

A globally-unique ID.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.

The page's SEO information.

The title of the page.

URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

The timestamp of the latest page update.

A list of variants whose selected options differ with the provided selected options by one, ordered by variant id. If selected options are not provided, adjacent variants to the first available variant is returned.

Note that this field returns an array of variants. In most cases, the number of variants in this array will be low. However, with a low number of options and a high number of values per option, the number of variants returned here can be high. In such cases, it recommended to avoid using this field.

This list of variants can be used in combination with the options field to build a rich variant picker that includes variant availability or other variant information.

Indicates if at least one product variant is available for sale.

The category of a product from Shopify's Standard Product Taxonomy.

A list of collections that include the product.

The compare-at price range of the product in the shop's default currency.

The date and time when the product was created.

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

The description of the product, with HTML tags. For example, the description might include bold <strong></strong> and italic <i></i> text.

An encoded string containing all option value combinations with a corresponding variant that is currently available for sale.

Integers represent option and values: [0,1] represents option_value at array index 0 for the option at array index 0

:, ,, and - are control characters. : indicates a new option. ex: 0:1 indicates value 0 for the option in position 1, value 1 for the option in position 2. , indicates the end of a repeated prefix, mulitple consecutive commas indicate the end of multiple repeated prefixes. indicates a gap in the sequence of option values. ex: 0 4 indicates option values in position 0 and 4 are present. - indicates a continuous range of option values. ex: 0 1-3 4

Decoding process:

Example options: [Size, Color, Material] Example values: [[Small, Medium, Large], [Red, Blue], [Cotton, Wool]] Example encoded string: "0:0:0,1:0-1,,1:0:0-1,1:1,,2:0:1,1:0,,"

Step 1: Expand ranges into the numbers they represent: "0:0:0,1:0 1,,1:0:0 1,1:1,,2:0:1,1:0,," Step 2: Expand repeated prefixes: "0:0:0,0:1:0 1,1:0:0 1,1:1:1,2:0:1,2:1:0," Step 3: Expand shared prefixes so data is encoded as a string: "0:0:0,0:1:0,0:1:1,1:0:0,1:0:1,1:1:1,2:0:1,2:1:0," Step 4: Map to options + option values to determine existing variants:

[Small, Red, Cotton] (0:0:0), [Small, Blue, Cotton] (0:1:0), [Small, Blue, Wool] (0:1:1), [Medium, Red, Cotton] (1:0:0), [Medium, Red, Wool] (1:0:1), [Medium, Blue, Wool] (1:1:1), [Large, Red, Wool] (2:0:1), [Large, Blue, Cotton] (2:1:0).

An encoded string containing all option value combinations with a corresponding variant.

Integers represent option and values: [0,1] represents option_value at array index 0 for the option at array index 0

:, ,, and - are control characters. : indicates a new option. ex: 0:1 indicates value 0 for the option in position 1, value 1 for the option in position 2. , indicates the end of a repeated prefix, mulitple consecutive commas indicate the end of multiple repeated prefixes. indicates a gap in the sequence of option values. ex: 0 4 indicates option values in position 0 and 4 are present. - indicates a continuous range of option values. ex: 0 1-3 4

Decoding process:

Example options: [Size, Color, Material] Example values: [[Small, Medium, Large], [Red, Blue], [Cotton, Wool]] Example encoded string: "0:0:0,1:0-1,,1:0:0-1,1:1,,2:0:1,1:0,,"

Step 1: Expand ranges into the numbers they represent: "0:0:0,1:0 1,,1:0:0 1,1:1,,2:0:1,1:0,," Step 2: Expand repeated prefixes: "0:0:0,0:1:0 1,1:0:0 1,1:1:1,2:0:1,2:1:0," Step 3: Expand shared prefixes so data is encoded as a string: "0:0:0,0:1:0,0:1:1,1:0:0,1:0:1,1:1:1,2:0:1,2:1:0," Step 4: Map to options + option values to determine existing variants:

[Small, Red, Cotton] (0:0:0), [Small, Blue, Cotton] (0:1:0), [Small, Blue, Wool] (0:1:1), [Medium, Red, Cotton] (1:0:0), [Medium, Red, Wool] (1:0:1), [Medium, Blue, Wool] (1:1:1), [Large, Red, Wool] (2:0:1), [Large, Blue, Cotton] (2:1:0).

The featured image for the product.

This field is functionally equivalent to images(first: 1).

A unique, human-readable string of the product's title. A handle can contain letters, hyphens (-), and numbers, but no spaces. The handle is used in the online store URL for the product.

A globally-unique ID.

List of images associated with the product.

Whether the product is a gift card.

The media that are associated with the product. Valid media are images, 3D models, videos.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The product's URL on the online store. If null, then the product isn't published to the online store sales channel.

A list of product options. The limit is defined by the shop's resource limits for product options (Shop.resourceLimits.maxProductOptions).

The minimum and maximum prices of a product, expressed in decimal numbers. For example, if the product is priced between $10.00 and $50.00, then the price range is $10.00 - $50.00.

The product type that merchants define.

The date and time when the product was published to the channel.

Whether the product can only be purchased with a selling plan. Products that are sold on subscription (requiresSellingPlan: true) can be updated only for online stores. If you update a product to be subscription-only (requiresSellingPlan:false), then the product is unpublished from all channels, except the online store.

Find an active product variant based on selected options, availability or the first variant.

All arguments are optional. If no selected options are provided, the first available variant is returned. If no variants are available, the first variant is returned.

A list of all selling plan groups that are associated with the product either directly, or through the product's variants.

The SEO title and description that are associated with a product.

A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the sports and summer tags to products that are associated with sportwear for summer. Updating tags overwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use the GraphQL Admin API's tagsAdd mutation.

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

The quantity of inventory that's in stock.

URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

The date and time when the product was last modified. A product's updatedAt value can change for different reasons. For example, if an order is placed for a product that has inventory tracking set up, then the inventory adjustment is counted as an update.

Find a product’s variant based on its selected options. This is useful for converting a user’s selection of product options into a single matching variant. If there is not a variant for the selected options, null will be returned.

A list of variants that are associated with the product.

The number of variants that are associated with the product.

The name of the product's vendor.

Indicates if the product variant is available for sale.

The barcode (for example, ISBN, UPC, or GTIN) associated with the variant.

The compare at price of the variant. This can be used to mark a variant as on sale, when compareAtPrice is higher than price.

List of bundles components included in the variant considering only fixed bundles.

Whether a product is out of stock but still available for purchase (used for backorders).

List of bundles that include this variant considering only fixed bundles.

A globally-unique ID.

Image associated with the product variant. This field falls back to the product image if no image is available.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

The product variant’s price.

The product object that the product variant belongs to.

The total sellable quantity of the variant for online sales channels.

A list of quantity breaks for the product variant.

The quantity rule for the product variant in a given context.

Whether a product variant requires components. The default value is false. If true, then the product variant can only be purchased as a parent bundle with components.

Whether a customer needs to provide a shipping address when placing an order for the product variant.

List of product options applied to the variant.

Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing.

The Shop Pay Installments pricing information for the product variant.

The SKU (stock keeping unit) associated with the variant.

The in-store pickup availability of this variant by location.

Whether tax is charged when the product variant is sold.

The product variant’s title.

The unit price value for the variant based on the variant's measurement.

The unit price measurement for the variant.

The weight of the product variant in the unit system specified with weight_unit.

Unit of measurement for weight.

The billing policy for the selling plan.

The initial payment due for the purchase.

The delivery policy for the selling plan.

The description of the selling plan.

A globally-unique ID.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

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

The selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called option1: Delivery every. One selling plan in that group could contribute option1: 2 weeks with the pricing for that option, and another selling plan could contribute option1: 4 weeks, with different pricing.

The price adjustments that a selling plan makes when a variant is purchased with a selling plan.

Whether purchasing the selling plan will result in multiple deliveries.

The shop's branding configuration.

The URL for the customer account (only present if shop has a customer account vanity domain).

A description of the shop.

A globally-unique ID.

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

A list of custom fields that a merchant associates with a Shopify resource.

A string representing the way currency is formatted when the currency isn’t specified.

The shop’s name.

Settings related to payments.

The primary domain of the shop’s Online Store.

The shop’s privacy policy.

The shop’s refund policy.

The shop’s shipping policy.

Countries that the shop ships to.

The Shop Pay Installments pricing information for the shop.

The shop’s subscription policy.

The shop’s terms of service.