---
title: Publishable - GraphQL Admin
description: |-
Represents a resource that can be published to a channel.
A publishable resource can be either a Product or Collection.
api_version: 2026-01
api_name: admin
type: interface
api_type: graphql
source_url:
html: 'https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Publishable'
md: 'https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Publishable.md'
---
# Publishable
interface
Represents a resource that can be published to a channel. A publishable resource can be either a Product or Collection.
## Fields
* availablePublicationsCount
[Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count)
The number of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that a resource is published to, without [feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback).
* publishedOnPublication
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether the resource is published to a specified [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication).
* publicationId
[ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)
required
### Arguments
The ID of the publication to check. For example, `id: "gid://shopify/Publication/123"`.
***
* resourcePublications
[ResourcePublicationConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ResourcePublicationConnection)
non-null
The list of resources that are published to a [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication).
* onlyPublished
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:true
### Arguments
Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
***
* resourcePublicationsCount
[Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count)
The number of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that a resource is published to, without [feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback).
* onlyPublished
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:true
### Arguments
Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
***
* resourcePublicationsV2
[ResourcePublicationV2Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ResourcePublicationV2Connection)
non-null
The list of resources that are either published or staged to be published to a [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication).
* onlyPublished
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:true
### Arguments
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.
* catalogType
[CatalogType](https://shopify.dev/docs/api/admin-graphql/latest/enums/CatalogType)
Filter publications by catalog type.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
***
* unpublishedPublications
[PublicationConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/PublicationConnection)
non-null
The list of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that the resource isn't published to.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
***
### Deprecated fields
* publicationCount
[Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
non-nullDeprecated
* onlyPublished
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:true
### Arguments
Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
***
* publishedOnChannel
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-nullDeprecated
* channelId
[ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)
required
### Arguments
The ID of the channel to check.
***
* publishedOnCurrentChannel
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-nullDeprecated
* publishedOnCurrentPublication
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-nullDeprecated
* unpublishedChannels
[ChannelConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ChannelConnection)
non-nullDeprecated
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
***
***
## Types implemented in
* [Collection](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection)
OBJECT
The `Collection` object represents a group of [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) 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](https://shopify.dev/docs/apps/build/online-store), [sales channels](https://shopify.dev/docs/apps/build/sales-channels), and marketing campaigns.
There are two types of collections:
* **[Custom (manual) collections](https://help.shopify.com/manual/products/collections/manual-shopify-collection)**: You specify the products to include in a collection.
* **[Smart (automated) collections](https://help.shopify.com/manual/products/collections/automated-collections)**: You define rules, and products matching those rules are automatically included in the collection.
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 \\\publishable\Publish\\\ mutation after creation.
***
Collections can be displayed in a store with Shopify's theme system through [Liquid templates](https://shopify.dev/docs/storefronts/themes/architecture/templates/collection) and can be customized with [template suffixes](https://shopify.dev/docs/storefronts/themes/architecture/templates/alternate-templates) 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 smart collections](https://shopify.dev/docs/apps/build/custom-data/metafields/use-metafield-capabilities).
* activeOperations
[CollectionOperations!](https://shopify.dev/docs/api/admin-graphql/latest/objects/CollectionOperations)
non-null
Collection duplicate operations involving this collection, either as a source (copying products from this collection to another) or a target (copying products to this collection from another).
* availablePublicationsCount
[Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count)
The number of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that a resource is published to, without [feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback).
* description
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
non-null
A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.
* truncateAt
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
Truncates a string after the given length.
***
* descriptionHtml
[HTML!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML)
non-null
The description of the collection, including any HTML tags and formatting. This content is typically displayed to customers, such as on an online store, depending on the theme.
* events
[EventConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection)
non-null
The paginated list of events associated with the host subject.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
* sortKey
[EventSortKeys](https://shopify.dev/docs/api/admin-graphql/latest/enums/EventSortKeys)
Default:ID
Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).
* query
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
* * action
string
* comments
boolean
* created\_at
time
* id
id
* subject\_type
string
- The action that occured.
- Example:
* `action:create`
Whether or not to include [comment-events](https://shopify.dev/api/admin-graphql/latest/objects/CommentEvent) in your search, passing `false` will exclude comment-events, any other value will include comment-events.
- Example:
* `false`
* `true`
Filter by the date and time when the event occurred. Event data is retained for 1 year.
- Example:
* `created_at:>2025-10-21`
* `created_at:=1234`
* `id:<=1234`
The resource type affected by this event. See [EventSubjectType](https://shopify.dev/api/admin-graphql/latest/enums/EventSubjectType) for possible values.
Example:
* `PRODUCT_VARIANT`
* `PRODUCT`
* `COLLECTION`
***
* feedback
[ResourceFeedback](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback)
Information about the collection that's provided through resource feedback.
* handle
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
non-null
A unique string that identifies the collection. If a handle isn't specified when a collection is created, it's automatically generated from the collection's original title, and typically includes words from the title separated by hyphens. For example, a collection that was created with the title `Summer Catalog 2022` might have the handle `summer-catalog-2022`.
If the title is changed, the handle doesn't automatically change.
The handle can be used in themes by the Liquid templating language to refer to the collection, but using the ID is preferred because it never changes.
* hasProduct
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether the collection includes the specified product.
* id
[ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)
required
### Arguments
The ID of the product to check.
***
* id
[ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)
non-null
A globally-unique ID.
* image
[Image](https://shopify.dev/docs/api/admin-graphql/latest/objects/Image)
The image associated with the collection.
* maxWidth
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
Deprecated
### Arguments
* maxHeight
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
Deprecated
* crop
[CropRegion](https://shopify.dev/docs/api/admin-graphql/latest/enums/CropRegion)
Deprecated
* scale
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
DeprecatedDefault:1
***
* legacyResourceId
[UnsignedInt64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64)
non-null
The ID of the corresponding resource in the REST Admin API.
* metafield
[Metafield](https://shopify.dev/docs/api/admin-graphql/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.
* namespace
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
### Arguments
The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
* key
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
required
The key for the metafield.
***
* metafields
[MetafieldConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection)
non-null
A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource.
* namespace
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
### Arguments
The metafield namespace to filter by. If omitted, all metafields are returned.
* keys
[\[String!\]](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
List of keys of metafields in the format `namespace.key`, will be returned in the same format.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
***
* products
[ProductConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductConnection)
non-null
The products that are included in the collection.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
* sortKey
[ProductCollectionSortKeys](https://shopify.dev/docs/api/admin-graphql/latest/enums/ProductCollectionSortKeys)
Default:COLLECTION\_DEFAULT
Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).
***
* productsCount
[Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count)
The number of products in the collection.
* publishedOnPublication
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether the resource is published to a specified [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication).
* publicationId
[ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)
required
### Arguments
The ID of the publication to check. For example, `id: "gid://shopify/Publication/123"`.
***
* resourcePublications
[ResourcePublicationConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ResourcePublicationConnection)
non-null
The list of resources that are published to a [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication).
* onlyPublished
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:true
### Arguments
Whether to return only the resources that are currently published. If false, then also returns the resources that are scheduled to be published.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
***
* resourcePublicationsCount
[Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count)
The number of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that a resource is published to, without [feedback errors](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback).
* onlyPublished
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:true
### Arguments
Include only the resource's publications that are published. If false, then return all the resource's publications including future publications.
***
* resourcePublicationsV2
[ResourcePublicationV2Connection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ResourcePublicationV2Connection)
non-null
The list of resources that are either published or staged to be published to a [publication](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication).
* onlyPublished
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:true
### Arguments
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.
* catalogType
[CatalogType](https://shopify.dev/docs/api/admin-graphql/latest/enums/CatalogType)
Filter publications by catalog type.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
***
* ruleSet
[CollectionRuleSet](https://shopify.dev/docs/api/admin-graphql/latest/objects/CollectionRuleSet)
For a smart (automated) collection, specifies the rules that determine whether a product is included.
* seo
[SEO!](https://shopify.dev/docs/api/admin-graphql/latest/objects/SEO)
non-null
If the default SEO fields for page title and description have been modified, contains the modified information.
* sortOrder
[CollectionSortOrder!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CollectionSortOrder)
non-null
The order in which the products in the collection are displayed by default in the Shopify admin and in sales channels, such as an online store.
* templateSuffix
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The suffix of the Liquid template being used to show the collection in an online store. For example, if the value is `custom`, then the collection is using the `collection.custom.liquid` template. If the value is `null`, then the collection is using the default `collection.liquid` template.
* title
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
non-null
The name of the collection. It's displayed in the Shopify admin and is typically displayed in sales channels, such as an online store.
* translations
[\[Translation!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation)
non-null
The published translations associated with the resource.
* locale
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
required
### Arguments
Filters translations locale.
* marketId
[ID](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)
Filters translations by market ID. Use this argument to retrieve content specific to a market.
***
* unpublishedPublications
[PublicationConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/PublicationConnection)
non-null
The list of [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that the resource isn't published to.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
***
* updatedAt
[DateTime!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
non-null
The date and time ([ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the collection was last modified.
* metafieldDefinitions
[MetafieldDefinitionConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldDefinitionConnection)
non-nullDeprecated
* namespace
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
### Arguments
Filter metafield definitions by namespace.
* pinnedStatus
[MetafieldDefinitionPinnedStatus](https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldDefinitionPinnedStatus)
Default:ANY
Filter by the definition's pinned status.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
* sortKey
[MetafieldDefinitionSortKeys](https://shopify.dev/docs/api/admin-graphql/latest/enums/MetafieldDefinitionSortKeys)
Default:ID
Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).
* query
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
* * default
string
* created\_at
time
* id
id
* key
string
* namespace
string
* owner\_type
string
* type
string
* updated\_at
time
- Filter by a case-insensitive search of multiple fields in a document.
- Example:
* `query=Bob Norman`
* `query=title:green hoodie`
Filter by the date and time when the metafield definition was created.
- Example:
* `created_at:>2020-10-21T23:39:20Z`
* `created_at:=1234`
* `id:<=1234`
Filter by the metafield definition [`key`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-key) field.
- Example:
* `key:some-key`
Filter by the metafield definition [`namespace`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-namespace) field.
- Example:
* `namespace:some-namespace`
Filter by the metafield definition [`ownerType`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-ownertype) field.
- Example:
* `owner_type:PRODUCT`
Filter by the metafield definition [`type`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-type) field.
- Example:
* `type:single_line_text_field`
Filter by the date and time when the metafield definition was last updated.
Example:
* `updated_at:>2020-10-21T23:39:20Z`
* `updated_at:=1234`
* `id:<=1234`
Filter by collections containing a product by its ID.
* * product\_publication\_status
string
* publishable\_status
string
* published\_at
time
- Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the [channel `app` ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#field-Channel.fields.app) (`Channel.app.id`) and one of the valid values. For simple visibility checks, use [published\_status](https://shopify.dev/api/admin-graphql/latest/queries/products#argument-query-filter-publishable_status) instead.
- Valid values:
* `* {channel_app_id}-approved`
* `* {channel_app_id}-rejected`
* `* {channel_app_id}-needs_action`
* `* {channel_app_id}-awaiting_review`
* `* {channel_app_id}-published`
* `* {channel_app_id}-demoted`
* `* {channel_app_id}-scheduled`
* `* {channel_app_id}-provisionally_published`
Example:
* `product_publication_status:189769876-approved`
**Deprecated:** This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use [published\_status](https://shopify.dev/api/admin-graphql/latest/queries/products#argument-query-filter-publishable_status) for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the [channel `app` ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price) (`Channel.app.id`) and one of the valid status values.
- Valid values:
* `* {channel_app_id}-unset`
* `* {channel_app_id}-pending`
* `* {channel_app_id}-approved`
* `* {channel_app_id}-not_approved`
Example:
* `publishable_status:580111-unset`
* `publishable_status:580111-pending`
Filter by the date and time when the collection was published to the Online Store.
* * published\_status
string
* title
string
- Filter resources by their visibility and publication state on a channel. Online store channel filtering: - `online_store_channel`: Returns all resources in the online store channel, regardless of publication status. - `published`/`visible`: Returns resources that are published to the online store. - `unpublished`: Returns resources that are not published to the online store. Channel-specific filtering using the [channel `app` ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price) (`Channel.app.id`) with suffixes: - `{channel_app_id}-published`: Returns resources published to the specified channel. - `{channel_app_id}-visible`: Same as `{channel_app_id}-published` (kept for backwards compatibility). - `{channel_app_id}-intended`: Returns resources added to the channel but not yet published. - `{channel_app_id}-hidden`: Returns resources not added to the channel or not published. Other: - `unavailable`: Returns resources not published to any channel.
- Valid values:
* `online_store_channel`
* `published`
* `visible`
* `unpublished`
* `* {channel_app_id}-published`
* `* {channel_app_id}-visible`
* `* {channel_app_id}-intended`
* `* {channel_app_id}-hidden`
* `unavailable`
Example:
* `published_status:online_store_channel`
* `published_status:published`
* `published_status:580111-published`
* `published_status:580111-hidden`
* `published_status:unavailable`
* updated\_at
time
***
* combinedListing
[CombinedListing](https://shopify.dev/docs/api/admin-graphql/latest/objects/CombinedListing)
A special product type that combines separate products from a store into a single product listing. [Combined listings](https://shopify.dev/apps/build/product-merchandising/combined-listings) are connected by a shared option, such as color, model, or dimension.
* combinedListingRole
[CombinedListingsRole](https://shopify.dev/docs/api/admin-graphql/latest/enums/CombinedListingsRole)
The [role of the product](https://shopify.dev/docs/apps/build/product-merchandising/combined-listings/build-for-combined-listings) in a combined listing.
If `null`, then the product isn't part of any combined listing.
* compareAtPriceRange
[ProductCompareAtPriceRange](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductCompareAtPriceRange)
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.
* contextualPricing
[ProductContextualPricing!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductContextualPricing)
non-null
The pricing that applies to a customer in a specific context. For example, a price might vary depending on the customer's location. Only active markets are considered in the price resolution.
* context
[ContextualPricingContext!](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/ContextualPricingContext)
required
### Arguments
The context used to generate contextual pricing for the variant.
***
* createdAt
[DateTime!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)
non-null
The date and time when the product was created.
* defaultCursor
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
non-null
A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID.
* description
[String!](https://shopify.dev/docs/api/admin-graphql/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.
* truncateAt
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
Truncates a string after the given length.
***
* descriptionHtml
[HTML!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/HTML)
non-null
The description of the product, with HTML tags. For example, the description might include bold `` and italic `` text.
* events
[EventConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/EventConnection)
non-null
The paginated list of events associated with the host subject.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
* sortKey
[EventSortKeys](https://shopify.dev/docs/api/admin-graphql/latest/enums/EventSortKeys)
Default:ID
Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).
* query
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
* * action
string
* comments
boolean
* created\_at
time
* id
id
* subject\_type
string
- The action that occured.
- Example:
* `action:create`
Whether or not to include [comment-events](https://shopify.dev/api/admin-graphql/latest/objects/CommentEvent) in your search, passing `false` will exclude comment-events, any other value will include comment-events.
- Example:
* `false`
* `true`
Filter by the date and time when the event occurred. Event data is retained for 1 year.
- Example:
* `created_at:>2025-10-21`
* `created_at:=1234`
* `id:<=1234`
The resource type affected by this event. See [EventSubjectType](https://shopify.dev/api/admin-graphql/latest/enums/EventSubjectType) for possible values.
Example:
* `PRODUCT_VARIANT`
* `PRODUCT`
* `COLLECTION`
***
* featuredMedia
[Media](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Media)
The featured [media](https://shopify.dev/docs/apps/build/online-store/product-media) associated with the product.
* feedback
[ResourceFeedback](https://shopify.dev/docs/api/admin-graphql/latest/objects/ResourceFeedback)
The information that lets merchants know what steps they need to take to make sure that the app is set up correctly.
For example, if a merchant hasn't set up a product correctly in the app, then the feedback might include a message that says "You need to add a price to this product".
* giftCardTemplateSuffix
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The [theme template](https://shopify.dev/docs/storefronts/themes/architecture/templates) that's used when customers view the gift card in a store.
* handle
[String!](https://shopify.dev/docs/api/admin-graphql/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.
* hasOnlyDefaultVariant
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether the product has only a single variant with the default option and value.
* hasOutOfStockVariants
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether the product has variants that are out of stock.
* hasVariantsThatRequiresComponents
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether at least one of the product variants requires [bundle components](https://shopify.dev/docs/apps/build/product-merchandising/bundles/add-product-fixed-bundle).
Learn more about [store eligibility for bundles](https://shopify.dev/docs/apps/build/product-merchandising/bundles#store-eligibility).
* id
[ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)
non-null
A globally-unique ID.
* inCollection
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether the product is in a specified [collection](https://shopify.dev/docs/api/admin-graphql/latest/objects/collection).
* id
[ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)
required
### Arguments
The ID of the collection to check. For example, `id: "gid://shopify/Collection/123"`.
***
* isGiftCard
[Boolean!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
non-null
Whether the product is a gift card.
* legacyResourceId
[UnsignedInt64!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/UnsignedInt64)
non-null
The ID of the corresponding resource in the REST Admin API.
* media
[MediaConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MediaConnection)
non-null
The [media](https://shopify.dev/docs/apps/build/online-store/product-media) associated with the product. Valid media are images, 3D models, videos.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
* sortKey
[ProductMediaSortKeys](https://shopify.dev/docs/api/admin-graphql/latest/enums/ProductMediaSortKeys)
Default:POSITION
Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).
* query
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
* * id
id
* media\_type
string
- Filter by `id` range.
- Example:
* `id:1234`
* `id:>=1234`
* `id:<=1234`
Valid values:
* `IMAGE`
* `VIDEO`
* `MODEL_3D`
* `EXTERNAL_VIDEO`
***
* mediaCount
[Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count)
The total count of [media](https://shopify.dev/docs/apps/build/online-store/product-media) that's associated with a product.
* metafield
[Metafield](https://shopify.dev/docs/api/admin-graphql/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.
* namespace
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
### Arguments
The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
* key
[String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
required
The key for the metafield.
***
* metafields
[MetafieldConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/MetafieldConnection)
non-null
A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource.
* namespace
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
### Arguments
The metafield namespace to filter by. If omitted, all metafields are returned.
* keys
[\[String!\]](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
List of keys of metafields in the format `namespace.key`, will be returned in the same format.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
***
* onlineStorePreviewUrl
[URL](https://shopify.dev/docs/api/admin-graphql/latest/scalars/URL)
The [preview URL](https://help.shopify.com/manual/online-store/setting-up#preview-your-store) for the online store.
* onlineStoreUrl
[URL](https://shopify.dev/docs/api/admin-graphql/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
[\[ProductOption!\]!](https://shopify.dev/docs/api/admin-graphql/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`).
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
Truncate the array result to this size.
***
* priceRangeV2
[ProductPriceRangeV2!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductPriceRangeV2)
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.
* productComponents
[ProductComponentTypeConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductComponentTypeConnection)
non-null
A list of products that contain at least one variant associated with at least one of the current products' variants via group relationship.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
***
* productComponentsCount
[Count](https://shopify.dev/docs/api/admin-graphql/latest/objects/Count)
A count of unique products that contain at least one variant associated with at least one of the current products' variants via group relationship.
* productParents
[ProductConnection!](https://shopify.dev/docs/api/admin-graphql/latest/connections/ProductConnection)
non-null
A list of products that has a variant that contains any of this product's variants as a component.
* first
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
### Arguments
The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* after
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* last
[Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int)
The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).
* before
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).
* reverse
[Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean)
Default:false
Reverse the order of the underlying list.
* query
[String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String)
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).
* * default
string
* barcode
string
* bundles
boolean
* category\_id
string
* collection\_id
id
* combined\_listing\_role
string
* created\_at
time
* delivery\_profile\_id
id
* error\_feedback
string
- Filter by a case-insensitive search of multiple fields in a document.
- Example:
* `query=Bob Norman`
* `query=title:green hoodie`
Filter by the product variant [`barcode`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-barcode) field.
- Example:
* `barcode:ABC-abc-1234`
Filter by a [product bundle](https://shopify.dev/docs/apps/build/product-merchandising/bundles). A product bundle is a set of two or more related products, which are commonly offered at a discount.
- Example:
* `bundles:true`
Filter by the product [category ID](https://shopify.dev/api/admin-graphql/latest/objects/Product#field-category) (`product.category.id`). A product category is 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).
- Example:
* `category_id:sg-4-17-2-17`
Filter by the collection [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Collection#field-id) field.
- Example:
* `collection_id:108179161409`
Filter by the role of the product in a [combined listing](https://shopify.dev/apps/build/product-merchandising/combined-listings).
- Valid values:
* `parent`
* `child`
* `no_role`
Example:
* `combined_listing_role:parent`
Filter by the date and time when the product was created.
- Example:
* `created_at:>'2020-10-21T23:39:20Z'`
* `created_at:=1234`
* `id:<=1234`
Filter by inventory count.
- Example:
* `inventory_total:0`
* `inventory_total:>150`
* `inventory_total:>=200`
Filter by products that have a reduced price. For more information, refer to the [`CollectionRule`](https://shopify.dev/api/admin-graphql/latest/objects/CollectionRule) object.
- Example:
* `is_price_reduced:true`
Filters resources by metafield value. Format: `metafields.{namespace}.{key}:{value}`. Learn more about [querying by metafield value](https://shopify.dev/apps/build/custom-data/metafields/query-by-metafield-value).
- Example:
* `metafields.custom.on_sale:true`
* `metafields.product.material:"gid://shopify/Metaobject/43458085"`
Filter by products that are out of stock in at least one location.
- Example:
* `out_of_stock_somewhere:true`
Filter by the product variant [`price`](https://shopify.dev/api/admin-graphql/latest/objects/Productvariant#field-price) field.
- Example:
* `price:100.57`
Filter by the app [`id`](https://shopify.dev/api/admin-graphql/latest/objects/App#field-id) field.
- Example:
* `product_configuration_owner:10001`
Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the [channel `app` ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#field-Channel.fields.app) (`Channel.app.id`) and one of the valid values. For simple visibility checks, use [published\_status](https://shopify.dev/api/admin-graphql/latest/queries/products#argument-query-filter-publishable_status) instead.
- Valid values:
* `* {channel_app_id}-approved`
* `* {channel_app_id}-rejected`
* `* {channel_app_id}-needs_action`
* `* {channel_app_id}-awaiting_review`
* `* {channel_app_id}-published`
* `* {channel_app_id}-demoted`
* `* {channel_app_id}-scheduled`
* `* {channel_app_id}-provisionally_published`
Example:
* `product_publication_status:189769876-approved`
Filter by a comma-separated list of [product types](https://help.shopify.com/manual/products/details/product-type).
- Example:
* `product_type:snowboard`
Filter by a comma-separated list of publication IDs that are associated with the product.
- Example:
* `publication_ids:184111530305,184111694145`
**Deprecated:** This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use [published\_status](https://shopify.dev/api/admin-graphql/latest/queries/products#argument-query-filter-publishable_status) for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the [channel `app` ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price) (`Channel.app.id`) and one of the valid status values.
- Valid values:
* `* {channel_app_id}-unset`
* `* {channel_app_id}-pending`
* `* {channel_app_id}-approved`
* `* {channel_app_id}-not_approved`
Example:
* `publishable_status:580111-unset`
* `publishable_status:580111-pending`
Filter by the date and time when the product was published to the online store and other sales channels.
- Example:
* `published_at:>2020-10-21T23:39:20Z`
* `published_at:'2020-10-21T23:39:20Z'`
* `updated_at:2020-10-21T23:39:20Z`
* `created_at:=1234`
* `id:<=1234`
Filter by the metafield definition [`key`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-key) field.
- Example:
* `key:some-key`
Filter by the metafield definition [`namespace`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-namespace) field.
- Example:
* `namespace:some-namespace`
Filter by the metafield definition [`ownerType`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-ownertype) field.
- Example:
* `owner_type:PRODUCT`
Filter by the metafield definition [`type`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetafieldDefinition#field-type) field.
- Example:
* `type:single_line_text_field`
Filter by the date and time when the metafield definition was last updated.
Example:
* `updated_at:>2020-10-21T23:39:20Z`
* `updated_at: