--- title: Node - Storefront API description: | An object with an ID field to support global identification, in accordance with the [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). This interface is used by the [node](/docs/api/storefront/latest/queries/node) and [nodes](/docs/api/storefront/latest/queries/nodes) queries. api_version: 2025-10 api_name: storefront type: interface api_type: graphql source_url: html: https://shopify.dev/docs/api/storefront/latest/interfaces/node md: https://shopify.dev/docs/api/storefront/latest/interfaces/node.md --- # Node interface An object with an ID field to support global identification, in accordance with the [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). This interface is used by the [node](https://shopify.dev/docs/api/storefront/latest/queries/node) and [nodes](https://shopify.dev/docs/api/storefront/latest/queries/nodes) queries. ## Fields * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. *** ## Types implemented in * [Applied​Gift​Card](https://shopify.dev/docs/api/storefront/latest/objects/AppliedGiftCard) OBJECT Details about the gift card used on the checkout. * amount​Used [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The amount that was taken from the gift card by applying it. * balance [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The amount left on the gift card. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * last​Characters [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The last characters of the gift card. * presentment​Amount​Used [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The amount that was applied to the checkout in its currency. * amount​Used​V2 [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-nullDeprecated * balance​V2 [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-nullDeprecated * [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) 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 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 * [Blog](https://shopify.dev/docs/api/storefront/latest/objects/Blog) OBJECT An online store blog. * article​By​Handle [Article](https://shopify.dev/docs/api/storefront/latest/objects/Article) Find an article by its handle. * articles [Article​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/ArticleConnection) non-null List of the blog's articles. * authors [\[Article​Author!\]!](https://shopify.dev/docs/api/storefront/latest/objects/ArticleAuthor) non-null The authors who have contributed to the blog. * handle [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null A human-friendly unique string for the Blog 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) 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 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 blog's SEO information. * title [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The blogs’s title. * [Cart](https://shopify.dev/docs/api/storefront/latest/objects/Cart) OBJECT A cart represents the merchandise that a buyer intends to purchase, and the estimated cost associated with the cart. Learn how to [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) during a customer's session. * applied​Gift​Cards [\[Applied​Gift​Card!\]!](https://shopify.dev/docs/api/storefront/latest/objects/AppliedGiftCard) non-null The gift cards that have been applied to the cart. * attribute [Attribute](https://shopify.dev/docs/api/storefront/latest/objects/Attribute) An attribute associated with the cart. * attributes [\[Attribute!\]!](https://shopify.dev/docs/api/storefront/latest/objects/Attribute) non-null The attributes associated with the cart. Attributes are represented as key-value pairs. * buyer​Identity [Cart​Buyer​Identity!](https://shopify.dev/docs/api/storefront/latest/objects/CartBuyerIdentity) non-null Information about the buyer that's interacting with the cart. * checkout​Url [URL!](https://shopify.dev/docs/api/storefront/latest/scalars/URL) non-null The URL of the checkout for the cart. * cost [Cart​Cost!](https://shopify.dev/docs/api/storefront/latest/objects/CartCost) non-null 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](https://shopify.dev/custom-storefronts/internationalization/international-pricing). * created​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time when the cart was created. * delivery [Cart​Delivery!](https://shopify.dev/docs/api/storefront/latest/objects/CartDelivery) non-null The delivery properties of the cart. * delivery​Groups [Cart​Delivery​Group​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/CartDeliveryGroupConnection) non-null 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. * discount​Allocations [\[Cart​Discount​Allocation!\]!](https://shopify.dev/docs/api/storefront/latest/interfaces/CartDiscountAllocation) non-null The discounts that have been applied to the entire cart. * discount​Codes [\[Cart​Discount​Code!\]!](https://shopify.dev/docs/api/storefront/latest/objects/CartDiscountCode) non-null The case-insensitive discount codes that the customer added at checkout. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * lines [Base​Cart​Line​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/BaseCartLineConnection) non-null A list of lines containing information about the items the customer intends to purchase. * metafield [Metafield](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) 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 A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * note [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) A note that's associated with the cart. For example, the note can be a personalized message to the buyer. * total​Quantity [Int!](https://shopify.dev/docs/api/storefront/latest/scalars/Int) non-null The total number of items in the cart. * updated​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time when the cart was updated. * estimated​Cost [Cart​Estimated​Cost!](https://shopify.dev/docs/api/storefront/latest/objects/CartEstimatedCost) non-nullDeprecated * [Cart​Line](https://shopify.dev/docs/api/storefront/latest/objects/CartLine) OBJECT Represents information about the merchandise in the cart. * attribute [Attribute](https://shopify.dev/docs/api/storefront/latest/objects/Attribute) An attribute associated with the cart line. * attributes [\[Attribute!\]!](https://shopify.dev/docs/api/storefront/latest/objects/Attribute) non-null The attributes associated with the cart line. Attributes are represented as key-value pairs. * cost [Cart​Line​Cost!](https://shopify.dev/docs/api/storefront/latest/objects/CartLineCost) non-null The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout. * discount​Allocations [\[Cart​Discount​Allocation!\]!](https://shopify.dev/docs/api/storefront/latest/interfaces/CartDiscountAllocation) non-null The discounts that have been applied to the cart line. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * instructions [Cart​Line​Instructions!](https://shopify.dev/docs/api/storefront/latest/objects/CartLineInstructions) non-null The instructions for the line item. * merchandise [Merchandise!](https://shopify.dev/docs/api/storefront/latest/unions/Merchandise) non-null The merchandise that the buyer intends to purchase. * parent​Relationship [Cart​Line​Parent​Relationship](https://shopify.dev/docs/api/storefront/latest/objects/CartLineParentRelationship) The parent of the line item. * quantity [Int!](https://shopify.dev/docs/api/storefront/latest/scalars/Int) non-null The quantity of the merchandise that the customer intends to purchase. * selling​Plan​Allocation [Selling​Plan​Allocation](https://shopify.dev/docs/api/storefront/latest/objects/SellingPlanAllocation) The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. * estimated​Cost [Cart​Line​Estimated​Cost!](https://shopify.dev/docs/api/storefront/latest/objects/CartLineEstimatedCost) non-nullDeprecated * [Collection](https://shopify.dev/docs/api/storefront/latest/objects/Collection) OBJECT A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. * description [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null Stripped description of the collection, 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. *** * description​Html [HTML!](https://shopify.dev/docs/api/storefront/latest/scalars/HTML) non-null The description of the collection, complete with HTML formatting. * handle [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters. * 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) Image associated with the collection. * metafield [Metafield](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) 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 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. * products [Product​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/ProductConnection) non-null List of products in the collection. * seo [SEO!](https://shopify.dev/docs/api/storefront/latest/objects/SEO) non-null The collection's SEO information. * title [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The collection’s name. Limit of 255 characters. * 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 collection was last modified. * [Comment](https://shopify.dev/docs/api/storefront/latest/objects/Comment) OBJECT A comment on an article. * author [Comment​Author!](https://shopify.dev/docs/api/storefront/latest/objects/CommentAuthor) non-null The comment’s author. * content [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null Stripped content of the comment, 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 comment, complete with HTML formatting. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * [Company](https://shopify.dev/docs/api/storefront/latest/objects/Company) OBJECT Represents information about a company which is also a customer of the shop. * created​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was created in Shopify. * external​Id [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) A unique externally-supplied ID for the company. * 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) 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 A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * name [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The name of the company. * updated​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company was last modified. * [Company​Contact](https://shopify.dev/docs/api/storefront/latest/objects/CompanyContact) OBJECT A company's main point of contact. * created​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company contact was created in Shopify. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * locale [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The company contact's locale (language). * title [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The company contact's job title. * updated​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company contact was last modified. * [Company​Location](https://shopify.dev/docs/api/storefront/latest/objects/CompanyLocation) OBJECT A company's location. * created​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was created in Shopify. * external​Id [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) A unique externally-supplied ID for the company. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * locale [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The preferred locale of the company location. * metafield [Metafield](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) 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 A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * name [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The name of the company location. * updated​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) at which the company location was last modified. * [Componentizable​Cart​Line](https://shopify.dev/docs/api/storefront/latest/objects/ComponentizableCartLine) OBJECT Represents information about the grouped merchandise in the cart. * attribute [Attribute](https://shopify.dev/docs/api/storefront/latest/objects/Attribute) An attribute associated with the cart line. * attributes [\[Attribute!\]!](https://shopify.dev/docs/api/storefront/latest/objects/Attribute) non-null The attributes associated with the cart line. Attributes are represented as key-value pairs. * cost [Cart​Line​Cost!](https://shopify.dev/docs/api/storefront/latest/objects/CartLineCost) non-null The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout. * discount​Allocations [\[Cart​Discount​Allocation!\]!](https://shopify.dev/docs/api/storefront/latest/interfaces/CartDiscountAllocation) non-null The discounts that have been applied to the cart line. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * line​Components [\[Cart​Line!\]!](https://shopify.dev/docs/api/storefront/latest/objects/CartLine) non-null The components of the line item. * merchandise [Merchandise!](https://shopify.dev/docs/api/storefront/latest/unions/Merchandise) non-null The merchandise that the buyer intends to purchase. * quantity [Int!](https://shopify.dev/docs/api/storefront/latest/scalars/Int) non-null The quantity of the merchandise that the customer intends to purchase. * selling​Plan​Allocation [Selling​Plan​Allocation](https://shopify.dev/docs/api/storefront/latest/objects/SellingPlanAllocation) The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. * estimated​Cost [Cart​Line​Estimated​Cost!](https://shopify.dev/docs/api/storefront/latest/objects/CartLineEstimatedCost) non-nullDeprecated * [External​Video](https://shopify.dev/docs/api/storefront/latest/objects/ExternalVideo) OBJECT Represents a video hosted outside of Shopify. * alt [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) A word or phrase to share the nature or contents of a media. * embed​Url [URL!](https://shopify.dev/docs/api/storefront/latest/scalars/URL) non-null The embed URL of the video for the respective host. * host [Media​Host!](https://shopify.dev/docs/api/storefront/latest/enums/MediaHost) non-null The host of the external video. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * media​Content​Type [Media​Content​Type!](https://shopify.dev/docs/api/storefront/latest/enums/MediaContentType) non-null The media content type. * origin​Url [URL!](https://shopify.dev/docs/api/storefront/latest/scalars/URL) non-null The origin URL of the video on the respective host. * presentation [Media​Presentation](https://shopify.dev/docs/api/storefront/latest/objects/MediaPresentation) The presentation for a media. * preview​Image [Image](https://shopify.dev/docs/api/storefront/latest/objects/Image) The preview image for the media. * embedded​Url [URL!](https://shopify.dev/docs/api/storefront/latest/scalars/URL) non-nullDeprecated * [Generic​File](https://shopify.dev/docs/api/storefront/latest/objects/GenericFile) OBJECT The generic file resource lets you manage files in a merchant’s store. Generic files include any file that doesn’t fit into a designated type such as image or video. Example: PDF, JSON. * alt [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) A word or phrase to indicate the contents of a file. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * mime​Type [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The MIME type of the file. * original​File​Size [Int](https://shopify.dev/docs/api/storefront/latest/scalars/Int) The size of the original file in bytes. * preview​Image [Image](https://shopify.dev/docs/api/storefront/latest/objects/Image) The preview image for the file. * url [URL](https://shopify.dev/docs/api/storefront/latest/scalars/URL) The URL of the file. * [Location](https://shopify.dev/docs/api/storefront/latest/objects/Location) OBJECT Represents a location where product inventory is held. * address [Location​Address!](https://shopify.dev/docs/api/storefront/latest/objects/LocationAddress) non-null The address of the location. * 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) 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 A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * name [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The name of the location. * [Mailing​Address](https://shopify.dev/docs/api/storefront/latest/objects/MailingAddress) OBJECT Represents a mailing address for customers and shipping. * address1 [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The first line of the address. Typically the street address or PO Box number. * address2 [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The second line of the address. Typically the number of the apartment, suite, or unit. * city [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The name of the city, district, village, or town. * company [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The name of the customer's company or organization. * country [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The name of the country. * country​Code​V2 [Country​Code](https://shopify.dev/docs/api/storefront/latest/enums/CountryCode) The two-letter code for the country of the address. For example, US. * first​Name [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The first name of the customer. * formatted [\[String!\]!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null A formatted version of the address, customized by the provided arguments. * with​Name [Boolean](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) Default:false ### Arguments Whether to include the customer's name in the formatted address. * with​Company [Boolean](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) Default:true Whether to include the customer's company in the formatted address. *** * formatted​Area [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) A comma-separated list of the values for city, province, and country. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * last​Name [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The last name of the customer. * latitude [Float](https://shopify.dev/docs/api/storefront/latest/scalars/Float) The latitude coordinate of the customer address. * longitude [Float](https://shopify.dev/docs/api/storefront/latest/scalars/Float) The longitude coordinate of the customer address. * name [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The full name of the customer, based on firstName and lastName. * phone [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) A unique phone number for the customer. Formatted using E.164 standard. For example, *+16135551111*. * province [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The region of the address, such as the province, state, or district. * province​Code [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The alphanumeric code for the region. For example, ON. * zip [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The zip or postal code of the address. * country​Code [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) Deprecated * [Market](https://shopify.dev/docs/api/storefront/latest/objects/Market) OBJECT A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to [the Shopify Markets conceptual overview](https://shopify.dev/docs/apps/markets). * handle [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null A human-readable unique string for the market 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) 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 A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * [Media​Image](https://shopify.dev/docs/api/storefront/latest/objects/MediaImage) OBJECT Represents a Shopify hosted image. * alt [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) A word or phrase to share the nature or contents of a media. * 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 for the media. * media​Content​Type [Media​Content​Type!](https://shopify.dev/docs/api/storefront/latest/enums/MediaContentType) non-null The media content type. * presentation [Media​Presentation](https://shopify.dev/docs/api/storefront/latest/objects/MediaPresentation) The presentation for a media. * preview​Image [Image](https://shopify.dev/docs/api/storefront/latest/objects/Image) The preview image for the media. * [Media​Presentation](https://shopify.dev/docs/api/storefront/latest/objects/MediaPresentation) OBJECT A media presentation. * as​Json [JSON](https://shopify.dev/docs/api/storefront/latest/scalars/JSON) A JSON object representing a presentation view. * format [Media​Presentation​Format!](https://shopify.dev/docs/api/storefront/latest/enums/MediaPresentationFormat) required ### Arguments The format to transform the settings. *** * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * [Menu](https://shopify.dev/docs/api/storefront/latest/objects/Menu) OBJECT A [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) representing a hierarchy of hyperlinks (items). * handle [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The menu's handle. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * items [\[Menu​Item!\]!](https://shopify.dev/docs/api/storefront/latest/objects/MenuItem) non-null The menu's child items. * items​Count [Int!](https://shopify.dev/docs/api/storefront/latest/scalars/Int) non-null The count of items on the menu. * title [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The menu's title. * [Menu​Item](https://shopify.dev/docs/api/storefront/latest/objects/MenuItem) OBJECT A menu item within a parent menu. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * items [\[Menu​Item!\]!](https://shopify.dev/docs/api/storefront/latest/objects/MenuItem) non-null The menu item's child items. * resource [Menu​Item​Resource](https://shopify.dev/docs/api/storefront/latest/unions/MenuItemResource) The linked resource. * resource​Id [ID](https://shopify.dev/docs/api/storefront/latest/scalars/ID) The ID of the linked resource. * tags [\[String!\]!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The menu item's tags to filter a collection. * title [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The menu item's title. * type [Menu​Item​Type!](https://shopify.dev/docs/api/storefront/latest/enums/MenuItemType) non-null The menu item's type. * url [URL](https://shopify.dev/docs/api/storefront/latest/scalars/URL) The menu item's URL. * [Metafield](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) OBJECT Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are comprised of keys, values, and value types. * created​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time when the storefront metafield was created. * description [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The description of a metafield. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * key [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The unique identifier for the metafield within its namespace. * namespace [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The container for a group of metafields that the metafield is associated with. * parent​Resource [Metafield​Parent​Resource!](https://shopify.dev/docs/api/storefront/latest/unions/MetafieldParentResource) non-null The type of resource that the metafield is attached to. * reference [Metafield​Reference](https://shopify.dev/docs/api/storefront/latest/unions/MetafieldReference) Returns a reference object if the metafield's type is a resource reference. * references [Metafield​Reference​Connection](https://shopify.dev/docs/api/storefront/latest/connections/MetafieldReferenceConnection) A list of reference objects if the metafield's type is a resource reference list. * type [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The type name of the metafield. Refer to the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). * updated​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time when the metafield was last updated. * value [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The data stored in the metafield. Always stored as a string, regardless of the metafield's type. * [Metaobject](https://shopify.dev/docs/api/storefront/latest/objects/Metaobject) OBJECT An instance of a user-defined model based on a MetaobjectDefinition. * field [Metaobject​Field](https://shopify.dev/docs/api/storefront/latest/objects/MetaobjectField) Accesses a field of the object by key. * fields [\[Metaobject​Field!\]!](https://shopify.dev/docs/api/storefront/latest/objects/MetaobjectField) non-null All object fields with defined values. Omitted object keys can be assumed null, and no guarantees are made about field order. * handle [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The unique handle of the metaobject. Useful as a custom ID. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * online​Store​Url [URL](https://shopify.dev/docs/api/storefront/latest/scalars/URL) 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. * seo [Metaobject​SEO](https://shopify.dev/docs/api/storefront/latest/objects/MetaobjectSEO) The metaobject's SEO information. Returns `null` if the metaobject definition doesn't have the `renderable` capability. * type [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The type of the metaobject. Defines the namespace of its associated metafields. * updated​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null The date and time when the metaobject was last updated. * [Model3d](https://shopify.dev/docs/api/storefront/latest/objects/Model3d) OBJECT Represents a Shopify hosted 3D model. * alt [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) A word or phrase to share the nature or contents of a media. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * media​Content​Type [Media​Content​Type!](https://shopify.dev/docs/api/storefront/latest/enums/MediaContentType) non-null The media content type. * presentation [Media​Presentation](https://shopify.dev/docs/api/storefront/latest/objects/MediaPresentation) The presentation for a media. * preview​Image [Image](https://shopify.dev/docs/api/storefront/latest/objects/Image) The preview image for the media. * sources [\[Model3d​Source!\]!](https://shopify.dev/docs/api/storefront/latest/objects/Model3dSource) non-null The sources for a 3d model. * [Order](https://shopify.dev/docs/api/storefront/latest/objects/Order) OBJECT An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. * billing​Address [Mailing​Address](https://shopify.dev/docs/api/storefront/latest/objects/MailingAddress) The address associated with the payment method. * canceled​At [Date​Time](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) The date and time when the order was canceled. Returns null if the order wasn't canceled. * cancel​Reason [Order​Cancel​Reason](https://shopify.dev/docs/api/storefront/latest/enums/OrderCancelReason) The reason for the order's cancellation. Returns `null` if the order wasn't canceled. * currency​Code [Currency​Code!](https://shopify.dev/docs/api/storefront/latest/enums/CurrencyCode) non-null The code of the currency used for the payment. * current​Subtotal​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null 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. * current​Total​Duties [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) The total cost of duties for the order, including refunds. * current​Total​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. * current​Total​Shipping​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null 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. * current​Total​Tax [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The total of all taxes applied to the order, excluding taxes for returned line items. * custom​Attributes [\[Attribute!\]!](https://shopify.dev/docs/api/storefront/latest/objects/Attribute) non-null A list of the custom attributes added to the order. For example, whether an order is a customer's first. * customer​Locale [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The locale code in which this specific order happened. * customer​Url [URL](https://shopify.dev/docs/api/storefront/latest/scalars/URL) The unique URL that the customer can use to access the order. * discount​Applications [Discount​Application​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/DiscountApplicationConnection) non-null Discounts that have been applied on the order. * edited [Boolean!](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) non-null Whether the order has had any edits applied or not. * email [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The customer's email address. * financial​Status [Order​Financial​Status](https://shopify.dev/docs/api/storefront/latest/enums/OrderFinancialStatus) The financial status of the order. * fulfillment​Status [Order​Fulfillment​Status!](https://shopify.dev/docs/api/storefront/latest/enums/OrderFulfillmentStatus) non-null The fulfillment status for the order. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * line​Items [Order​Line​Item​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/OrderLineItemConnection) non-null List of the order’s line items. * metafield [Metafield](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) 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 A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * name [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null Unique identifier for the order that appears on the order. For example, *#1000* or \_Store1001. * order​Number [Int!](https://shopify.dev/docs/api/storefront/latest/scalars/Int) non-null A unique numeric identifier for the order for use by shop owner and customer. * original​Total​Duties [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) The total cost of duties charged at checkout. * original​Total​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The total price of the order before any applied edits. * phone [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The customer's phone number for receiving SMS notifications. * processed​At [Date​Time!](https://shopify.dev/docs/api/storefront/latest/scalars/DateTime) non-null 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. * shipping​Address [Mailing​Address](https://shopify.dev/docs/api/storefront/latest/objects/MailingAddress) The address to where the order will be shipped. * shipping​Discount​Allocations [\[Discount​Allocation!\]!](https://shopify.dev/docs/api/storefront/latest/objects/DiscountAllocation) non-null The discounts that have been allocated onto the shipping line by discount applications. * status​Url [URL!](https://shopify.dev/docs/api/storefront/latest/scalars/URL) non-null The unique URL for the order's status page. * subtotal​Price [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) Price of the order before shipping and taxes. * successful​Fulfillments [\[Fulfillment!\]](https://shopify.dev/docs/api/storefront/latest/objects/Fulfillment) List of the order’s successful fulfillments. * total​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). * total​Refunded [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The total amount that has been refunded. * total​Shipping​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The total cost of shipping. * total​Tax [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) The total cost of taxes. * subtotal​Price​V2 [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) Deprecated * total​Price​V2 [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-nullDeprecated * total​Refunded​V2 [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-nullDeprecated * total​Shipping​Price​V2 [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-nullDeprecated * total​Tax​V2 [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) Deprecated * [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) 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 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) 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 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) 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. * [Product​Option](https://shopify.dev/docs/api/storefront/latest/objects/ProductOption) OBJECT Product property names like "Size", "Color", and "Material" that the customers can select. Variants are selected based on permutations of these options. 255 characters limit each. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The product option’s name. * option​Values [\[Product​Option​Value!\]!](https://shopify.dev/docs/api/storefront/latest/objects/ProductOptionValue) non-null The corresponding option value to the product option. * values [\[String!\]!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-nullDeprecated * [Product​Option​Value](https://shopify.dev/docs/api/storefront/latest/objects/ProductOptionValue) OBJECT The product option value names. For example, "Red", "Blue", and "Green" for a "Color" option. * first​Selectable​Variant [Product​Variant](https://shopify.dev/docs/api/storefront/latest/objects/ProductVariant) The product variant that combines this option value with the lowest-position option values for all other options. This field will always return a variant, provided a variant including this option value exists. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * name [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The name of the product option value. * swatch [Product​Option​Value​Swatch](https://shopify.dev/docs/api/storefront/latest/objects/ProductOptionValueSwatch) The swatch of the product option value. * [Product​Variant](https://shopify.dev/docs/api/storefront/latest/objects/ProductVariant) OBJECT A product variant represents a different version of a product, such as differing sizes or differing colors. * available​For​Sale [Boolean!](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) non-null Indicates if the product variant is available for sale. * barcode [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The barcode (for example, ISBN, UPC, or GTIN) associated with the variant. * compare​At​Price [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`. * components [Product​Variant​Component​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/ProductVariantComponentConnection) non-null List of bundles components included in the variant considering only fixed bundles. * currently​Not​In​Stock [Boolean!](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) non-null Whether a product is out of stock but still available for purchase (used for backorders). * grouped​By [Product​Variant​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/ProductVariantConnection) non-null List of bundles that include this variant considering only fixed bundles. * 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) Image associated with the product variant. This field falls back to the product image if no image is available. * metafield [Metafield](https://shopify.dev/docs/api/storefront/latest/objects/Metafield) 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 A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The product variant’s price. * product [Product!](https://shopify.dev/docs/api/storefront/latest/objects/Product) non-null The product object that the product variant belongs to. * quantity​Available [Int](https://shopify.dev/docs/api/storefront/latest/scalars/Int) The total sellable quantity of the variant for online sales channels. * quantity​Price​Breaks [Quantity​Price​Break​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/QuantityPriceBreakConnection) non-null A list of quantity breaks for the product variant. * quantity​Rule [Quantity​Rule!](https://shopify.dev/docs/api/storefront/latest/objects/QuantityRule) non-null The quantity rule for the product variant in a given context. * requires​Components [Boolean!](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) non-null 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. * requires​Shipping [Boolean!](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) non-null Whether a customer needs to provide a shipping address when placing an order for the product variant. * selected​Options [\[Selected​Option!\]!](https://shopify.dev/docs/api/storefront/latest/objects/SelectedOption) non-null List of product options applied to the variant. * selling​Plan​Allocations [Selling​Plan​Allocation​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/SellingPlanAllocationConnection) non-null 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. * shop​Pay​Installments​Pricing [Shop​Pay​Installments​Product​Variant​Pricing](https://shopify.dev/docs/api/storefront/latest/objects/ShopPayInstallmentsProductVariantPricing) The Shop Pay Installments pricing information for the product variant. * sku [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The SKU (stock keeping unit) associated with the variant. * store​Availability [Store​Availability​Connection!](https://shopify.dev/docs/api/storefront/latest/connections/StoreAvailabilityConnection) non-null The in-store pickup availability of this variant by location. * taxable [Boolean!](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) non-null Whether tax is charged when the product variant is sold. * title [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The product variant’s title. * unit​Price [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) The unit price value for the variant based on the variant's measurement. * unit​Price​Measurement [Unit​Price​Measurement](https://shopify.dev/docs/api/storefront/latest/objects/UnitPriceMeasurement) The unit price measurement for the variant. * weight [Float](https://shopify.dev/docs/api/storefront/latest/scalars/Float) The weight of the product variant in the unit system specified with `weight_unit`. * weight​Unit [Weight​Unit!](https://shopify.dev/docs/api/storefront/latest/enums/WeightUnit) non-null Unit of measurement for weight. * compare​At​Price​V2 [Money​V2](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) Deprecated * price​V2 [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-nullDeprecated * [Shop](https://shopify.dev/docs/api/storefront/latest/objects/Shop) OBJECT Shop represents a collection of the general settings and information about the shop. * brand [Brand](https://shopify.dev/docs/api/storefront/latest/objects/Brand) The shop's branding configuration. * customer​Account​Url [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) The URL for the customer account (only present if shop has a customer account vanity domain). * description [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) A description of the shop. * 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) 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 A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * money​Format [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null A string representing the way currency is formatted when the currency isn’t specified. * name [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The shop’s name. * payment​Settings [Payment​Settings!](https://shopify.dev/docs/api/storefront/latest/objects/PaymentSettings) non-null Settings related to payments. * primary​Domain [Domain!](https://shopify.dev/docs/api/storefront/latest/objects/Domain) non-null The primary domain of the shop’s Online Store. * privacy​Policy [Shop​Policy](https://shopify.dev/docs/api/storefront/latest/objects/ShopPolicy) The shop’s privacy policy. * refund​Policy [Shop​Policy](https://shopify.dev/docs/api/storefront/latest/objects/ShopPolicy) The shop’s refund policy. * shipping​Policy [Shop​Policy](https://shopify.dev/docs/api/storefront/latest/objects/ShopPolicy) The shop’s shipping policy. * ships​To​Countries [\[Country​Code!\]!](https://shopify.dev/docs/api/storefront/latest/enums/CountryCode) non-null Countries that the shop ships to. * shop​Pay​Installments​Pricing [Shop​Pay​Installments​Pricing](https://shopify.dev/docs/api/storefront/latest/objects/ShopPayInstallmentsPricing) The Shop Pay Installments pricing information for the shop. * subscription​Policy [Shop​Policy​With​Default](https://shopify.dev/docs/api/storefront/latest/objects/ShopPolicyWithDefault) The shop’s subscription policy. * terms​Of​Service [Shop​Policy](https://shopify.dev/docs/api/storefront/latest/objects/ShopPolicy) The shop’s terms of service. * [Shop​Pay​Installments​Financing​Plan](https://shopify.dev/docs/api/storefront/latest/objects/ShopPayInstallmentsFinancingPlan) OBJECT The financing plan in Shop Pay Installments. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * max​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The maximum price to qualify for the financing plan. * min​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The minimum price to qualify for the financing plan. * terms [\[Shop​Pay​Installments​Financing​Plan​Term!\]!](https://shopify.dev/docs/api/storefront/latest/objects/ShopPayInstallmentsFinancingPlanTerm) non-null The terms of the financing plan. * [Shop​Pay​Installments​Financing​Plan​Term](https://shopify.dev/docs/api/storefront/latest/objects/ShopPayInstallmentsFinancingPlanTerm) OBJECT The terms of the financing plan in Shop Pay Installments. * apr [Int!](https://shopify.dev/docs/api/storefront/latest/scalars/Int) non-null The annual percentage rate (APR) of the financing plan. * frequency [Shop​Pay​Installments​Financing​Plan​Frequency!](https://shopify.dev/docs/api/storefront/latest/enums/ShopPayInstallmentsFinancingPlanFrequency) non-null The payment frequency for the financing plan. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * installments​Count [Count](https://shopify.dev/docs/api/storefront/latest/objects/Count) The number of installments for the financing plan. * loan​Type [Shop​Pay​Installments​Loan!](https://shopify.dev/docs/api/storefront/latest/enums/ShopPayInstallmentsLoan) non-null The type of loan for the financing plan. * [Shop​Pay​Installments​Product​Variant​Pricing](https://shopify.dev/docs/api/storefront/latest/objects/ShopPayInstallmentsProductVariantPricing) OBJECT The shop pay installments pricing information for a product variant. * available [Boolean!](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) non-null Whether the product variant is available. * eligible [Boolean!](https://shopify.dev/docs/api/storefront/latest/scalars/Boolean) non-null Whether the product variant is eligible for Shop Pay Installments. * full​Price [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The full price of the product variant. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null The ID of the product variant. * installments​Count [Count](https://shopify.dev/docs/api/storefront/latest/objects/Count) The number of payment terms available for the product variant. * price​Per​Term [Money​V2!](https://shopify.dev/docs/api/storefront/latest/objects/MoneyV2) non-null The price per term for the product variant. * [Shop​Policy](https://shopify.dev/docs/api/storefront/latest/objects/ShopPolicy) OBJECT Policy that a merchant has configured for their store, such as their refund or privacy policy. * body [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null Policy text, maximum size of 64kb. * handle [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null Policy’s handle. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * title [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null Policy’s title. * url [URL!](https://shopify.dev/docs/api/storefront/latest/scalars/URL) non-null Public URL to the policy. * [Taxonomy​Category](https://shopify.dev/docs/api/storefront/latest/objects/TaxonomyCategory) OBJECT The taxonomy category for the product. * ancestors [\[Taxonomy​Category!\]!](https://shopify.dev/docs/api/storefront/latest/objects/TaxonomyCategory) non-null All parent nodes of the current taxonomy category. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A static identifier for the taxonomy category. * name [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The localized name of the taxonomy category. * [Url​Redirect](https://shopify.dev/docs/api/storefront/latest/objects/UrlRedirect) OBJECT A redirect on the online store. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null The ID of the URL redirect. * path [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The old path to be redirected from. When the user visits this path, they'll be redirected to the target location. * target [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String) non-null The target location where the user will be redirected to. * [Video](https://shopify.dev/docs/api/storefront/latest/objects/Video) OBJECT Represents a Shopify hosted video. * alt [String](https://shopify.dev/docs/api/storefront/latest/scalars/String) A word or phrase to share the nature or contents of a media. * id [ID!](https://shopify.dev/docs/api/storefront/latest/scalars/ID) non-null A globally-unique ID. * media​Content​Type [Media​Content​Type!](https://shopify.dev/docs/api/storefront/latest/enums/MediaContentType) non-null The media content type. * presentation [Media​Presentation](https://shopify.dev/docs/api/storefront/latest/objects/MediaPresentation) The presentation for a media. * preview​Image [Image](https://shopify.dev/docs/api/storefront/latest/objects/Image) The preview image for the media. * sources [\[Video​Source!\]!](https://shopify.dev/docs/api/storefront/latest/objects/VideoSource) non-null The sources for a video. *** ```json { "id": "" } ``` ##### Variables ``` { "id": "" } ``` ##### Schema ``` interface Node { id: ID! } ```