MetafieldReference

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.

A word or phrase to indicate the contents of a file.

A globally-unique ID.

The MIME type of the file.

The size of the original file in bytes.

The preview image for the file.

The URL of the file.

A word or phrase to share the nature or contents of a media.

A globally-unique ID.

The image for the media.

The media content type.

The presentation for a media.

The preview image for the media.

Accesses a field of the object by key.

All object fields with defined values. Omitted object keys can be assumed null, and no guarantees are made about field order.

The unique handle of the metaobject. Useful as a custom ID.

A globally-unique ID.

The URL used for viewing the metaobject on the shop's Online Store. Returns null if the metaobject definition doesn't have the online_store capability.

The metaobject's SEO information. Returns null if the metaobject definition doesn't have the renderable capability.

The type of the metaobject. Defines the namespace of its associated metafields.

The date and time when the metaobject was last updated.

A word or phrase to share the nature or contents of a media.

A globally-unique ID.

The media content type.

The presentation for a media.

The preview image for the media.

The sources for a 3d model.

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.

A word or phrase to share the nature or contents of a media.

A globally-unique ID.

The media content type.

The presentation for a media.

The preview image for the media.

The sources for a video.