Choose a version:

Publishable

interface

Represents a resource that can be published to a channel. A publishable resource can be either a Product or Collection.

Anchor to FieldsFields

Anchor to availablePublicationsCountavailablePublicationsCount

•Count

The number of publications that a resource is published to, without feedback errors.

Anchor to publishedOnPublicationpublishedOnPublication

•Boolean!

non-null

Whether the resource is published to a specified publication.

Anchor to publicationIdpublicationId •ID! required: The ID of the publication to check. For example, id: "gid://shopify/Publication/123".

Anchor to resourcePublicationsresourcePublications

•ResourcePublicationConnection!

non-null

The list of resources that are published to a publication.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to onlyPublishedonlyPublished •Boolean Default:true: Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to resourcePublicationsCountresourcePublicationsCount

•Count

The total number of publications that a resource is published to, including publications with feedback errors. To get a count that excludes publications with feedback errors, use availablePublicationsCount.

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.

Anchor to resourcePublicationsV2resourcePublicationsV2

•ResourcePublicationV2Connection!

non-null

The list of resources that are either published or staged to be published to a publication. By default, only publications to APP catalog types are returned. For Product and ProductVariant, use the catalogType argument to retrieve publications for other catalog types, such as COMPANY_LOCATION (B2B) or MARKET. Collection only supports publications to APP catalog types.

Arguments

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to catalogTypecatalogType

•CatalogType

Filter publications by catalog type. When not specified, defaults to APP. Has no effect on Collection, which only supports APP.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to onlyPublishedonlyPublished

•Boolean

Default:true

Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled or staged to be published.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to unpublishedPublicationsunpublishedPublications

•PublicationConnection!

non-null

The list of publications that the resource isn't published to.

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Deprecated fields

Anchor to publicationCountpublicationCount

•Int!

non-nullDeprecated

Anchor to onlyPublishedonlyPublished •Boolean Default:true: Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.

Anchor to publishedOnChannelpublishedOnChannel

•Boolean!

non-nullDeprecated

Anchor to channelIdchannelId •ID! required: The ID of the channel to check.

Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel

•Boolean!

non-nullDeprecated

Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication

•Boolean!

non-nullDeprecated

Anchor to unpublishedChannelsunpublishedChannels

•ChannelConnection!

non-nullDeprecated

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

Anchor to Collection Collection •OBJECT: The Collection object represents a group of products that merchants can organize to make their stores easier to browse and help customers find related products. Collections serve as the primary way to categorize and display products across online stores, sales channels, and marketing campaigns.

The Collection object provides information to:

Organize products by category, season, or promotion.

Automate product grouping using rules (for example, by tag, type, or price).

Configure product sorting and display order (for example, alphabetical, best-selling, price, or manual).

Manage collection visibility and publication across sales channels.

Add rich descriptions, images, and metadata to enhance discovery.

Note
Collections are unpublished by default. To make them available to customers, use the publishablePublish mutation after creation.
Note: Collections are unpublished by default. To make them available to customers, use the <a href="https://shopify.dev/docs/api/admin-graphql/latest/mutations/publishablePublish"><code><span class="PreventFireFoxApplyingGapToWBR">publishable<wbr/>Publish</span></code></a> mutation after creation.
Collections can be displayed in a store with Shopify's theme system through Liquid templates and can be customized with template suffixes for unique layouts. They also support advanced features like translated content, resource feedback, and contextual publication for location-based catalogs.

Learn about using metafields with collection conditions.
Anchor to Product 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 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 Shopify's product model, including limitations and considerations.
Anchor to ProductVariant ProductVariant •OBJECT: The ProductVariant object represents a version of a product that comes in more than one option, such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.

Use the ProductVariant object to manage the full lifecycle and configuration of a product's variants. Common use cases for using the ProductVariant object include:

Tracking inventory for each variant

Setting unique prices for each variant

Assigning barcodes and SKUs to connect variants to fulfillment services

Attaching variant-specific images and media

Setting delivery and tax requirements

Supporting product bundles, subscriptions, and selling plans

A ProductVariant is associated with a parent Product object. ProductVariant serves as the central link between a product's merchandising configuration, inventory, pricing, fulfillment, and sales channels within the GraphQL Admin API schema. Each variant can reference other GraphQL types such as:

InventoryItem: Used for inventory tracking

Image: Used for variant-specific images

SellingPlanGroup: Used for subscriptions and selling plans

Learn more about Shopify's product model.

Was this section helpful?

{

"availablePublicationsCount": "",

"publicationCount": {

"onlyPublished": ""

"publishedOnChannel": {

"channelId": ""

"publishedOnCurrentChannel": "",

"publishedOnCurrentPublication": "",

"publishedOnPublication": {

"publicationId": ""

"resourcePublications": {

"after": "",

"before": "",

"first": "",

"last": "",

"onlyPublished": "",

"reverse": ""

"resourcePublicationsCount": {

"onlyPublished": ""

"resourcePublicationsV2": {

"after": "",

"before": "",

"catalogType": "",

"first": "",

"last": "",

"onlyPublished": "",

"reverse": ""

"unpublishedChannels": {

"after": "",

"before": "",

"first": "",

"last": "",

"reverse": ""

"unpublishedPublications": {

"after": "",

"before": "",

"first": "",

"last": "",

"reverse": ""

}

Variables

{
	"availablePublicationsCount": "",
	"publicationCount": {
		"onlyPublished": ""
	},
	"publishedOnChannel": {
		"channelId": ""
	},
	"publishedOnCurrentChannel": "",
	"publishedOnCurrentPublication": "",
	"publishedOnPublication": {
		"publicationId": ""
	},
	"resourcePublications": {
		"after": "",
		"before": "",
		"first": "",
		"last": "",
		"onlyPublished": "",
		"reverse": ""
	},
	"resourcePublicationsCount": {
		"onlyPublished": ""
	},
	"resourcePublicationsV2": {
		"after": "",
		"before": "",
		"catalogType": "",
		"first": "",
		"last": "",
		"onlyPublished": "",
		"reverse": ""
	},
	"unpublishedChannels": {
		"after": "",
		"before": "",
		"first": "",
		"last": "",
		"reverse": ""
	},
	"unpublishedPublications": {
		"after": "",
		"before": "",
		"first": "",
		"last": "",
		"reverse": ""
	}
}

Schema

interface Publishable {
  availablePublicationsCount: Count
  publicationCount: Int!
  publishedOnChannel: Boolean!
  publishedOnCurrentChannel: Boolean!
  publishedOnCurrentPublication: Boolean!
  publishedOnPublication: Boolean!
  resourcePublications: ResourcePublicationConnection!
  resourcePublicationsCount: Count
  resourcePublicationsV2: ResourcePublicationV2Connection!
  unpublishedChannels: ChannelConnection!
  unpublishedPublications: PublicationConnection!
}