Has Published Translations

Anchor to Article Article

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

•OBJECT

An article that contains content, author information, and metadata. Articles belong to a Blog and can include HTML-formatted body text, summary text, and an associated image. Merchants publish articles to share content, drive traffic, and engage customers.

Articles can be organized with tags and published immediately or scheduled for future publication using the publishedAt timestamp. The API manages comments on articles when the blog's comment policy enables them.

Anchor to authorauthor

•ArticleAuthor

The name of the author of the article.

Anchor to blogblog

•Blog!

non-null

The blog containing the article.

Anchor to bodybody

•HTML!

non-null

The text of the article's body, complete with HTML markup.

Anchor to commentscomments

•CommentConnection!

non-null

List of the article's comments.

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 queryquery •String: A filter made up of terms, connectives, modifiers, and comparators.

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
created_at time Filter by the date and time when the comment was
created. - created_at:>'2020-10-21T23:39:20Z'
-
created_at:<now
- created_at:<=2024
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
published_at time Filter by the date and time when the comment was
published. - published_at:>'2020-10-21T23:39:20Z'
-
published_at:<now
- published_at:<=2024
published_status string Filter by published status - any
-
published
- unpublished - published_status:any
-
published_status:published
- published_status:unpublished
status string
updated_at time Filter by the date and time when the comment was last
updated. - updated_at:>'2020-10-21T23:39:20Z'
-
updated_at:<now
- updated_at:<=2024
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to commentsCountcommentsCount

•Count

Count of comments. Limited to a maximum of 10000 by default.

Anchor to limitlimit •Int Default:10000: The upper bound on count value before returning a result. Use null to have no limit.
Anchor to queryquery •String: A filter made up of terms, connectives, modifiers, and comparators.

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
created_at time Filter by the date and time when the comment was
created. - created_at:>'2020-10-21T23:39:20Z'
-
created_at:<now
- created_at:<=2024
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
published_at time Filter by the date and time when the comment was
published. - published_at:>'2020-10-21T23:39:20Z'
-
published_at:<now
- published_at:<=2024
published_status string Filter by published status - any
-
published
- unpublished - published_status:any
-
published_status:published
- published_status:unpublished
status string
updated_at time Filter by the date and time when the comment was last
updated. - updated_at:>'2020-10-21T23:39:20Z'
-
updated_at:<now
- updated_at:<=2024
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).

Anchor to createdAtcreatedAt

non-null

The date and time (ISO 8601 format) when the article was created.

Anchor to defaultCursordefaultCursor

non-null

A default cursor that returns the single next record, sorted ascending by ID.

non-null

The paginated list of events associated with the host subject.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

Anchor to action •string: The action that occured.

Default:false

Reverse the order of the underlying list.

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.

non-null

A unique, human-friendly string for the article that's automatically generated from the article's title. The handle is used in the article's URL.

•ID!

non-null

A globally-unique ID.

•Image

The image associated with the article.

Anchor to isPublishedisPublished

non-null

Whether or not the article is visible.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to publishedAtpublishedAt

The date and time (ISO 8601 format) when the article became or will become visible. Returns null when the article isn't visible.

Anchor to summarysummary

•HTML

A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page.

Anchor to tagstags

non-null

A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.

Anchor to templateSuffixtemplateSuffix

•String

The name of the template an article is using if it's using an alternate template. If an article is using the default article.liquid template, then the value returned is null.

non-null

The title of the article.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to updatedAtupdatedAt

The date and time (ISO 8601 format) when the article was last updated.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
created_at	time	Filter by the date and time when the metafield
definition was created.			- `created_at:>2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
key	string	Filter by the metafield definition `key`
field.			- `key:some-key`
namespace	string	Filter by the metafield definition `namespace`
field.			- `namespace:some-namespace`
owner_type	string	Filter by the metafield definition `ownerType`
field.			- `owner_type:PRODUCT`
type	string	Filter by the metafield definition `type`
field.			- `type:single_line_text_field`
updated_at	time	Filter by the date and time when the metafield
definition was last updated.			- `updated_at:>2020-10-21T23:39:20Z`

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

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.

Anchor to Blog Blog

•OBJECT

A blog for publishing articles in the online store. Stores can have multiple blogs to organize content by topic or purpose.

Each blog contains articles with their associated comments, tags, and metadata. The comment policy controls whether readers can post comments and whether moderation is required. Blogs use customizable URL handles and can apply alternate templates for specialized layouts.

Anchor to articlesarticles

•ArticleConnection!

non-null

List of the blog's articles.

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.

Anchor to articlesCountarticlesCount

•Count

Count of articles. Limited to a maximum of 10000 by default.

Anchor to limitlimit •Int Default:10000: The upper bound on count value before returning a result. Use null to have no limit.

Anchor to commentPolicycommentPolicy

•CommentPolicy!

non-null

Indicates whether readers can post comments to the blog and if comments are moderated or not.

Anchor to createdAtcreatedAt

non-null

The date and time when the blog was created.

non-null

The paginated list of events associated with the host subject.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

Anchor to action •string: The action that occured.

Default:false

Reverse the order of the underlying list.

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.

Anchor to feedfeed

•BlogFeed

FeedBurner provider details. Any blogs that aren't already integrated with FeedBurner can't use the service.

non-null

A unique, human-friendly string for the blog. If no handle is specified, a handle will be generated automatically from the blog title. The handle is customizable and is used by the Liquid templating language to refer to the blog.

•ID!

non-null

A globally-unique ID.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to tagstags

non-null

A list of tags associated with the 200 most recent blog articles.

Anchor to templateSuffixtemplateSuffix

•String

The name of the template a blog is using if it's using an alternate template. Returns null if a blog is using the default blog.liquid template.

non-null

The title of the blog.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to updatedAtupdatedAt

The date and time when the blog was update.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
created_at	time	Filter by the date and time when the metafield
definition was created.			- `created_at:>2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
key	string	Filter by the metafield definition `key`
field.			- `key:some-key`
namespace	string	Filter by the metafield definition `namespace`
field.			- `namespace:some-namespace`
owner_type	string	Filter by the metafield definition `ownerType`
field.			- `owner_type:PRODUCT`
type	string	Filter by the metafield definition `type`
field.			- `type:single_line_text_field`
updated_at	time	Filter by the date and time when the metafield
definition was last updated.			- `updated_at:>2020-10-21T23:39:20Z`

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

Anchor to Collection Collection

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.

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

There are two types of collections:

Custom (manual) collections: You specify the products to include in a collection.
Smart (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 publishablePublish 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 smart collections.

Anchor to activeOperationsactiveOperations

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

Anchor to availablePublicationsCountavailablePublicationsCount

•Count

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

Anchor to descriptiondescription

non-null

A single-line, text-only description of the collection, stripped of any HTML tags and formatting that were included in the description.

Anchor to truncateAttruncateAt •Int: Truncates a string after the given length.

Anchor to descriptionHtmldescriptionHtml

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

non-null

The paginated list of events associated with the host subject.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

Anchor to action •string: The action that occured.

Default:false

Reverse the order of the underlying list.

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.

Anchor to feedbackfeedback

•ResourceFeedback

Information about the collection that's provided through resource feedback.

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.

Anchor to hasProducthasProduct

non-null

Whether the collection includes the specified product.

Anchor to idid •ID! required: The ID of the product to check.

•ID!

non-null

A globally-unique ID.

•Image

The image associated with the collection.

Arguments

Deprecated

Anchor to maxHeightmaxHeight

•Int

Deprecated

Anchor to maxWidthmaxWidth

•Int

Deprecated

•Int

DeprecatedDefault:1

Anchor to legacyResourceIdlegacyResourceId

non-null

The ID of the corresponding resource in the REST Admin API.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to productsproducts

non-null

The products that are included in the collection.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Default:false

Reverse the order of the underlying list.

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

Anchor to productsCountproductsCount

•Count

The number of products in the collection.

Anchor to publishedOnPublicationpublishedOnPublication

•ResourcePublicationConnection!

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

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

•String

The elements that come after the specified cursor.

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

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to onlyPublishedonlyPublished

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.

Default:false

Reverse the order of the underlying list.

Anchor to ruleSetruleSet

•CollectionRuleSet

For a smart (automated) collection, specifies the rules that determine whether a product is included.

Anchor to seoseo

•SEO!

non-null

If the default SEO fields for page title and description have been modified, contains the modified information.

Anchor to sortOrdersortOrder

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

Anchor to templateSuffixtemplateSuffix

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

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.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

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.

Anchor to updatedAtupdatedAt

non-null

The date and time (ISO 8601 format) when the collection was last modified.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
created_at	time	Filter by the date and time when the metafield
definition was created.			- `created_at:>2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
key	string	Filter by the metafield definition `key`
field.			- `key:some-key`
namespace	string	Filter by the metafield definition `namespace`
field.			- `namespace:some-namespace`
owner_type	string	Filter by the metafield definition `ownerType`
field.			- `owner_type:PRODUCT`
type	string	Filter by the metafield definition `type`
field.			- `type:single_line_text_field`
updated_at	time	Filter by the date and time when the metafield
definition was last updated.			- `updated_at:>2020-10-21T23:39:20Z`

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

•CollectionPublicationConnection!

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.

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 publicationspublications

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 onlyPublishedonlyPublished •Boolean Default:true: Whether or not to return only the collection publications that are published.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to publishedOnChannelpublishedOnChannel

non-nullDeprecated

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

Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel

non-nullDeprecated

Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication

Anchor to CookieBanner CookieBanner

non-nullDeprecated

Anchor to storefrontIdstorefrontId

•StorefrontID!

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.

•OBJECT

A shop's banner settings.

Anchor to autoManagedautoManaged

non-null

Indicates if the banner is auto managed.

Anchor to enabledenabled

non-null

Indicates if the banner is enabled.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to Image Image

•OBJECT

Represents an image resource.

Anchor to altTextaltText

•String

A word or phrase to share the nature or contents of an image.

Anchor to heightheight

•Int

The original height of the image in pixels. Returns null if the image isn't hosted by Shopify.

•ID

A unique ID for the image.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to thumbhashthumbhash

•String

The ThumbHash of the image.

Useful to display placeholder images while the original image is loading.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

•URL!

non-null

The location of the image as a URL.

If no transform options are specified, then the original image will be preserved including any pre-applied transforms.

All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored.

If you need multiple variations of the same image, then you can use GraphQL aliases.

Arguments

Anchor to transformtransform

•ImageTransformInput

A set of options to transform the original image.

Anchor to widthwidth

•Int

The original width of the image in pixels. Returns null if the image isn't hosted by Shopify.

Anchor to originalSrcoriginalSrc

•URL!

non-nullDeprecated

Anchor to srcsrc

•URL!

non-nullDeprecated

Anchor to transformedSrctransformedSrc

•URL!

non-nullDeprecated

Arguments

Crops the image according to the specified region.

Anchor to maxHeightmaxHeight

•Int

Image height in pixels between 1 and 5760.

Anchor to maxWidthmaxWidth

•Int

Image width in pixels between 1 and 5760.

Anchor to preferredContentTypepreferredContentType

•ImageContentType

Best effort conversion of image into content type (SVG -> PNG, Anything -> JPG, Anything -> WEBP are supported).

•Int

Default:1

Image size multiplier for high-resolution retina displays. Must be between 1 and 3.

Anchor to Link Link

•OBJECT

A link to direct users to.

Anchor to labellabel

non-null

A context-sensitive label for the link.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to MediaImage MediaImage

•URL!

non-null

The URL that the link visits.

•OBJECT

The MediaImage object represents an image hosted on Shopify's content delivery network (CDN). Shopify CDN is a content system that serves as the primary way to store, manage, and deliver visual content for products, variants, and other resources across the Shopify platform.

The MediaImage object provides information to:

Store and display product and variant images across online stores, admin interfaces, and mobile apps.
Retrieve visual branding elements, including logos, banners, favicons, and background images in checkout flows.
Retrieve signed URLs for secure, time-limited access to original image files.

Each MediaImage object provides both the processed image data (with automatic optimization and CDN delivery) and access to the original source file. The image processing is handled asynchronously, so images might not be immediately available after upload. The status field indicates when processing is complete and the image is ready for use.

The MediaImage object implements the Media interface alongside other media types, like videos and 3D models.

Learn about managing media for products, product variants, and asynchronous media management.

Anchor to altalt

•String

A word or phrase to share the nature or contents of a media.

Anchor to createdAtcreatedAt

non-null

The date and time (ISO 8601 format) when the file was created.

Anchor to fileErrorsfileErrors

•[FileError!]!

non-null

Any errors that have occurred on the file.

Anchor to fileStatusfileStatus

•FileStatus!

non-null

The status of the file.

•ID!

non-null

A globally-unique ID.

•Image

The image for the media. Returns null until status is READY.

Anchor to mediaContentTypemediaContentType

•MediaContentType!

non-null

The media content type.

Anchor to mediaErrorsmediaErrors

•[MediaError!]!

non-null

Any errors which have occurred on the media.

Anchor to mediaWarningsmediaWarnings

•[MediaWarning!]!

non-null

The warnings attached to the media.

Anchor to mimeTypemimeType

•String

The MIME type of the image.

Anchor to originalSourceoriginalSource

•MediaImageOriginalSource

The original source of the image.

Anchor to previewpreview

•MediaPreviewImage

The preview image for the media.

Anchor to statusstatus

•MediaStatus!

non-null

Current status of the media.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to updatedAtupdatedAt

non-null

The date and time (ISO 8601 format) when the file was last updated.

Anchor to metafieldmetafield

Deprecated

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

•OBJECT

Navigation menus that organize links into logical structures to guide customers through a store. Menus serve as the backbone of store navigation, making it easy for customers to find products, pages, and other content through organized hierarchical links.

For example, a merchant might create a main navigation menu with top-level categories like "Products," "About Us," and "Contact," where each category can contain nested menu items linking to specific collections, pages, or external resources.

Use the Menu object to:

Build and customize store navigation structures
Organize hierarchical menu systems with nested items
Work with default menus that can't be deleted
Access menu items for building navigation

Menus can be designated as default navigation elements (like main menu or footer), which can't be deleted and have restricted handle updates. The handle provides a unique identifier that themes can reference, while the items collection enables nested navigation structures.

Each menu contains menu items that can link to various resource types. This flexibility lets merchants create navigation experiences that guide customers through their store.

non-null

The menu's handle.

•ID!

non-null

A globally-unique ID.

non-null

Whether the menu is a default. The handle for default menus can't be updated and default menus can't be deleted.

•[MenuItem!]!

non-null

A list of items on the menu sorted by position.

Anchor to limitlimit •Int: The number of menu items to be returned.

non-null

The menu's title.

Anchor to Metafield Metafield

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

•OBJECT

Metafields enable you to attach additional information to a Shopify resource, such as a Product or a Collection. For more information about where you can attach metafields refer to HasMetafields. Some examples of the data that metafields enable you to store are specifications, size charts, downloadable documents, release dates, images, or part numbers. Metafields are identified by an owner resource, namespace, and key. and store a value along with type information for that value.

Anchor to compareDigestcompareDigest

non-null

The data stored in the resource, represented as a digest.

Anchor to createdAtcreatedAt

non-null

The date and time when the metafield was created.

Anchor to definitiondefinition

•MetafieldDefinition

The metafield definition that the metafield belongs to, if any.

•ID!

non-null

A globally-unique ID.

Anchor to jsonValuejsonValue

•JSON!

non-null

The data stored in the metafield in JSON format.

Anchor to keykey

non-null

The unique identifier for the metafield within its namespace.

Anchor to legacyResourceIdlegacyResourceId

non-null

The ID of the corresponding resource in the REST Admin API.

Anchor to namespacenamespace

•MetafieldReferenceConnection

non-null

The container for a group of metafields that the metafield is associated with.

Anchor to ownerowner

•HasMetafields!

non-null

The resource that the metafield is attached to.

Anchor to ownerTypeownerType

•MetafieldOwnerType!

non-null

The type of resource that the metafield is attached to.

Anchor to referencereference

•MetafieldReference

Returns a reference object if the metafield definition's type is a resource reference.

Anchor to referencesreferences

A list of reference objects if the metafield's type is a resource reference list.

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 translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to typetype

non-null

The type of data that's stored in the metafield. Refer to the list of supported types.

Anchor to updatedAtupdatedAt

non-null

The date and time when the metafield was updated.

Anchor to valuevalue

Anchor to OnlineStoreTheme OnlineStoreTheme

non-null

The data stored in the metafield. Always stored as a string, regardless of the metafield's type.

Anchor to descriptiondescription

•String

Deprecated

•OBJECT

A theme for display on the storefront. Themes control the visual appearance and functionality of the online store through templates, stylesheets, and assets that determine how products, collections, and other content display to customers.

Each theme has a role that indicates its status. Main themes are live on the storefront, unpublished themes are inactive, demo themes require purchase before publishing, and development themes are temporary for previewing during development. The theme includes translations for multi-language support.

Anchor to createdAtcreatedAt

•OnlineStoreThemeFileConnection

non-null

The date and time when the theme was created.

Anchor to filesfiles

The files in the theme.

Anchor to afterafter •String: A cursor for use in pagination.
Anchor to filenamesfilenames •[String!]: The filenames of the theme files. At most 50 filenames can be specified. Use '*' to match zero or more characters.
Anchor to firstfirst •Int Default:50: Returns at most the first n files for this theme. Fewer than n files may be returned to stay within the payload size limit, or when the end of the list is reached. At most 2500 can be fetched at once.

•ID!

non-null

A globally-unique ID.

non-null

The name of the theme, set by the merchant.

Anchor to prefixprefix

non-null

The prefix of the theme.

Anchor to processingprocessing

non-null

Whether the theme is processing.

Anchor to processingFailedprocessingFailed

non-null

Whether the theme processing failed.

Anchor to rolerole

•ThemeRole!

non-null

The role of the theme.

Anchor to themeStoreIdthemeStoreId

•Int

The theme store ID.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to updatedAtupdatedAt

non-null

The date and time when the theme was last updated.

Anchor to Page Page

•OBJECT

A standalone content page in the online store. Pages display HTML-formatted content for informational pages like "About Us", contact information, or shipping policies.

Each page has a unique handle for URL routing and supports custom template suffixes for specialized layouts. Pages can be published or hidden, and include creation and update timestamps.

Anchor to bodybody

•HTML!

non-null

The text content of the page, complete with HTML markup.

Anchor to bodySummarybodySummary

non-null

The first 150 characters of the page body. If the page body contains more than 150 characters, additional characters are truncated by ellipses.

Anchor to createdAtcreatedAt

non-null

The date and time (ISO 8601 format) of the page creation.

Anchor to defaultCursordefaultCursor

non-null

A default cursor that returns the single next record, sorted ascending by ID.

non-null

The paginated list of events associated with the host subject.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

Anchor to action •string: The action that occured.

Default:false

Reverse the order of the underlying list.

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.

non-null

A unique, human-friendly string for the page. In themes, the Liquid templating language refers to a page by its handle.

•ID!

non-null

A globally-unique ID.

Anchor to isPublishedisPublished

non-null

Whether or not the page is visible.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to publishedAtpublishedAt

The date and time (ISO 8601 format) when the page became or will become visible. Returns null when the page isn't visible.

Anchor to templateSuffixtemplateSuffix

•String

The suffix of the template that's used to render the page.

non-null

Title of the page.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to updatedAtupdatedAt

non-null

The date and time (ISO 8601 format) of the latest page update.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
created_at	time	Filter by the date and time when the metafield
definition was created.			- `created_at:>2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
key	string	Filter by the metafield definition `key`
field.			- `key:some-key`
namespace	string	Filter by the metafield definition `namespace`
field.			- `namespace:some-namespace`
owner_type	string	Filter by the metafield definition `ownerType`
field.			- `owner_type:PRODUCT`
type	string	Filter by the metafield definition `type`
field.			- `type:single_line_text_field`
updated_at	time	Filter by the date and time when the metafield
definition was last updated.			- `updated_at:>2020-10-21T23:39:20Z`

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

Anchor to Product Product

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.

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

•Count

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

Anchor to bundleComponentsbundleComponents

•ProductBundleComponentConnection!

non-null

A list of components that are associated with a product in a bundle.

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.

Anchor to bundleConsolidatedOptionsbundleConsolidatedOptions

•[ComponentizedProductsBundleConsolidatedOption!]

A list of consolidated options for a product in a bundle.

Anchor to categorycategory

•TaxonomyCategory

The category of a product from Shopify's Standard Product Taxonomy.

Anchor to collectionscollections

•CollectionConnection!

non-null

A list of collections that include the product.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
collection_type	string		- `custom` - `smart`
handle	string
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
product_id	id	Filter by collections containing a product by its ID.
product_publication_status	string	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
(`Channel.app.id`) and one of the valid values. For simple visibility checks, use published_status
instead.	- `* {channel_app_id}-approved` - `*
{channel_app_id}-rejected`<br/> -` * {channel_app_id}-needs_action` -
`* {channel_app_id}-awaiting_review` - `*
{channel_app_id}-published`<br/> -` * {channel_app_id}-demoted`<br/> -` *
{channel_app_id}-scheduled`<br/> -` *
{channel_app_id}-provisionally_published`		-
`product_publication_status:189769876-approved`
publishable_status	string	Deprecated: This parameter is deprecated
as of 2025-12 and will be removed in a future API version. Use published_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.	- `*
{channel_app_id}-unset`<br/> -` * {channel_app_id}-pending`<br/> -` *
{channel_app_id}-approved`<br/> -` * {channel_app_id}-not_approved`		-
`publishable_status:580111-unset` - `publishable_status:580111-pending`
published_at	time	Filter by the date and time when the collection was published to the Online Store.
published_status	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
a channel ID, channel handle, [channel `app`
ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price)
(`Channel.app.id`), or app handle with suffixes: -
`{id_or_handle}-published`: Returns resources published to the specified
channel. - `{id_or_handle}-visible`: Same as `{id_or_handle}-published`
(kept for backwards compatibility). - `{id_or_handle}-intended`: Returns
resources added to the channel but not yet published. -
`{id_or_handle}-hidden`: Returns resources not added to the channel or not
published. Other: - `unavailable`: Returns resources not published to any
channel.	- `online_store_channel` - `published` - `visible`

unpublished
- * {channel_id_or_handle}-published
- * {channel_id_or_handle}-visible
- * {channel_id_or_handle}-intended
- * {channel_id_or_handle}-hidden
- * {channel_app_id_or_handle}-published
- * {channel_app_id_or_handle}-visible
- * {channel_app_id_or_handle}-intended
- * {channel_app_id_or_handle}-hidden
- unavailable | | - published_status:online_store_channel
- published_status:published
- published_status:580111-published
published_status:580111-hidden
- published_status:my-channel-handle-published
- published_status:unavailable | | title | string | | updated_at | time | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

•CollectionSortKeys

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.

Anchor to combinedListingcombinedListing

•CombinedListing

A special product type that combines separate products from a store into a single product listing. Combined listings are connected by a shared option, such as color, model, or dimension.

Anchor to combinedListingRolecombinedListingRole

•CombinedListingsRole

The role of the product in a combined listing.

If null, then the product isn't part of any combined listing.

Anchor to compareAtPriceRangecompareAtPriceRange

•ProductCompareAtPriceRange

The compare-at price range of the product in the shop's default currency.

Anchor to contextualPricingcontextualPricing

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

Arguments

Anchor to contextcontext

•ContextualPricingContext!

required

The context used to generate contextual pricing for the variant.

Anchor to createdAtcreatedAt

non-null

The date and time when the product was created.

Anchor to defaultCursordefaultCursor

non-null

A default cursor that returns the single next record, sorted ascending by ID.

Anchor to descriptiondescription

non-null

A single-line description of the product, with HTML tags removed.

Anchor to truncateAttruncateAt •Int: Truncates a string after the given length.

Anchor to descriptionHtmldescriptionHtml

•HTML!

non-null

The description of the product, with HTML tags. For example, the description might include bold  and italic  text.

non-null

The paginated list of events associated with the host subject.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

Anchor to action •string: The action that occured.

Default:false

Reverse the order of the underlying list.

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.

Anchor to featuredMediafeaturedMedia

•Media

The featured media associated with the product.

Anchor to feedbackfeedback

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

Anchor to giftCardTemplateSuffixgiftCardTemplateSuffix

•String

The theme template that's used when customers view the gift card in a store.

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.

Anchor to hasOnlyDefaultVarianthasOnlyDefaultVariant

non-null

Whether the product has only a single variant with the default option and value.

Anchor to hasOutOfStockVariantshasOutOfStockVariants

non-null

Whether the product has variants that are out of stock.

Anchor to hasVariantsThatRequiresComponentshasVariantsThatRequiresComponents

non-null

Whether at least one of the product variants requires bundle components.

Learn more about store eligibility for bundles.

•ID!

non-null

A globally-unique ID.

Anchor to inCollectioninCollection

non-null

Whether the product is in a specified collection.

Anchor to idid •ID! required: The ID of the collection to check. For example, id: "gid://shopify/Collection/123".

Anchor to isGiftCardisGiftCard

non-null

Whether the product is a gift card.

Anchor to legacyResourceIdlegacyResourceId

non-null

The ID of the corresponding resource in the REST Admin API.

Anchor to mediamedia

•MediaConnection!

non-null

The media associated with the product. Valid media are images, 3D models, videos.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

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

Anchor to id •id: Filter by id range.
Anchor to media_type •string

Default:false

Reverse the order of the underlying list.

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

Anchor to mediaCountmediaCount

•Count

The total count of media that's associated with a product.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

•ProductComponentTypeConnection!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to onlineStorePreviewUrlonlineStorePreviewUrl

•URL

The preview URL for the online store.

Anchor to onlineStoreUrlonlineStoreUrl

•URL

The product's URL on the online store. If null, then the product isn't published to the online store sales channel.

Anchor to optionsoptions

•[ProductOption!]!

non-null

A list of product options. The limit is defined by the shop's resource limits for product options (Shop.resourceLimits.maxProductOptions).

Anchor to firstfirst •Int: Truncate the array result to this size.

Anchor to priceRangeV2priceRangeV2

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

Anchor to productComponentsproductComponents

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.

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.

Anchor to productComponentsCountproductComponentsCount

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

Anchor to productParentsproductParents

non-null

A list of products that has a variant that contains any of this product's variants as a component.

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 queryquery •String: A filter made up of terms, connectives, modifiers, and comparators.

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
barcode string Filter by the product variant barcode
field. - barcode:ABC-abc-1234
bundles boolean 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. - bundles:true
category_id string Filter by the product category ID
(product.category.id). A product category is the category of a product
from Shopify's Standard Product Taxonomy.
- category_id:sg-4-17-2-17
collection_id id Filter by the collection id
field. - collection_id:108179161409
combined_listing_role string Filter by the role of the product in a combined listing.
- parent
- child
- no_role -
combined_listing_role:parent
created_at time Filter by the date and time when the product was
created. - created_at:>'2020-10-21T23:39:20Z'
-
created_at:<now
- created_at:<='2024'
delivery_profile_id id Filter by the delivery profile id
field. - delivery_profile_id:108179161409
error_feedback string Filter by products with publishing errors.
gift_card boolean Filter by the product isGiftCard
field. - gift_card:true
handle string Filter by a comma-separated list of product handles.
- handle:the-minimal-snowboard
has_only_composites boolean Filter by products that have only
composite variants. - has_only_composites:true
has_only_default_variant boolean Filter by products that have only a
default variant. A default variant is the only variant if no other variants
are specified. - has_only_default_variant:true
has_variant_with_components boolean Filter by products that have
variants with associated components. -
has_variant_with_components:true
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
inventory_total integer Filter by inventory count. -
inventory_total:0
- inventory_total:>150
-
inventory_total:>=200
is_price_reduced boolean Filter by products that have a reduced price.
For more information, refer to the CollectionRule
object. - is_price_reduced:true
metafields.{namespace}.{key} mixed Filters resources by metafield
value. Format: metafields.{namespace}.{key}:{value}. Learn more about
querying by metafield value.
- metafields.custom.on_sale:true
-
metafields.product.material:"gid://shopify/Metaobject/43458085"
out_of_stock_somewhere boolean Filter by products that are out of
stock in at least one location. - out_of_stock_somewhere:true
price bigdecimal Filter by the product variant price
field. - price:100.57
product_configuration_owner string Filter by the app
id
field. - product_configuration_owner:10001
product_publication_status string 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
(Channel.app.id) and one of the valid values. For simple visibility checks, use published_status
instead. - * {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` -
product_publication_status:189769876-approved
product_type string Filter by a comma-separated list of [product
types](https://help.shopify.com/manual/products/details/product-type).

product_type:snowboard | | publication_ids | string | Filter by a comma-separated list of publication IDs that are associated with the product. | | | - publication_ids:184111530305,184111694145 | | publishable_status | string | Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_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 (Channel.app.id) and one of the valid status values. | - * {channel_app_id}-unset
- * {channel_app_id}-pending
- * {channel_app_id}-approved
- * {channel_app_id}-not_approved | | - publishable_status:580111-unset
- publishable_status:580111-pending | | published_at | time | Filter by the date and time when the product was published to the online store and other sales channels. | | | - published_at:>2020-10-21T23:39:20Z
- published_at:<now
- published_at:<=2024 | | published_status | 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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. | - online_store_channel
- published
- visible

unpublished
- * {channel_id_or_handle}-published
- * {channel_id_or_handle}-visible
- * {channel_id_or_handle}-intended
- * {channel_id_or_handle}-hidden
- * {channel_app_id_or_handle}-published
- * {channel_app_id_or_handle}-visible
- * {channel_app_id_or_handle}-intended
- * {channel_app_id_or_handle}-hidden
- unavailable | | - published_status:online_store_channel
- published_status:published
- published_status:580111-published

published_status:580111-hidden
- published_status:my-channel-handle-published
- published_status:unavailable | | sku | string | Filter by the product variant sku field. Learn more about SKUs. | | | - sku:XYZ-12345 | | status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. | - active
- archived
- draft | active | - status:active,draft | | tag | string | Filter objects by the tag field. | | | - tag:my_tag | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - tag_not:my_tag | | title | string | Filter by the product title field. | | | - title:The Minimal Snowboard | | tracks_inventory | boolean | Filter by products that have inventory tracking enabled. | | | - tracks_inventory:true | | updated_at | time | Filter by the date and time when the product was last updated. | | | - updated_at:>'2020-10-21T23:39:20Z'
- updated_at:<now
- updated_at:<='2024' | | variant_id | id | Filter by the product variant id field. | | | - variant_id:45779434701121 | | variant_title | string | Filter by the product variant title field. | | | - variant_title:'Special ski wax' | | vendor | string | Filter by the origin or source of the product. Learn more about vendors and managing vendor information. | | | - vendor:Snowdevil
- vendor:Snowdevil OR vendor:Icedevil | You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to productTypeproductType

non-null

The product type that merchants define.

Anchor to publishedAtpublishedAt

The date and time when the product was published to the online store.

Anchor to publishedInContextpublishedInContext

•ContextualPublicationContext!

non-null

Whether the product is published for a customer only in a specified context. For example, a product might be published for a customer only in a specific location.

Arguments

Anchor to contextcontext

required

The context used to determine publication status.

Anchor to publishedOnPublicationpublishedOnPublication

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 requiresSellingPlanrequiresSellingPlan

•ResourcePublicationConnection!

non-null

Whether the product can only be purchased with a selling plan. 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.

Anchor to resourcePublicationsresourcePublications

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

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

Arguments

•String

The elements that come after the specified cursor.

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

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to onlyPublishedonlyPublished

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.

•SellingPlanGroupConnection!

Default:false

Reverse the order of the underlying list.

Anchor to restrictedForResourcerestrictedForResource

•RestrictedForResource

Whether the merchant can make changes to the product when they edit the order associated with the product. For example, a merchant might be restricted from changing product details when they edit an order.

Anchor to calculatedOrderIdcalculatedOrderId •ID! required: The resource Id of the order with edits applied but not saved.

Anchor to sellingPlanGroupssellingPlanGroups

non-null

A list of all selling plan groups that are associated with the product either directly, or through the product's variants.

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.

Anchor to sellingPlanGroupsCountsellingPlanGroupsCount

•Count

A count of selling plan groups that are associated with the product.

Anchor to seoseo

•SEO!

non-null

The SEO title and description that are associated with a product.

Anchor to statusstatus

•ProductStatus!

non-null

The product status, which controls visibility across all sales channels.

Anchor to tagstags

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 tagsAdd mutation.

Anchor to templateSuffixtemplateSuffix

•String

The theme template that's used when customers view the product in a store.

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.

Anchor to totalInventorytotalInventory

•Int!

non-null

The quantity of inventory that's in stock.

Anchor to tracksInventorytracksInventory

non-null

Whether inventory tracking has been enabled for the product.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

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.

Anchor to updatedAtupdatedAt

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.

Anchor to variantsvariants

•ProductVariantConnection!

non-null

A list of variants associated with the product. If querying a single product at the root, you can fetch up to 2048 variants.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Default:false

Reverse the order of the underlying list.

•ProductVariantSortKeys

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.

Anchor to variantsCountvariantsCount

•Count

The number of variants that are associated with the product.

Anchor to vendorvendor

non-null

The name of the product's vendor.

Anchor to bodyHtmlbodyHtml

•String

Deprecated

Anchor to customProductTypecustomProductType

•String

Deprecated

Anchor to descriptionPlainSummarydescriptionPlainSummary

non-nullDeprecated

Anchor to featuredImagefeaturedImage

•Image

Deprecated

Anchor to imagesimages

•ImageConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

Deprecated

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to maxHeightmaxHeight

•Int

Deprecated

Anchor to maxWidthmaxWidth

•Int

Deprecated

Default:false

Reverse the order of the underlying list.

•Int

DeprecatedDefault:1

•ProductImageSortKeys

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.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
created_at	time	Filter by the date and time when the metafield
definition was created.			- `created_at:>2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
key	string	Filter by the metafield definition `key`
field.			- `key:some-key`
namespace	string	Filter by the metafield definition `namespace`
field.			- `namespace:some-namespace`
owner_type	string	Filter by the metafield definition `ownerType`
field.			- `owner_type:PRODUCT`
type	string	Filter by the metafield definition `type`
field.			- `type:single_line_text_field`
updated_at	time	Filter by the date and time when the metafield
definition was last updated.			- `updated_at:>2020-10-21T23:39:20Z`

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

•ProductPublicationConnection!

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.

Anchor to priceRangepriceRange

•ProductPriceRange!

non-nullDeprecated

Anchor to productCategoryproductCategory

•ProductCategory

Deprecated

Anchor to productPublicationsproductPublications

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.

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 publicationspublications

•ProductPublicationConnection!

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 onlyPublishedonlyPublished •Boolean Default:true: Return only the publications that are published. If false, then return all publications.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to publishedOnChannelpublishedOnChannel

non-nullDeprecated

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

Anchor to publishedOnCurrentChannelpublishedOnCurrentChannel

non-nullDeprecated

Anchor to publishedOnCurrentPublicationpublishedOnCurrentPublication

Anchor to ProductOption ProductOption

non-nullDeprecated

Anchor to resourcePublicationOnCurrentPublicationresourcePublicationOnCurrentPublication

•ResourcePublicationV2

Deprecated

Anchor to sellingPlanGroupCountsellingPlanGroupCount

•Int!

non-nullDeprecated

Anchor to standardizedProductTypestandardizedProductType

•StandardizedProductType

Deprecated

Anchor to storefrontIdstorefrontId

•StorefrontID!

non-nullDeprecated

Anchor to totalVariantstotalVariants

•Int!

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.

•OBJECT

A product attribute that customers can choose from, such as "Size", "Color", or "Material". Product objects use options to define the different variations available for purchase. Each option has a name and a set of possible values that combine to create ProductVariant objects.

The option includes its display position, associated values, and optional LinkedMetafield for structured data. Options support translations for international selling and track which ProductOptionValue objects that variants actively use versus unused values that exist without associated variants.

•ID!

non-null

A globally-unique ID.

Anchor to linkedMetafieldlinkedMetafield

•LinkedMetafield

The metafield identifier linked to this option.

non-null

The product option’s name.

Anchor to optionValuesoptionValues

•[ProductOptionValue!]!

non-null

Similar to values, option_values returns all the corresponding option value objects to the product option, including values not assigned to any variants.

Anchor to positionposition

•Int!

non-null

The product option's position.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to valuesvalues

Anchor to ProductOptionValue ProductOptionValue

non-null

The corresponding value to the product option name.

•OBJECT

A specific value for a ProductOption, such as "Red" or "Blue" for a "Color" option. Each value can be assigned to ProductVariant objects to create different versions of a Product.

The value tracks whether any variants currently use it through the hasVariants field. Values can include visual representations through swatches that display colors or images. When linked to a Metafield, the linkedMetafieldValue provides additional structured data for the option value.

Anchor to hasVariantshasVariants

non-null

Whether the product option value has any linked variants.

•ID!

non-null

A globally-unique ID.

Anchor to linkedMetafieldValuelinkedMetafieldValue

•String

The value of the linked metafield.

non-null

The name of the product option value.

Anchor to swatchswatch

•ProductOptionValueSwatch

The swatch associated with the product option value.

Anchor to translationstranslations

Anchor to ProductVariant ProductVariant

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

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

Anchor to availableForSaleavailableForSale

•ProductVariantContextualPricing!

non-null

Whether the product variant is available for sale.

Anchor to barcodebarcode

•String

The value of the barcode associated with the product.

Anchor to compareAtPricecompareAtPrice

•Money

The compare-at price of the variant in the default shop currency.

Anchor to contextualPricingcontextualPricing

non-null

The pricing that applies for a customer in a given context. As of API version 2025-04, only active markets are considered in the price resolution.

Arguments

Anchor to contextcontext

•ContextualPricingContext!

required

The context used to generate contextual pricing for the variant.

Anchor to createdAtcreatedAt

non-null

The date and time when the variant was created.

Anchor to defaultCursordefaultCursor

non-null

A default cursor that returns the single next record, sorted ascending by ID.

Anchor to deliveryProfiledeliveryProfile

•DeliveryProfile

The delivery profile for the variant.

Anchor to displayNamedisplayName

non-null

Display name of the variant, based on product's title + variant's title.

non-null

The paginated list of events associated with the host subject.

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

Anchor to action •string: The action that occured.

Default:false

Reverse the order of the underlying list.

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.

•ProductVariantInventoryPolicy!

•ID!

non-null

A globally-unique ID.

Anchor to inventoryIteminventoryItem

•InventoryItem!

non-null

The inventory item, which is used to query for inventory information.

Anchor to inventoryPolicyinventoryPolicy

non-null

Whether customers are allowed to place an order for the product variant when it's out of stock.

Anchor to inventoryQuantityinventoryQuantity

•Int

The total sellable quantity of the variant.

Anchor to legacyResourceIdlegacyResourceId

non-null

The ID of the corresponding resource in the REST Admin API.

Anchor to mediamedia

•MediaConnection!

non-null

The media associated with the product variant.

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.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to positionposition

•Int!

non-null

The order of the product variant in the list of product variants. The first position in the list is 1.

Anchor to priceprice

•Money!

non-null

The price of the product variant in the default shop currency.

Anchor to productproduct

•Product!

non-null

The product that this variant belongs to.

Anchor to productParentsproductParents

•ProductVariantComponentConnection!

non-null

A list of products that have product variants that contain this variant as a product component.

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 queryquery •String: A filter made up of terms, connectives, modifiers, and comparators.

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
barcode string Filter by the product variant barcode
field. - barcode:ABC-abc-1234
bundles boolean 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. - bundles:true
category_id string Filter by the product category ID
(product.category.id). A product category is the category of a product
from Shopify's Standard Product Taxonomy.
- category_id:sg-4-17-2-17
collection_id id Filter by the collection id
field. - collection_id:108179161409
combined_listing_role string Filter by the role of the product in a combined listing.
- parent
- child
- no_role -
combined_listing_role:parent
created_at time Filter by the date and time when the product was
created. - created_at:>'2020-10-21T23:39:20Z'
-
created_at:<now
- created_at:<='2024'
delivery_profile_id id Filter by the delivery profile id
field. - delivery_profile_id:108179161409
error_feedback string Filter by products with publishing errors.
gift_card boolean Filter by the product isGiftCard
field. - gift_card:true
handle string Filter by a comma-separated list of product handles.
- handle:the-minimal-snowboard
has_only_composites boolean Filter by products that have only
composite variants. - has_only_composites:true
has_only_default_variant boolean Filter by products that have only a
default variant. A default variant is the only variant if no other variants
are specified. - has_only_default_variant:true
has_variant_with_components boolean Filter by products that have
variants with associated components. -
has_variant_with_components:true
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
inventory_total integer Filter by inventory count. -
inventory_total:0
- inventory_total:>150
-
inventory_total:>=200
is_price_reduced boolean Filter by products that have a reduced price.
For more information, refer to the CollectionRule
object. - is_price_reduced:true
metafields.{namespace}.{key} mixed Filters resources by metafield
value. Format: metafields.{namespace}.{key}:{value}. Learn more about
querying by metafield value.
- metafields.custom.on_sale:true
-
metafields.product.material:"gid://shopify/Metaobject/43458085"
out_of_stock_somewhere boolean Filter by products that are out of
stock in at least one location. - out_of_stock_somewhere:true
price bigdecimal Filter by the product variant price
field. - price:100.57
product_configuration_owner string Filter by the app
id
field. - product_configuration_owner:10001
product_publication_status string 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
(Channel.app.id) and one of the valid values. For simple visibility checks, use published_status
instead. - * {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` -
product_publication_status:189769876-approved
product_type string Filter by a comma-separated list of [product
types](https://help.shopify.com/manual/products/details/product-type).

product_type:snowboard | | publication_ids | string | Filter by a comma-separated list of publication IDs that are associated with the product. | | | - publication_ids:184111530305,184111694145 | | publishable_status | string | Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_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 (Channel.app.id) and one of the valid status values. | - * {channel_app_id}-unset
- * {channel_app_id}-pending
- * {channel_app_id}-approved
- * {channel_app_id}-not_approved | | - publishable_status:580111-unset
- publishable_status:580111-pending | | published_at | time | Filter by the date and time when the product was published to the online store and other sales channels. | | | - published_at:>2020-10-21T23:39:20Z
- published_at:<now
- published_at:<=2024 | | published_status | 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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. | - online_store_channel
- published
- visible

unpublished
- * {channel_id_or_handle}-published
- * {channel_id_or_handle}-visible
- * {channel_id_or_handle}-intended
- * {channel_id_or_handle}-hidden
- * {channel_app_id_or_handle}-published
- * {channel_app_id_or_handle}-visible
- * {channel_app_id_or_handle}-intended
- * {channel_app_id_or_handle}-hidden
- unavailable | | - published_status:online_store_channel
- published_status:published
- published_status:580111-published

published_status:580111-hidden
- published_status:my-channel-handle-published
- published_status:unavailable | | sku | string | Filter by the product variant sku field. Learn more about SKUs. | | | - sku:XYZ-12345 | | status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. | - active
- archived
- draft | active | - status:active,draft | | tag | string | Filter objects by the tag field. | | | - tag:my_tag | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - tag_not:my_tag | | title | string | Filter by the product title field. | | | - title:The Minimal Snowboard | | tracks_inventory | boolean | Filter by products that have inventory tracking enabled. | | | - tracks_inventory:true | | updated_at | time | Filter by the date and time when the product was last updated. | | | - updated_at:>'2020-10-21T23:39:20Z'
- updated_at:<now
- updated_at:<='2024' | | variant_id | id | Filter by the product variant id field. | | | - variant_id:45779434701121 | | variant_title | string | Filter by the product variant title field. | | | - variant_title:'Special ski wax' | | vendor | string | Filter by the origin or source of the product. Learn more about vendors and managing vendor information. | | | - vendor:Snowdevil
- vendor:Snowdevil OR vendor:Icedevil | You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to productVariantComponentsproductVariantComponents

non-null

A list of the product variant components.

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.

Anchor to requiresComponentsrequiresComponents

•SellingPlanGroupConnection!

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 and it will be omitted from channels that don't support bundles.

Anchor to selectedOptionsselectedOptions

•[SelectedOption!]!

non-null

List of product options applied to the variant.

Anchor to sellableOnlineQuantitysellableOnlineQuantity

•Int!

non-null

The total sellable quantity of the variant for online channels. This doesn't represent the total available inventory or capture limitations based on customer location.

Anchor to sellingPlanGroupssellingPlanGroups

non-null

A list of all selling plan groups defined in the current shop associated with the product variant.

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.

Anchor to sellingPlanGroupsCountsellingPlanGroupsCount

•Count

Count of selling plan groups associated with the product variant.

Anchor to showUnitPriceshowUnitPrice

non-null

Whether to show the unit price for this product variant.

Anchor to skusku

•String

A case-sensitive identifier for the product variant in the shop. Required in order to connect to a fulfillment service.

Anchor to taxabletaxable

non-null

Whether a tax is charged when the product variant is sold.

non-null

The title of the product variant.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to unitPriceunitPrice

•MoneyV2

The unit price value for the variant based on the variant measurement.

Anchor to unitPriceMeasurementunitPriceMeasurement

•UnitPriceMeasurement

The unit price measurement for the variant.

Anchor to updatedAtupdatedAt

non-null

The date and time (ISO 8601 format) when the product variant was last modified.

•Image

Deprecated

Arguments

Deprecated

Anchor to maxHeightmaxHeight

•Int

Deprecated

Anchor to maxWidthmaxWidth

•Int

Deprecated

•Int

DeprecatedDefault:1

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
created_at	time	Filter by the date and time when the metafield
definition was created.			- `created_at:>2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
key	string	Filter by the metafield definition `key`
field.			- `key:some-key`
namespace	string	Filter by the metafield definition `namespace`
field.			- `namespace:some-namespace`
owner_type	string	Filter by the metafield definition `ownerType`
field.			- `owner_type:PRODUCT`
type	string	Filter by the metafield definition `type`
field.			- `type:single_line_text_field`
updated_at	time	Filter by the date and time when the metafield
definition was last updated.			- `updated_at:>2020-10-21T23:39:20Z`

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

•ProductVariantPricePairConnection!

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.

Anchor to presentmentPricespresentmentPrices

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to presentmentCurrenciespresentmentCurrencies

•[CurrencyCode!]

The presentment currencies prices should return in.

Anchor to SellingPlan SellingPlan

Default:false

Reverse the order of the underlying list.

Anchor to sellingPlanGroupCountsellingPlanGroupCount

•Int!

non-nullDeprecated

Anchor to storefrontIdstorefrontId

•StorefrontID!

non-nullDeprecated

Anchor to taxCodetaxCode

•String

Deprecated

•OBJECT

How a product can be sold and purchased through recurring billing or deferred purchase options. Defines the specific terms for subscriptions, pre-orders, or try-before-you-buy offers, including when to bill customers, when to fulfill orders, and what pricing adjustments to apply.

Each selling plan has billing, delivery, and pricing policies that control the purchase experience. The plan's options and category help merchants organize and report on different selling strategies. Plans are grouped within a SellingPlanGroup that associates them with Product and ProductVariant objects.

Caution

Selling plans and associated records are automatically deleted 48 hours after a merchant uninstalls the App that created them. Back up these records if you need to restore them later.

Learn more about selling plans.

Anchor to billingPolicybillingPolicy

•SellingPlanBillingPolicy!

non-null

A selling plan policy which describes the recurring billing details.

Anchor to categorycategory

•SellingPlanCategory

The category used to classify the selling plan for reporting purposes.

Anchor to createdAtcreatedAt

non-null

The date and time when the selling plan was created.

Anchor to deliveryPolicydeliveryPolicy

•SellingPlanDeliveryPolicy!

non-null

A selling plan policy which describes the delivery details.

Anchor to descriptiondescription

•String

Buyer facing string which describes the selling plan commitment.

•ID!

non-null

A globally-unique ID.

Anchor to inventoryPolicyinventoryPolicy

•SellingPlanInventoryPolicy

When to reserve inventory for a selling plan.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

non-null

A customer-facing description of the selling plan.

If your store supports multiple currencies, then don't include country-specific pricing content, such as "Buy monthly, get 10$ CAD off". This field won't be converted to reflect different currencies.

Anchor to optionsoptions

•[SellingPlanPricingPolicy!]!

non-null

The values of all options available on the selling plan. Selling plans are grouped together in Liquid when they're created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.

Anchor to positionposition

•Int

Relative position of the selling plan for display. A lower position will be displayed before a higher position.

Anchor to pricingPoliciespricingPolicies

non-null

Selling plan pricing details.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
created_at	time	Filter by the date and time when the metafield
definition was created.			- `created_at:>2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
key	string	Filter by the metafield definition `key`
field.			- `key:some-key`
namespace	string	Filter by the metafield definition `namespace`
field.			- `namespace:some-namespace`
owner_type	string	Filter by the metafield definition `ownerType`
field.			- `owner_type:PRODUCT`
type	string	Filter by the metafield definition `type`
field.			- `type:single_line_text_field`
updated_at	time	Filter by the date and time when the metafield
definition was last updated.			- `updated_at:>2020-10-21T23:39:20Z`

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

Anchor to SellingPlanGroup SellingPlanGroup

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.

•OBJECT

A selling method that defines how products can be sold through purchase options like subscriptions, pre-orders, or try-before-you-buy. Groups one or more SellingPlan objects that share the same selling method and options.

The group provides buyer-facing labels and merchant-facing descriptions for the selling method. Associates Product and ProductVariant objects with selling plan groups to offer them through these purchase options.

Caution

Selling plan groups and their associated records are automatically deleted 48 hours after a merchant uninstalls the App that created them. Back up these records if you need to restore them later.

Anchor to appIdappId

•String

The ID for app, exposed in Liquid and product JSON.

Anchor to appliesToProductappliesToProduct

non-null

Whether the given product is directly associated to the selling plan group.

Anchor to productIdproductId •ID! required: The ID of the product.

Anchor to appliesToProductVariantappliesToProductVariant

non-null

Whether the given product variant is directly associated to the selling plan group.

Anchor to productVariantIdproductVariantId •ID! required: The ID of the product.

Anchor to appliesToProductVariantsappliesToProductVariants

non-null

Whether any of the product variants of the given product are associated to the selling plan group.

Anchor to productIdproductId •ID! required: The ID of the product.

Anchor to createdAtcreatedAt

non-null

The date and time when the selling plan group was created.

Anchor to descriptiondescription

•String

The merchant-facing description of the selling plan group.

•ID!

non-null

A globally-unique ID.

Anchor to merchantCodemerchantCode

non-null

The merchant-facing label of the selling plan group.

non-null

The buyer-facing label of the selling plan group.

Anchor to optionsoptions

non-null

The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they're created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.

Anchor to positionposition

•Int

The relative position of the selling plan group for display.

Anchor to productsproducts

non-null

Products associated to the selling plan group.

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.

Anchor to productsCountproductsCount

•Count

A count of products associated to the selling plan group.

Anchor to productVariantsproductVariants

•ProductVariantConnection!

non-null

Product variants associated to the selling plan group.

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 productIdproductId •ID: Filters the product variants by a product ID.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to productVariantsCountproductVariantsCount

•Count

A count of product variants associated to the selling plan group.

Anchor to productIdproductId •ID: The ID of the product to scope the count to.

Anchor to sellingPlanssellingPlans

•SellingPlanConnection!

non-null

Selling plans associated to the selling plan group.

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.

Anchor to summarysummary

•String

A summary of the policies associated to the selling plan group.

Anchor to translationstranslations

•[AvailableChannelDefinitionsByChannel!]!

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to Shop Shop

•OBJECT

The central configuration and settings hub for a Shopify store. Access business information, operational preferences, feature availability, and store-wide settings that control how the shop operates.

Includes core business details like the shop name, contact emails, billing address, and currency settings. The shop configuration determines customer account requirements, available sales channels, enabled features, payment settings, and policy documents. Also provides access to shop-level resources such as staff members, fulfillment services, navigation settings, and storefront access tokens.

Anchor to accountOwneraccountOwner

•StaffMember!

non-null

Account owner information.

Anchor to alertsalerts

•[ShopAlert!]!

non-null

A list of the shop's active alert messages that appear in the Shopify admin.

Anchor to allProductCategoriesListallProductCategoriesList

•[TaxonomyCategory!]!

non-null

A list of the shop's product categories. Limit: 1000 product categories.

Anchor to availableChannelAppsavailableChannelApps

•AppConnection!

non-null

The list of sales channels not currently installed on the shop.

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.

Anchor to channelDefinitionsForInstalledChannelschannelDefinitionsForInstalledChannels

non-null

List of all channel definitions associated with a shop.

Anchor to checkoutApiSupportedcheckoutApiSupported

non-null

Specifies whether the shop supports checkouts via Checkout API.

Anchor to contactEmailcontactEmail

non-null

The public-facing contact email address for the shop. Customers will use this email to communicate with the shop owner.

Anchor to countriesInShippingZonescountriesInShippingZones

•CountriesInShippingZones!

non-null

Countries that have been defined in shipping zones for the shop.

Anchor to createdAtcreatedAt

•ShopCustomerAccountsSetting!

non-null

The date and time when the shop was created.

Anchor to currencyCodecurrencyCode

•CurrencyCode!

non-null

The three letter code for the currency that the shop sells in.

Anchor to currencyFormatscurrencyFormats

•CurrencyFormats!

non-null

How currencies are displayed on your store.

Anchor to currencySettingscurrencySettings

•CurrencySettingConnection!

non-null

The presentment currency settings for the shop excluding the shop's own currency.

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.

Anchor to customerAccountscustomerAccounts

non-null

Whether customer accounts are required, optional, or disabled for the shop.

Anchor to customerAccountsV2customerAccountsV2

•CustomerAccountsV2!

non-null

Information about the shop's customer accounts.

Anchor to customerTagscustomerTags

non-null

A list of tags that have been added to customer accounts.

Anchor to firstfirst •Int! required: The first n elements from the paginated list.

Anchor to descriptiondescription

•String

The shop's meta description used in search engine results.

Anchor to draftOrderTagsdraftOrderTags

non-null

A list of tags that have been added to draft orders.

Anchor to firstfirst •Int! required: The first n elements from the paginated list.

Anchor to emailemail

non-null

The shop owner's email address. Shopify will use this email address to communicate with the shop owner.

Anchor to enabledPresentmentCurrenciesenabledPresentmentCurrencies

•[CurrencyCode!]!

non-null

The presentment currencies enabled for the shop.

Anchor to entitlementsentitlements

•EntitlementsType!

non-null

The entitlements for a shop.

Anchor to featuresfeatures

•ShopFeatures!

non-null

The set of features enabled for the shop.

Anchor to fulfillmentServicesfulfillmentServices

•[FulfillmentService!]!

non-null

List of the shop's installed fulfillment services.

Anchor to ianaTimezoneianaTimezone

non-null

The shop's time zone as defined by the IANA.

•ID!

non-null

A globally-unique ID.

Anchor to marketingSmsConsentEnabledAtCheckoutmarketingSmsConsentEnabledAtCheckout

non-null

Whether SMS marketing has been enabled on the shop's checkout configuration settings.

Anchor to merchantApprovalSignalsmerchantApprovalSignals

•MerchantApprovalSignals

The approval signals for a shop to support onboarding to channel apps.

Anchor to metafieldmetafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

non-null

A list of custom fields that a merchant associates with a Shopify resource.

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to myshopifyDomainmyshopifyDomain

non-null

The shop's .myshopify.com domain name.

non-null

The shop's name.

Anchor to navigationSettingsnavigationSettings

•[NavigationItem!]!

non-null

The shop's settings related to navigation.

Anchor to orderNumberFormatPrefixorderNumberFormatPrefix

non-null

The prefix that appears before order numbers.

Anchor to orderNumberFormatSuffixorderNumberFormatSuffix

non-null

The suffix that appears after order numbers.

Anchor to orderTagsorderTags

non-null

A list of tags that have been added to orders.

Arguments

•Int!

required

The first n elements from the paginated list.

Anchor to sortsort

•ShopTagSort

Default:ALPHABETICAL

Sort type.

Anchor to paymentSettingspaymentSettings

•PaymentSettings!

non-null

The shop's settings related to payments.

Anchor to planplan

•ShopPlan!

non-null

The shop's billing plan.

Anchor to primaryDomainprimaryDomain

•Domain!

non-null

The primary domain of the shop's online store.

Anchor to resourceLimitsresourceLimits

•ShopResourceLimits!

non-null

The shop's limits for specific resources. For example, the maximum number ofvariants allowed per product, or the maximum number of locations allowed.

Anchor to richTextEditorUrlrichTextEditorUrl

•URL!

non-null

The URL of the rich text editor that can be used for mobile devices.

Anchor to searchsearch

•SearchResultConnection!

non-null

Fetches a list of admin search results by a specified query.

Arguments

•String

The elements that come after the specified cursor.

•Int!

required

The first n elements from the paginated list.

required

The search query to filter by.

Anchor to typestypes

•[SearchResultType!]

The search result types to filter by.

•SearchFilterOptions!

non-null

The list of search filter options for the shop. These can be used to filter productvisibility for the shop.

Anchor to setupRequiredsetupRequired

non-null

Whether the shop has outstanding setup steps.

Anchor to shipsToCountriesshipsToCountries

•[CountryCode!]!

non-null

The list of countries that the shop ships to.

Anchor to shopAddressshopAddress

•ShopAddress!

non-null

The shop's address information as it will appear to buyers.

Anchor to shopOwnerNameshopOwnerName

•StorefrontAccessTokenConnection!

non-null

The name of the shop owner.

Anchor to shopPoliciesshopPolicies

•[ShopPolicy!]!

non-null

The list of all legal policies associated with a shop.

Anchor to storefrontAccessTokensstorefrontAccessTokens

non-null

The storefront access token of a private application. These are scoped per-application.

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.

Anchor to taxesIncludedtaxesIncluded

non-null

Whether applicable taxes are included in the shop's product prices.

Anchor to taxShippingtaxShipping

non-null

Whether the shop charges taxes for shipping.

Anchor to timezoneAbbreviationtimezoneAbbreviation

non-null

The shop's time zone abbreviation.

Anchor to timezoneOffsettimezoneOffset

non-null

The shop's time zone offset.

Anchor to timezoneOffsetMinutestimezoneOffsetMinutes

•Int!

non-null

The shop's time zone offset expressed as a number of minutes.

Anchor to transactionalSmsDisabledtransactionalSmsDisabled

non-null

Whether transactional SMS sent by Shopify have been disabled for a shop.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to unitSystemunitSystem

•UnitSystem!

non-null

The shop's unit system for weights and measures.

Anchor to updatedAtupdatedAt

non-null

The date and time when the shop was last updated.

•URL!

non-null

The URL of the shop's online store.

Anchor to weightUnitweightUnit

•WeightUnit!

non-null

The shop's primary unit of weight for products and shipping.

Anchor to allProductCategoriesallProductCategories

•[ProductCategory!]!

non-nullDeprecated

Anchor to analyticsTokenanalyticsToken

•FulfillmentOrderConnection!

non-nullDeprecated

Anchor to assignedFulfillmentOrdersassignedFulfillmentOrders

non-nullDeprecated

Arguments

•FulfillmentOrderAssignmentStatus

•String

The elements that come after the specified cursor.

Anchor to assignmentStatusassignmentStatus

The assigment status of the fulfillment orders that should be returned. If assignmentStatus argument is not provided, then the query will return all assigned fulfillment orders, except those that have the CLOSED status.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to locationIdslocationIds

•[ID!]

Returns fulfillment orders only for certain locations, specified by a list of location IDs.

Default:false

Reverse the order of the underlying list.

•FulfillmentOrderSortKeys

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.

Anchor to billingAddressbillingAddress

•ShopAddress!

non-nullDeprecated

Anchor to channelschannels

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

Anchor to collectionscollections

•CollectionConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
collection_type	string		- `custom` - `smart`
handle	string
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
product_id	id	Filter by collections containing a product by its ID.
product_publication_status	string	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
(`Channel.app.id`) and one of the valid values. For simple visibility checks, use published_status
instead.	- `* {channel_app_id}-approved` - `*
{channel_app_id}-rejected`<br/> -` * {channel_app_id}-needs_action` -
`* {channel_app_id}-awaiting_review` - `*
{channel_app_id}-published`<br/> -` * {channel_app_id}-demoted`<br/> -` *
{channel_app_id}-scheduled`<br/> -` *
{channel_app_id}-provisionally_published`		-
`product_publication_status:189769876-approved`
publishable_status	string	Deprecated: This parameter is deprecated
as of 2025-12 and will be removed in a future API version. Use published_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.	- `*
{channel_app_id}-unset`<br/> -` * {channel_app_id}-pending`<br/> -` *
{channel_app_id}-approved`<br/> -` * {channel_app_id}-not_approved`		-
`publishable_status:580111-unset` - `publishable_status:580111-pending`
published_at	time	Filter by the date and time when the collection was published to the Online Store.
published_status	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
a channel ID, channel handle, [channel `app`
ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price)
(`Channel.app.id`), or app handle with suffixes: -
`{id_or_handle}-published`: Returns resources published to the specified
channel. - `{id_or_handle}-visible`: Same as `{id_or_handle}-published`
(kept for backwards compatibility). - `{id_or_handle}-intended`: Returns
resources added to the channel but not yet published. -
`{id_or_handle}-hidden`: Returns resources not added to the channel or not
published. Other: - `unavailable`: Returns resources not published to any
channel.	- `online_store_channel` - `published` - `visible`

unpublished
- * {channel_id_or_handle}-published
- * {channel_id_or_handle}-visible
- * {channel_id_or_handle}-intended
- * {channel_id_or_handle}-hidden
- * {channel_app_id_or_handle}-published
- * {channel_app_id_or_handle}-visible
- * {channel_app_id_or_handle}-intended
- * {channel_app_id_or_handle}-hidden
- unavailable | | - published_status:online_store_channel
- published_status:published
- published_status:580111-published
published_status:580111-hidden
- published_status:my-channel-handle-published
- published_status:unavailable | | title | string | | updated_at | time | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

•CollectionSortKeys

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.

Anchor to customerscustomers

•CustomerConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
accepts_marketing	boolean	Filter by whether a customer has consented
to receive marketing material.			- `accepts_marketing:true`
country	string	Filter by the country associated with the customer's
address. Use either the country name or the two-letter country code.			-
`country:Canada` - `country:JP`
customer_date	time	Filter by the date and time when the customer
record was created. This query parameter filters by the `createdAt`
field.			- `customer_date:'2024-03-15T14:30:00Z'` - `customer_date:

='2024-01-01'| | email | string | The customer's email address, used to communicate information about orders and for the purposes of email marketing campaigns. You can use a wildcard value to filter the query by customers who have an email address specified. Please note that _email_ is a tokenized field: To retrieve exact matches, quote the email address (_phrase query_) as described in [Shopify API search syntax](https://shopify.dev/docs/api/usage/search-syntax). | | | -email:gmail.com - email:"bo.wang@example.com" - email:*| | first_name | string | Filter by the customer's first name. | | | -first_name:Jane| | id | id | Filter byidrange. | | | -id:1234 - id:>=1234 - id:<=1234| | last_abandoned_order_date | time | Filter by the date and time of the customer's most recent abandoned checkout. An abandoned checkout occurs when a customer adds items to their cart, begins the checkout process, but leaves the site without completing their purchase. | | | -last_abandoned_order_date:'2024-04-01T10:00:00Z' - last_abandoned_order_date: >='2024-01-01'| | last_name | string | Filter by the customer's last name. | | | -last_name:Reeves| | order_date | time | Filter by the date and time that the order was placed by the customer. Use this query filter to check if a customer has placed at least one order within a specified date range. | | | -order_date:'2024-02-20T00:00:00Z' - order_date: >='2024-01-01'`

order_date:'2024-01-01..2024-03-31' | | orders_count | integer | Filter by the total number of orders a customer has placed. | | | - orders_count:5 | | phone | string | The phone number of the customer, used to communicate information about orders and for the purposes of SMS marketing campaigns. You can use a wildcard value to filter the query by customers who have a phone number specified. | | | - phone:+18005550100
- phone:* | | state | string | Filter by the state of the customer's account with the shop. This filter is only valid when Classic Customer Accounts is active. | | | - state:ENABLED
- state:INVITED
- state:DISABLED
- state:DECLINED | | tag | string | Filter by the tags that are associated with the customer. This query parameter accepts multiple tags separated by commas. | | | - tag:'VIP' - tag:'Wholesale,Repeat' | | tag_not | string | Filter by the tags that aren't associated with the customer. This query parameter accepts multiple tags separated by commas. | | | - tag_not:'Prospect' - tag_not:'Test,Internal' | | total_spent | float | Filter by the total amount of money a customer has spent across all orders. | | | - total_spent:100.50
- total_spent:50.00
- total_spent:>100.50
- total_spent:>50.00 | | updated_at | time | The date and time, matching a whole day, when the customer's information was last updated. | | | - updated_at:2024-01-01T00:00:00Z
- updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

•FulfillmentOrderConnection!

•CustomerSortKeys

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.

Anchor to domainsdomains

•[Domain!]!

non-nullDeprecated

Anchor to fulfillmentOrdersfulfillmentOrders

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

Anchor to includeClosedincludeClosed

Default:false

Whether to include closed fulfillment orders.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
assigned_location_id	id
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
status	string
updated_at	time
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:false

Reverse the order of the underlying list.

•FulfillmentOrderSortKeys

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.

Anchor to inventoryItemsinventoryItems

•InventoryItemConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

Anchor to created_at •time
Anchor to id •id: Filter by id range.

Default:false

Reverse the order of the underlying list.

Anchor to limitedPendingOrderCountlimitedPendingOrderCount

•LimitedPendingOrderCount!

non-nullDeprecated

Anchor to locationslocations

•LocationConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

Anchor to includeInactiveincludeInactive

Default:false

Whether to include the locations that are deactivated.

Anchor to includeLegacyincludeLegacy

Default:false

Whether to include the legacy locations of fulfillment services.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
active	string
address1	string
address2	string
city	string
country	string
created_at	time
geolocated	boolean
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
legacy	boolean
location_id	id
name	string
pickup_in_store	string		- `enabled` - `disabled`
province	string
zip	string
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:false

Reverse the order of the underlying list.

•LocationSortKeys

Default:NAME

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.

Anchor to metafieldDefinitionsmetafieldDefinitions

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

Default:ANY

Filter by the definition's pinned status.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
created_at	time	Filter by the date and time when the metafield
definition was created.			- `created_at:>2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
key	string	Filter by the metafield definition `key`
field.			- `key:some-key`
namespace	string	Filter by the metafield definition `namespace`
field.			- `namespace:some-namespace`
owner_type	string	Filter by the metafield definition `ownerType`
field.			- `owner_type:PRODUCT`
type	string	Filter by the metafield definition `type`
field.			- `type:single_line_text_field`
updated_at	time	Filter by the date and time when the metafield
definition was last updated.			- `updated_at:>2020-10-21T23:39:20Z`

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

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.

Anchor to ordersorders

•OrderConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
cart_token	string	Filter by the cart token's unique value to track
abandoned cart conversions or troubleshoot checkout issues. The token
references the cart that's associated with an order.			-
`cart_token:abc123`
channel	string	Filter by the channel information `handle`
(`ChannelInformation.channelDefinition.handle`) field.			-
`channel:web` - `channel:web,pos`
channel_id	id	Filter by the channel `id`
field.			- `channel_id:123`
chargeback_status	string	Filter by the order's chargeback status. A
chargeback occurs when a customer questions the legitimacy of a charge with
their financial institution.	- `accepted` - `charge_refunded` -
`lost` - `needs_response` - `under_review` - `won`		-
`chargeback_status:accepted`
checkout_token	string	Filter by the checkout token's unique value to
analyze conversion funnels or resolve payment issues. The checkout token's
value references the checkout that's associated with an order.			-
`checkout_token:abc123`
confirmation_number	string	Filter by the randomly generated
alpha-numeric identifier for an order that can be displayed to the customer
instead of the sequential order name. This value isn't guaranteed to be
unique.			- `confirmation_number:ABC123`
created_at	time	Filter by the date and time when the order was created
in Shopify's system.			- `created_at:2020-10-21T23:39:20Z` -
`created_at:<now` - `created_at:<=2024`
credit_card_last4	string	Filter by the last four digits of the payment
card that was used to pay for the order. This filter matches only the last
four digits of the card for heightened security.			-
`credit_card_last4:1234`
current_total_price	float	Filter by the current total price of the
order in the shop currency, including any returns/refunds/removals. This
filter supports both exact values and ranges.			-
`current_total_price:10` - `current_total_price:>=5.00
current_total_price:<=20.99`
customer_id	id	Filter orders by the customer `id`
field.			- `customer_id:123`
delivery_method	string	Filter by the delivery `methodType`
field.	- `shipping` - `pick-up` - `retail` - `local` -
`pickup-point` - `none`		- `delivery_method:shipping`
discount_code	string	Filter by the case-insensitive discount code that
was applied to the order at checkout. Limited to the first discount code
used on an order. Maximum characters: 255.			- `discount_code:ABC123`
email	string	Filter by the email address that's associated with the
order to provide customer support or analyze purchasing patterns.			-
`email:example@shopify.com`
financial_status	string	Filter by the order `displayFinancialStatus`
field.	- `paid` - `pending` - `authorized` -
`partially_paid` - `partially_refunded` - `refunded` -
`voided` - `expired`		- `financial_status:authorized`
fraud_protection_level	string	Filter by the level of fraud protection
that's applied to the order. Use this filter to manage risk or handle
disputes.	- `fully_protected` - `partially_protected` -
`not_protected` - `pending` - `not_eligible` -
`not_available`		- `fraud_protection_level:fully_protected`
fulfillment_location_id	id	Filter by the fulfillment location `id`
(`Fulfillment.location.id`) field.			- `fulfillment_location_id:123`
fulfillment_status	string	Filter by the `displayFulfillmentStatus`
field to prioritize shipments or monitor order processing.	-
`unshipped` - `shipped` - `fulfilled` - `partial` -
`scheduled` - `on_hold` - `unfulfilled` - `request_declined`
	- `fulfillment_status:fulfilled`
gateway	string	Filter by the `paymentGatewayNames`
field. Use this filter to find orders that were processed through specific
payment providers like Shopify Payments, PayPal, or other custom payment
gateways.			- `gateway:shopify_payments`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
location_id	id	Filter by the location `id`
that's associated with the order to view and manage orders for specific
locations. For POS orders, locations must be defined in the Shopify admin
under Settings > Locations. If no ID is provided, then the primary
location of the shop is returned.			- `location_id:123`
metafields.{namespace}.{key}	mixed	Filters resources by metafield
value. Format: `metafields.{namespace}.{key}:{value}`. Learn more about
querying by metafield value.
		- `metafields.custom.on_sale:true` -
`metafields.product.material:"gid://shopify/Metaobject/43458085"`
name	string	Filter by the order `name`
field.			- `name:1001-A`
payment_id	string	Filter by the payment ID that's associated with the
order to reconcile financial records or troubleshoot payment issues.			-
`payment_id:abc123`
payment_provider_id	id	Filter by the ID of the payment provider that's
associated with the order to manage payment methods or troubleshoot
transactions.			- `payment_provider_id:123`
po_number	string	Filter by the order `poNumber`
field.			- `po_number:P01001`
processed_at	time	Filter by the order `processedAt`
field.			- `processed_at:2021-01-01T00:00:00Z`
reference_location_id	id	Filter by the ID of a location that's
associated with the order, such as locations from fulfillments, refunds, or
the shop's primary location.			- `reference_location_id:123`
return_status	string	Filter by the order's `returnStatus`
to monitor returns processing and track which orders have active returns.

return_requested
- in_progress
- inspection_complete
returned
- return_failed
- no_return | | - return_status:in_progress | | risk_level | string | Filter by the order risk assessment riskLevel field. | - high
- medium
- low
- none
- pending | | - risk_level:high | | sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | | | - sales_channel: some_sales_channel | | sku | string | Filter by the product variant sku field. Learn more about SKUs. | | | - sku:ABC123 | | source_identifier | string | Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order. | | | - source_identifier:1234-12-1000 | | source_name | string | Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods. | | | - source_name:web
- source_name:shopify_draft_order | | status | string | Filter by the order's status to manage workflows or analyze the order lifecycle. | - open
- closed
- cancelled
- not_closed | | - status:open | | subtotal_line_items_quantity | string | Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns. | | | - subtotal_line_items_quantity:10
- subtotal_line_items_quantity:5..20 | | tag | string | Filter objects by the tag field. | | | - tag:my_tag | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - tag_not:my_tag | | test | boolean | Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. | | | - test:true | | total_weight | string | Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz. | | | - total_weight:10.5kg
- total_weight:>=5g total_weight:<=20g
total_weight:.5 lb | | updated_at | time | Filter by the date and time when the order was last updated in Shopify's system. | | | - updated_at:2020-10-21T23:39:20Z
updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

•OrderSortKeys

Default:PROCESSED_AT

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.

Anchor to productImagesproductImages

•ImageConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

Deprecated

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

Anchor to maxHeightmaxHeight

•Int

Deprecated

Anchor to maxWidthmaxWidth

•Int

Deprecated

Default:false

Reverse the order of the underlying list.

•Int

DeprecatedDefault:1

•ProductImageSortKeys

Default:CREATED_AT

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.

Anchor to productsproducts

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
barcode	string	Filter by the product variant `barcode`
field.			- `barcode:ABC-abc-1234`
bundles	boolean	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.			- `bundles:true`
category_id	string	Filter by the product category ID
(`product.category.id`). A product category is the category of a product
from Shopify's Standard Product Taxonomy.
		- `category_id:sg-4-17-2-17`
collection_id	id	Filter by the collection `id`
field.			- `collection_id:108179161409`
combined_listing_role	string	Filter by the role of the product in a combined listing.
- `parent` - `child` - `no_role`		-
`combined_listing_role:parent`
created_at	time	Filter by the date and time when the product was
created.			- `created_at:>'2020-10-21T23:39:20Z'` -
`created_at:<now` - `created_at:<='2024'`
delivery_profile_id	id	Filter by the delivery profile `id`
field.			- `delivery_profile_id:108179161409`
error_feedback	string	Filter by products with publishing errors.
gift_card	boolean	Filter by the product `isGiftCard`
field.			- `gift_card:true`
handle	string	Filter by a comma-separated list of product handles.
		- `handle:the-minimal-snowboard`
has_only_composites	boolean	Filter by products that have only
composite variants.			- `has_only_composites:true`
has_only_default_variant	boolean	Filter by products that have only a
default variant. A default variant is the only variant if no other variants
are specified.			- `has_only_default_variant:true`
has_variant_with_components	boolean	Filter by products that have
variants with associated components.			-
`has_variant_with_components:true`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
inventory_total	integer	Filter by inventory count.		-
`inventory_total:0` - `inventory_total:>150` -
`inventory_total:>=200`
is_price_reduced	boolean	Filter by products that have a reduced price.
For more information, refer to the `CollectionRule`
object.			- `is_price_reduced:true`
metafields.{namespace}.{key}	mixed	Filters resources by metafield
value. Format: `metafields.{namespace}.{key}:{value}`. Learn more about
querying by metafield value.
		- `metafields.custom.on_sale:true` -
`metafields.product.material:"gid://shopify/Metaobject/43458085"`
out_of_stock_somewhere	boolean	Filter by products that are out of
stock in at least one location.			- `out_of_stock_somewhere:true`
price	bigdecimal	Filter by the product variant `price`
field.			- `price:100.57`
product_configuration_owner	string	Filter by the app
`id`
field.			- `product_configuration_owner:10001`
product_publication_status	string	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
(`Channel.app.id`) and one of the valid values. For simple visibility checks, use published_status
instead.	- `* {channel_app_id}-approved` - `*
{channel_app_id}-rejected`<br/> -` * {channel_app_id}-needs_action` -
`* {channel_app_id}-awaiting_review` - `*
{channel_app_id}-published`<br/> -` * {channel_app_id}-demoted`<br/> -` *
{channel_app_id}-scheduled`<br/> -` *
{channel_app_id}-provisionally_published`		-
`product_publication_status:189769876-approved`
product_type	string	Filter by a comma-separated list of [product
types](https://help.shopify.com/manual/products/details/product-type).

product_type:snowboard | | publication_ids | string | Filter by a comma-separated list of publication IDs that are associated with the product. | | | - publication_ids:184111530305,184111694145 | | publishable_status | string | Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_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 (Channel.app.id) and one of the valid status values. | - * {channel_app_id}-unset
- * {channel_app_id}-pending
- * {channel_app_id}-approved
- * {channel_app_id}-not_approved | | - publishable_status:580111-unset
- publishable_status:580111-pending | | published_at | time | Filter by the date and time when the product was published to the online store and other sales channels. | | | - published_at:>2020-10-21T23:39:20Z
- published_at:<now
- published_at:<=2024 | | published_status | 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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. | - online_store_channel
- published
- visible
unpublished
- * {channel_id_or_handle}-published
- * {channel_id_or_handle}-visible
- * {channel_id_or_handle}-intended
- * {channel_id_or_handle}-hidden
- * {channel_app_id_or_handle}-published
- * {channel_app_id_or_handle}-visible
- * {channel_app_id_or_handle}-intended
- * {channel_app_id_or_handle}-hidden
- unavailable | | - published_status:online_store_channel
- published_status:published
- published_status:580111-published
published_status:580111-hidden
- published_status:my-channel-handle-published
- published_status:unavailable | | sku | string | Filter by the product variant sku field. Learn more about SKUs. | | | - sku:XYZ-12345 | | status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. | - active
- archived
- draft | active | - status:active,draft | | tag | string | Filter objects by the tag field. | | | - tag:my_tag | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - tag_not:my_tag | | title | string | Filter by the product title field. | | | - title:The Minimal Snowboard | | tracks_inventory | boolean | Filter by products that have inventory tracking enabled. | | | - tracks_inventory:true | | updated_at | time | Filter by the date and time when the product was last updated. | | | - updated_at:>'2020-10-21T23:39:20Z'
- updated_at:<now
- updated_at:<='2024' | | variant_id | id | Filter by the product variant id field. | | | - variant_id:45779434701121 | | variant_title | string | Filter by the product variant title field. | | | - variant_title:'Special ski wax' | | vendor | string | Filter by the origin or source of the product. Learn more about vendors and managing vendor information. | | | - vendor:Snowdevil
- vendor:Snowdevil OR vendor:Icedevil | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

•ProductSortKeys

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.

Anchor to productTagsproductTags

non-nullDeprecated

Anchor to firstfirst •Int! required: The first n elements from the paginated list.

Anchor to productTypesproductTypes

non-nullDeprecated

Anchor to firstfirst •Int! required: The first n elements from the paginated list.

Anchor to productVariantsproductVariants

•ProductVariantConnection!

non-nullDeprecated

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•String

A filter made up of terms, connectives, modifiers, and comparators.

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
barcode	string	Filter by the product variant `barcode`
field.			- `barcode:ABC-abc-123`
collection	string	Filter by the ID of the collection
that the product variant belongs to.			- `collection:465903092033`
delivery_profile_id	id	Filter by the product variant delivery profile ID
(`ProductVariant.deliveryProfile.id`).			-
`delivery_profile_id:108179161409`
exclude_composite	boolean	Filter by product variants that aren't composites.		- `exclude_composite:true`
exclude_variants_with_components	boolean	Filter by whether there are components
that are associated with the product variants in a bundle.			-
`exclude_variants_with_components:true`
gift_card	boolean	Filter by the product `isGiftCard`
field.			- `gift_card:true`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
inventory_quantity	integer	Filter by an aggregate of inventory across
all locations where the product variant is stocked.			-
`inventory_quantity:10`
location_id	id	Filter by the [location
ID](https://shopify.dev/api/admin-graphql/latest/objects/Location#field-id)
for the product variant.			- `location_id:88511152449`
managed	boolean	Filter by whether there is fulfillment service
tracking associated with the product variants.			- `managed:true`
managed_by	string	Filter by the fulfillment service that tracks the
number of items in stock for the product variant.			-
`managed_by:shopify`
option1	string	Filter by a custom property that a shop owner uses to
define product variants.			- `option1:small`
option2	string	Filter by a custom property that a shop owner uses to
define product variants.			- `option2:medium`
option3	string	Filter by a custom property that a shop owner uses to
define product variants.			- `option3:large`
product_id	id	Filter by the product `id`
field.			- `product_id:8474977763649`
product_ids	string	Filter by a comma-separated list of product IDs.
		- `product_ids:8474977763649,8474977796417`
product_publication_status	string	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
(`Channel.app.id`) and one of the valid values. For simple visibility checks, use published_status
instead.	- `* {channel_app_id}-approved` - `*
{channel_app_id}-rejected`<br/> -` * {channel_app_id}-needs_action` -
`* {channel_app_id}-awaiting_review` - `*
{channel_app_id}-published`<br/> -` * {channel_app_id}-demoted`<br/> -` *
{channel_app_id}-scheduled`<br/> -` *
{channel_app_id}-provisionally_published`		-
`product_publication_status:189769876-approved`
product_status	string	Filter by a comma-separated list of product statuses.
		- `product_status:ACTIVE,DRAFT`
product_type	string	Filter by the product type that's associated with
the product variants.			- `product_type:snowboard` -
`product_type:snowboard,skis` - `product_type:snowboard OR
product_type:skis`
publishable_status	string	Deprecated: This parameter is deprecated
as of 2025-12 and will be removed in a future API version. Use published_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.	- `*
{channel_app_id}-unset`<br/> -` * {channel_app_id}-pending`<br/> -` *
{channel_app_id}-approved`<br/> -` * {channel_app_id}-not_approved`		-
`publishable_status:580111-unset` - `publishable_status:580111-pending`
published_status	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
a channel ID, channel handle, [channel `app`
ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price)
(`Channel.app.id`), or app handle with suffixes: -
`{id_or_handle}-published`: Returns resources published to the specified
channel. - `{id_or_handle}-visible`: Same as `{id_or_handle}-published`
(kept for backwards compatibility). - `{id_or_handle}-intended`: Returns
resources added to the channel but not yet published. -
`{id_or_handle}-hidden`: Returns resources not added to the channel or not
published. Other: - `unavailable`: Returns resources not published to any
channel.	- `online_store_channel` - `published` - `visible`

unpublished
- * {channel_id_or_handle}-published
- * {channel_id_or_handle}-visible
- * {channel_id_or_handle}-intended
- * {channel_id_or_handle}-hidden
- * {channel_app_id_or_handle}-published
- * {channel_app_id_or_handle}-visible
- * {channel_app_id_or_handle}-intended
- * {channel_app_id_or_handle}-hidden
- unavailable | | - published_status:online_store_channel
- published_status:published
- published_status:580111-published
published_status:580111-hidden
- published_status:my-channel-handle-published
- published_status:unavailable | | requires_components | boolean | Filter by whether the product variant can only be purchased with components. Learn more. | | | - requires_components:true | | sku | string | Filter by the product variant sku field. Learn more about SKUs. | | | - sku:XYZ-12345 | | tag | string | Filter objects by the tag field. | | | - tag:my_tag | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - tag_not:my_tag | | taxable | boolean | Filter by the product variant taxable field. | | | - taxable:false | | title | string | Filter by the product variant title field. | | | - title:ice | | updated_at | time | Filter by date and time when the product variant was updated. | | | - updated_at:>2020-10-21T23:39:20Z
- updated_at:<now
- updated_at:<=2024 | | vendor | string | Filter by the origin or source of the product variant. Learn more about vendors and managing vendor information. | | | - vendor:Snowdevil
- vendor:Snowdevil,Icedevil
- vendor:Snowdevil OR vendor:Icedevil | You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Default:false

Reverse the order of the underlying list.

•ProductVariantSortKeys

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.

Anchor to productVendorsproductVendors

Anchor to ShopPolicy ShopPolicy

non-nullDeprecated

Anchor to firstfirst •Int! required: The first n elements from the paginated list.

Anchor to publicationCountpublicationCount

•Int!

non-nullDeprecated

Anchor to staffMembersstaffMembers

•StaffMemberConnection!

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.

Anchor to storefrontUrlstorefrontUrl

•URL!

non-nullDeprecated

•OBJECT

Policy that a merchant has configured for their store, such as their refund or privacy policy.

Anchor to bodybody

•HTML!

non-null

The text of the policy. The maximum size is 512kb.

Anchor to createdAtcreatedAt

non-null

The date and time (ISO 8601 format) when the policy was created.

•ID!

non-null

A globally-unique ID.

non-null

The translated title of the policy. For example, Refund Policy or Politique de remboursement.

Anchor to translationstranslations

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to typetype

•ShopPolicyType!

non-null

The shop policy type.

Anchor to updatedAtupdatedAt

non-null

The date and time (ISO 8601 format) when the policy was last modified.