Skip to main content
Anchor to OnlineStorePublishable

OnlineStorePublishable

interface

Represents a resource that can be published to the Online Store sales channel.

•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.


Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to ArticleArticle
•OBJECT

A post that belongs to a Blog. Each article includes content with optional HTML formatting, an excerpt for previews, ArticleAuthor information, and an associated Image.

Articles can be organized with tags and include SEO metadata. You can manage comments when the blog's comment policy enables them.

•OBJECT

A blog container for Article objects. Stores can have multiple blogs, for example to organize content by topic or purpose.

Each blog provides access to its articles, contributing ArticleAuthor objects, and SEO information. You can retrieve articles individually by handle or as a paginated list.

•OBJECT

A group of products organized by a merchant to make their store easier to browse. Collections can help customers discover related products by category, season, promotion, or other criteria.

Query a collection's products with filtering options like availability, price range, vendor, and tags. Each collection includes SEO information, an optional Image, and supports custom data through metafields.

•OBJECT

An instance of custom structured data defined by a metaobject definition. Metaobjects store reusable content that extends beyond standard Shopify resources, such as size charts, author profiles, or custom content sections.

Each metaobject contains fields that match the types and validation rules specified in its definition. Metafield references can point to metaobjects, connecting custom data with products, collections, and other resources. If the definition has the renderable capability, then the seo field provides SEO metadata. If it has the online_store capability, then the onlineStoreUrl field returns the public URL.

•OBJECT

A custom content page on a merchant's store. Pages display HTML-formatted content, such as "About Us", contact details, or store policies.

Each page has a unique handle for URL routing and includes SEO information for search engine optimization. Pages support Metafield attachments for storing additional custom data.

•OBJECT

Represents an item listed in a shop's catalog.

Products support multiple product variants, representing different versions of the same product, and can include various media types. Use the selectedOrFirstAvailableVariant or variantBySelectedOptions fields to help customers find the right variant based on their selections.

Products can be organized into collections, associated with selling plans for subscriptions, and extended with custom data through metafields.

Learn more about working with products and collections.


Was this section helpful?