--- title: SearchResultItem - Storefront API description: | A search result that matches the search query. api_version: 2025-10 api_name: storefront type: union api_type: graphql source_url: html: https://shopify.dev/docs/api/storefront/latest/unions/SearchResultItem md: https://shopify.dev/docs/api/storefront/latest/unions/SearchResultItem.md --- # Search​Result​Item union A search result that matches the search query. ## Possible types * [Article](https://shopify.dev/docs/api/storefront/latest/objects/Article) OBJECT An article in an online store blog. * author​V2 [Article​Author](https://shopify.dev/docs/api/storefront/latest/objects/ArticleAuthor) The article's author. * blog [Blog!](https://shopify.dev/docs/api/storefront/latest/objects/Blog) non-null The blog that the article belongs to. * comments [Comment​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/CommentConnection) non-null List of comments posted on the article. * content [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null Stripped content of the article, single line with HTML tags removed. * truncate​At [Int](https://shopify.dev/docs/api/storefront/latest/scalars/Int) ### Arguments Truncates a string after the given length. *** * content​Html [HTML!](https://shopify.dev/docs/api/storefront/latest/scalars/HTML) non-null The content of the article, complete with HTML formatting. * excerpt [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) Stripped excerpt of the article, single line with HTML tags removed. * truncate​At [Int](https://shopify.dev/docs/api/storefront/latest/scalars/Int) ### Arguments Truncates a string after the given length. *** * excerpt​Html [HTML](https://shopify.dev/docs/api/storefront/latest/scalars/HTML) The excerpt of the article, complete with HTML formatting. * handle [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null A human-friendly unique string for the Article automatically generated from its title. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * image [Image](https://shopify.dev/docs/api/storefront/latest/objects/Image) The image associated with the article. * metafield [Metafield](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) Token access required A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [\[Metafield\]!](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) non-null Token access required A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * online​Store​Url [URL](https://shopify.dev/docs/api/storefront/latest/scalars/URL) 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. * published​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time when the article was published. * seo [SEO](https://shopify.dev/docs/api/storefront/latest/objects/SEO) The article’s SEO information. * tags [\[String!\]!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null A categorization that a article can be tagged with. * title [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The article’s name. * tracking​Parameters [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) URL parameters to be added to a page URL to track the origin of on-site search traffic for [analytics reporting](https://help.shopify.com/manual/reports-and-analytics/shopify-reports/report-types/default-reports/behaviour-reports). Returns a result when accessed through the [search](https://shopify.dev/docs/api/storefront/current/queries/search) or [predictiveSearch](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries, otherwise returns null. * author [Article​Author!](https://shopify.dev/docs/api/storefront/latest/objects/ArticleAuthor) non-nullDeprecated * [Page](https://shopify.dev/docs/api/storefront/latest/objects/Page) OBJECT Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. * body [HTML!](https://shopify.dev/docs/api/storefront/latest/scalars/HTML) non-null The description of the page, complete with HTML formatting. * body​Summary [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null Summary of the page body. * created​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The timestamp of the page creation. * handle [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null A human-friendly unique string for the page automatically generated from its title. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * metafield [Metafield](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) Token access required A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [\[Metafield\]!](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) non-null Token access required A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * online​Store​Url [URL](https://shopify.dev/docs/api/storefront/latest/scalars/URL) 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. * seo [SEO](https://shopify.dev/docs/api/storefront/latest/objects/SEO) The page's SEO information. * title [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The title of the page. * tracking​Parameters [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) URL parameters to be added to a page URL to track the origin of on-site search traffic for [analytics reporting](https://help.shopify.com/manual/reports-and-analytics/shopify-reports/report-types/default-reports/behaviour-reports). Returns a result when accessed through the [search](https://shopify.dev/docs/api/storefront/current/queries/search) or [predictiveSearch](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries, otherwise returns null. * updated​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The timestamp of the latest page update. * [Product](https://shopify.dev/docs/api/storefront/latest/objects/Product) OBJECT The `Product` object lets you manage products in a merchant’s store. Products are the goods and services that merchants offer to customers. They can include various details such as title, description, price, images, and options such as size or color. You can use [product variants](https://shopify.dev/docs/api/storefront/latest/objects/ProductVariant) to create or update different versions of the same product. You can also add or update product [media](https://shopify.dev/docs/api/storefront/latest/interfaces/Media). Products can be organized by grouping them into a [collection](https://shopify.dev/docs/api/storefront/latest/objects/Collection). Learn more about working with [products and collections](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/products-collections). * adjacent​Variants [\[Product​Variant!\]!](https://shopify.dev/docs/api/storefront/latest/objects/ProductVariant) non-null 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. * available​For​Sale [Boolean!](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) non-null Indicates if at least one product variant is available for sale. * category [Taxonomy​Category](https://shopify.dev/docs/api/storefront/latest/objects/TaxonomyCategory) The category of a product from [Shopify's Standard Product Taxonomy](https://shopify.github.io/product-taxonomy/releases/unstable/?categoryId=sg-4-17-2-17). * collections [Collection​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/CollectionConnection) non-null A list of [collections](https://shopify.dev/docs/api/storefront/latest/objects/Collection) that include the product. * compare​At​Price​Range [Product​Price​Range!](https://shopify.dev/docs/api/storefront/latest/objects/ProductPriceRange) non-null The [compare-at price range](https://help.shopify.com/manual/products/details/product-pricing/sale-pricing) of the product in the shop's default currency. * created​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time when the product was created. * description [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null A single-line description of the product, with [HTML tags](https://developer.mozilla.org/en-US/docs/Web/HTML) removed. * truncate​At [Int](https://shopify.dev/docs/api/storefront/latest/scalars/Int) ### Arguments Truncates a string after the given length. *** * description​Html [HTML!](https://shopify.dev/docs/api/storefront/latest/scalars/HTML) non-null The description of the product, with HTML tags. For example, the description might include bold `` and italic `` text. * encoded​Variant​Availability [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) 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). * encoded​Variant​Existence [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) 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). * featured​Image [Image](https://shopify.dev/docs/api/storefront/latest/objects/Image) The featured image for the product. This field is functionally equivalent to `images(first: 1)`. * handle [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null 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. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * images [Image​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/ImageConnection) non-null List of images associated with the product. * is​Gift​Card [Boolean!](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) non-null Whether the product is a gift card. * media [Media​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/MediaConnection) non-null The [media](https://shopify.dev/docs/apps/build/online-store/product-media) that are associated with the product. Valid media are images, 3D models, videos. * metafield [Metafield](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) Token access required A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [\[Metafield\]!](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) non-null Token access required A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * online​Store​Url [URL](https://shopify.dev/docs/api/storefront/latest/scalars/URL) The product's URL on the online store. If `null`, then the product isn't published to the online store sales channel. * options [\[Product​Option!\]!](https://shopify.dev/docs/api/storefront/latest/objects/ProductOption) non-null A list of product options. The limit is defined by the [shop's resource limits for product options](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop#field-resourcelimits) (`Shop.resourceLimits.maxProductOptions`). * price​Range [Product​Price​Range!](https://shopify.dev/docs/api/storefront/latest/objects/ProductPriceRange) non-null 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. * product​Type [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The [product type](https://help.shopify.com/manual/products/details/product-type) that merchants define. * published​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time when the product was published to the channel. * requires​Selling​Plan [Boolean!](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) non-null Whether the product can only be purchased with a [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans). 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. * selected​Or​First​Available​Variant [Product​Variant](https://shopify.dev/docs/api/storefront/latest/objects/ProductVariant) 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. * selling​Plan​Groups [Selling​Plan​Group​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/SellingPlanGroupConnection) non-null A list of all [selling plan groups](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans/build-a-selling-plan) that are associated with the product either directly, or through the product's variants. * seo [SEO!](https://shopify.dev/docs/api/storefront/latest/objects/SEO) non-null The [SEO title and description](https://help.shopify.com/manual/promoting-marketing/seo/adding-keywords) that are associated with a product. * tags [\[String!\]!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null 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`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/tagsadd) mutation. * title [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null 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`. * total​Inventory [Int](https://shopify.dev/docs/api/storefront/latest/scalars/Int) Token access required The quantity of inventory that's in stock. * tracking​Parameters [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) URL parameters to be added to a page URL to track the origin of on-site search traffic for [analytics reporting](https://help.shopify.com/manual/reports-and-analytics/shopify-reports/report-types/default-reports/behaviour-reports). Returns a result when accessed through the [search](https://shopify.dev/docs/api/storefront/current/queries/search) or [predictiveSearch](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries, otherwise returns null. * updated​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-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. * variant​By​Selected​Options [Product​Variant](https://shopify.dev/docs/api/storefront/latest/objects/ProductVariant) 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. * variants [Product​Variant​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/ProductVariantConnection) non-null A list of [variants](https://shopify.dev/docs/api/storefront/latest/objects/ProductVariant) that are associated with the product. * variants​Count [Count](https://shopify.dev/docs/api/storefront/latest/objects/Count) The number of [variants](https://shopify.dev/docs/api/storefront/latest/objects/ProductVariant) that are associated with the product. * vendor [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The name of the product's vendor. *** ## Fields with this union * [Search​Result​Item​Connection.nodes](https://shopify.dev/docs/api/storefront/latest/connections/SearchResultItemConnection#returns-nodes) CONNECTION An auto-generated type for paginating through multiple SearchResultItems. * [Search​Result​Item​Edge.node](https://shopify.dev/docs/api/storefront/latest/objects/SearchResultItemEdge#field-SearchResultItemEdge.fields.node) OBJECT An auto-generated type which holds one SearchResultItem and a cursor during pagination. *** ```graphql union SearchResultItem = Article | Page | Product ```