Menu Item Resource
The list of possible resources a can reference.
Anchor to Possible typesPossible types
- •OBJECT
An article in an online store blog.
- •Article
Author The article's author.
- Anchor to blogblog•Blog!non-null
The blog that the article belongs to.
- Anchor to commentscomments•Comment
Connection! non-null List of comments posted on the article.
- Anchor to contentcontent•String!non-null
Stripped content of the article, single line with HTML tags removed.
- Anchor to truncateAttruncate•Int
At Truncates a string after the given length.
Arguments
- Anchor to contentHtmlcontent•HTML!
Html non-null The content of the article, complete with HTML formatting.
- Anchor to excerptexcerpt•String
Stripped excerpt of the article, single line with HTML tags removed.
- Anchor to truncateAttruncate•Int
At Truncates a string after the given length.
Arguments
- Anchor to excerptHtmlexcerpt•HTML
Html The excerpt of the article, complete with HTML formatting.
- Anchor to handlehandle•String!non-null
A human-friendly unique string for the Article automatically generated from its title.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
The image associated with the article.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to onlineStoreUrlonline•URL
Store 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.- Anchor to publishedAtpublished•Date
At Time! non-null The date and time when the article was published.
- •SEO
The article’s SEO information.
- •[String!]!non-null
A categorization that a article can be tagged with.
- Anchor to titletitle•String!non-null
The article’s name.
- Anchor to trackingParameterstracking•String
Parameters URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.
- •Article
Author! non-nullDeprecated
- •Article
- •OBJECT
An online store blog.
- Anchor to articleByHandlearticle•Article
By Handle Find an article by its handle.
- Anchor to articlesarticles•Article
Connection! non-null List of the blog's articles.
- •[Article
Author!]! non-null The authors who have contributed to the blog.
- Anchor to handlehandle•String!non-null
A human-friendly unique string for the Blog automatically generated from its title.
- •ID!non-null
A globally-unique ID.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to onlineStoreUrlonline•URL
Store 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
The blog's SEO information.
- Anchor to titletitle•String!non-null
The blogs’s title.
- •OBJECT
A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse.
- Anchor to descriptiondescription•String!non-null
Stripped description of the collection, single line with HTML tags removed.
- Anchor to truncateAttruncate•Int
At Truncates a string after the given length.
Arguments
- Anchor to descriptionHtmldescription•HTML!
Html non-null The description of the collection, complete with HTML formatting.
- Anchor to handlehandle•String!non-null
A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.
- •ID!non-null
A globally-unique ID.
- Anchor to imageimage•Image
Image associated with the collection.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to onlineStoreUrlonline•URL
Store 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.- Anchor to productsproducts•Product
Connection! non-null List of products in the collection.
- •SEO!non-null
The collection's SEO information.
- Anchor to titletitle•String!non-null
The collection’s name. Limit of 255 characters.
- Anchor to trackingParameterstracking•String
Parameters URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the collection was last modified.
- •OBJECT
An instance of a user-defined model based on a MetaobjectDefinition.
- Anchor to fieldfield•Metaobject
Field Accesses a field of the object by key.
- Anchor to fieldsfields•[Metaobject
Field!]! non-null All object fields with defined values. Omitted object keys can be assumed null, and no guarantees are made about field order.
- Anchor to handlehandle•String!non-null
The unique handle of the metaobject. Useful as a custom ID.
- •ID!non-null
A globally-unique ID.
- Anchor to onlineStoreUrlonline•URL
Store Url The URL used for viewing the metaobject on the shop's Online Store. Returns
null
if the metaobject definition doesn't have thecapability.
- •Metaobject
SEO The metaobject's SEO information. Returns
null
if the metaobject definition doesn't have therenderable
capability.- Anchor to typetype•String!non-null
The type of the metaobject. Defines the namespace of its associated metafields.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the metaobject was last updated.
- •OBJECT
Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store.
- Anchor to bodybody•HTML!non-null
The description of the page, complete with HTML formatting.
- Anchor to bodySummarybody•String!
Summary non-null Summary of the page body.
- Anchor to createdAtcreated•Date
At Time! non-null The timestamp of the page creation.
- Anchor to handlehandle•String!non-null
A human-friendly unique string for the page automatically generated from its title.
- •ID!non-null
A globally-unique ID.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespace
andkey
, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•[Metafield]!non-null
A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to onlineStoreUrlonline•URL
Store 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
The page's SEO information.
- Anchor to titletitle•String!non-null
The title of the page.
- Anchor to trackingParameterstracking•String
Parameters URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.
- Anchor to updatedAtupdated•Date
At Time! non-null The timestamp of the latest page update.
- •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 to create or update different versions of the same product. You can also add or update product media. Products can be organized by grouping them into a collection.
Learn more about working with products and collections.
- Anchor to adjacentVariantsadjacent•[Product
Variants Variant!]! 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.- Anchor to availableForSaleavailable•Boolean!
For Sale non-null Indicates if at least one product variant is available for sale.
- Anchor to categorycategory•Taxonomy
Category The category of a product from Shopify's Standard Product Taxonomy.
- Anchor to collectionscollections•Collection
Connection! non-null A list of collections that include the product.
- Anchor to compareAtPriceRangecompare•Product
At Price Range Price Range! non-null The compare-at price range of the product in the shop's default currency.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the product was created.
- Anchor to descriptiondescription•String!non-null
A single-line description of the product, with HTML tags removed.
- Anchor to truncateAttruncate
At
Arguments