1/18/2026, 12:01:05 AM
The deliverySettings query and the DeliverySetting type and input have been removed, so the shop‑wide shipping configuration can no longer be retrieved or updated through the GraphQL API. The deliverySettingUpdate mutation now has no arguments, reflecting the removal of the DeliverySettingInput and simplifying the payload. BulkOperations now defaults to sorting by created_at with newest first, and this behavior is described in its updated description. ProductsCount queries (and Channel.productsCount) now accept an optional limit argument (default 10000) to bound the count returned. Metafield lookups on many objects, including AppInstallation, Article, Blog, Channel, Collection, Customer, and others, no longer default to the app‑reserved namespace; if namespace is omitted all namespaces are returned, which removes implicit filtering. Finally, deliveryShippingOriginAssign has been deprecated and will be removed in a future version as single‑origin shipping mode is retired.
Returns the shop-wide shipping settings.
Returns the app's bulk operations meeting the specified filters. Defaults to sorting by created_at, with newest operations first.
Retrieves a list of products
in a store. Products are the items that merchants can sell in their store.
Use the products query when you need to:
The products query supports pagination
to handle large product catalogs and saved searches
for frequently used product queries.
The products query returns products with their associated metadata, including:
Learn more about working with Shopify's product model.
Count of products. Limited to a maximum of 10000 by default.
Set the delivery settings for a shop.
Assigns a location as the shipping origin while using legacy compatibility mode for multi-location delivery profiles.
Deprecated as of 2026-04 and will be removed in a future version as single origin shipping mode has been retired.
Whether the shop is blocked from converting to full multi-location delivery profiles mode. If the shop is blocked, then the blocking reasons are also returned.
Reasons the shop is blocked from converting to full multi-location delivery profiles mode.
The DeliverySetting object enables you to manage shop-wide shipping settings.
You can enable legacy compatibility mode for the multi-location delivery profiles feature
if the legacy mode isn't blocked.
The input fields for shop-level delivery settings.
metafieldsmetafields on AppInstallationA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on ArticleA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on BlogA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on CartTransformA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
productsCountproductsCount on ChannelRetrieves the total count of products published to a specific sales channel. Limited to a maximum of 10000 by default.
Countquery: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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 |
||
| 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. |
limit: Int - The upper bound on count value before returning a result. Use null to have no limit.
Retrieves the total count of products published to a specific sales channel. Limited to a maximum of 10000 by default.
Countquery: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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. |
limit: Int - The upper bound on count value before returning a result. Use null to have no limit.
metafieldsmetafields on CollectionA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on CompanyA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on CompanyLocationA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on CustomerA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on CustomerSegmentMemberA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on DeliveryCustomizationA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on DeliveryMethodA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
legacyModesettingmetafieldsmetafields on DiscountAutomaticNodeA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on DiscountCodeNodeA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on DiscountNodeA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on DraftOrderA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on FulfillmentConstraintRuleA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on GiftCardCreditTransactionA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on GiftCardDebitTransactionA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on GiftCardTransactionA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on HasMetafieldsA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on ImageA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on InventoryTransferA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
suggestedReturnReasonDefinitionssuggestedReturnReasonDefinitions on LineItemReturn reasons suggested based on the line item's product category in Shopify's product taxonomy. Use returnReasonDefinitions to access the full library of available reasons.
ReturnReasonDefinitionConnectionfirst: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
Return reasons suggested based on the line item's product category in Shopify's product taxonomy. Use returnReasonDefinitions to access the full library of available reasons.
ReturnReasonDefinitionConnectionfirst: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on LocationA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
shipsInventoryshipsInventory on LocationWhether this location is used for calculating shipping rates. In multi-origin shipping mode, this flag is ignored.
Boolean!Legacy field indicating this location was designated for shipping. All locations with valid addresses can now ship.
Boolean!metafieldsmetafields on MarketA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on MediaImageA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
OWNER_TYPE_LIMIT_EXCEEDED_FOR_USE_AS_ADMIN_FILTERSOWNER_TYPE_LIMIT_EXCEEDED_FOR_USE_AS_ADMIN_FILTERSmetafieldsmetafields on OrderA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
AMOUNT_TOO_LARGEAMOUNT_TOO_SMALLAUTHENTICATION_FAILEDAUTHENTICATION_REQUIREDCANCELLED_PAYMENTCARD_TESTINGDO_NOT_HONORFRAUD_SUSPECTEDINCORRECT_NAMEINSUFFICIENT_FUNDSINVALID_CURRENCYINVALID_PAYMENT_METHODINVALID_PURCHASE_TYPEMERCHANT_ACCOUNT_ERRORMERCHANT_RULEINSTRUMENT_DECLINEDPAYMENT_METHOD_UNSUPPORTEDRETRY_DECLINEDTRANSACTION_LIMIT_EXCEEDEDAUTHORIZATION_EXPIREDmetafieldsmetafields on PageA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on PaymentCustomizationA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on ProductA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
productParentsproductParents on ProductA list of products that has a variant that contains any of this product's variants as a component.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
query: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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 |
||
| 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. |
A list of products that has a variant that contains any of this product's variants as a component.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
query: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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. |
metafieldsmetafields on ProductVariantA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
productParentsproductParents on ProductVariantA list of products that have product variants that contain this variant as a product component.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
query: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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 |
||
| 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. |
A list of products that have product variants that contain this variant as a product component.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
query: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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. |
includedProductsincludedProducts on PublicationThe list of products included, but not necessarily published, in the publication.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: ProductSortKeys - 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.
query: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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 |
||
| 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. |
savedSearchId: ID - The ID of a saved search.
The search’s query string is used as the query argument.
The list of products included, but not necessarily published, in the publication.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: ProductSortKeys - 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.
query: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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. |
savedSearchId: ID - The ID of a saved search.
The search’s query string is used as the query argument.
includedProductsCountincludedProductsCount on PublicationThe count of products included in the publication. Limited to a maximum of 10000 by default.
Countquery: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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 |
||
| 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. |
savedSearchId: ID - The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to the SavedSearch object.
limit: Int - The upper bound on count value before returning a result. Use null to have no limit.
The count of products included in the publication. Limited to a maximum of 10000 by default.
Countquery: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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. |
savedSearchId: ID - The ID of an existing saved search.
The search’s query string is used as the query argument.
Refer to the SavedSearch object.
limit: Int - The upper bound on count value before returning a result. Use null to have no limit.
productsproducts on PublicationThe list of products published to the publication.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: ProductSortKeys - 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.
query: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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 |
||
| 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. |
savedSearchId: ID - The ID of a saved search.
The search’s query string is used as the query argument.
The list of products published to the publication.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: ProductSortKeys - 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.
query: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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. |
savedSearchId: ID - The ID of a saved search.
The search’s query string is used as the query argument.
metafieldsmetafields on SellingPlanA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
metafieldsmetafields on ShopA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
productsproducts on ShopList of the shop's products.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: ProductSortKeys - 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.
query: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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 |
||
| 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. |
savedSearchId: ID - The ID of a saved search.
The search’s query string is used as the query argument.
List of the shop's products.
ProductConnection!first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
sortKey: ProductSortKeys - 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.
query: 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. 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. | - 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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_app_id}-published- * {channel_app_id}-visible- * {channel_app_id}-intended- * {channel_app_id}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- 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. |
savedSearchId: ID - The ID of a saved search.
The search’s query string is used as the query argument.
publicDisplayNamepublicDisplayName on ShopPlanThe public display name of the shop's billing plan. Possible values are: Advanced, Basic, Development, Grow, Inactive, Lite, Other, Paused, Plus, Plus Trial, Retail, Shop Component, Shopify Finance, Staff Business, Starter, and Trial.
String!The public display name of the shop's billing plan. Possible values are: Advanced, Agentic, Basic, Development, Grow, Inactive, Lite, Other, Paused, Plus, Plus Trial, Retail, Shop Component, Shopify Finance, Staff Business, Starter, and Trial.
String!createdAtcreatedAt on ShopPolicyThe date and time (ISO 8601 format) when the policy was created.
Date!The date and time (ISO 8601 format) when the policy was created.
DateTime!updatedAtupdatedAt on ShopPolicyThe date and time (ISO 8601 format) when the policy was last modified.
Date!The date and time (ISO 8601 format) when the policy was last modified.
DateTime!evidenceDueByevidenceDueBy on ShopifyPaymentsDisputeThe deadline for evidence submission.
DateThe deadline for evidence submission.
DateTimeevidenceSentOnevidenceSentOn on ShopifyPaymentsDisputeThe date when evidence was sent. Returns null if evidence hasn't yet been sent.
DateThe date when evidence was sent. Returns null if evidence hasn't yet been sent.
DateTimefinalizedOnfinalizedOn on ShopifyPaymentsDisputeThe date when this dispute was resolved. Returns null if the dispute isn't yet resolved.
DateThe date when this dispute was resolved. Returns null if the dispute isn't yet resolved.
DateTimeINSTALLMENTS_BALANCE_RECOVERY_CREDITINSTALLMENTS_BALANCE_RECOVERY_CREDIT_REVERSALMANAGED_MARKETS_NON_TARGET_REVENUE_ADJUSTMENT_PLATFORM_DEBITMANAGED_MARKETS_NON_TARGET_REVENUE_ADJUSTMENT_PLATFORM_DEBIT_REVERSALOWNER_TYPE_LIMIT_EXCEEDED_FOR_USE_AS_ADMIN_FILTERSmetafieldsmetafields on ValidationA list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
A list of custom fields
that a merchant associates with a Shopify resource.
MetafieldConnection!namespace: String - The metafield namespace to filter by. If omitted, all metafields are returned.
keys: [String!] - List of keys of metafields in the format namespace.key, will be returned in the same format.
first: Int - The first n elements from the paginated list.
after: String - The elements that come after the specified cursor.
last: Int - The last n elements from the paginated list.
before: String - The elements that come before the specified cursor.
reverse: Boolean - Reverse the order of the underlying list.
includeFieldsincludeFields on WebhookSubscriptionThe list of fields to be included in the webhook subscription. Only the fields specified will be included in the webhook payload. If null, then all fields will be included. Learn more about modifying webhook payloads.
[String!]!The list of fields to be included in the webhook subscription. Only the fields specified will be included in the webhook payload. If null, then all fields will be included. Learn more about modifying webhook payloads.
[String!]!{
"added": [],
"removed": [],
"modified": [
{
"name": "idempotent",
"old": {
"name": "idempotent",
"description": "Enables idempotent mutation execution using a provided key. Only supported on mutations that explicitly document idempotency support in their description. Example: `@idempotent(key: \"123e4567-e89b-12d3-a456-426614174000\")`.",
"locations": [
"FIELD"
],
"args": [
{
"name": "key",
"description": "The key to identify the idempotent mutation.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
]
},
"new": {
"name": "idempotent",
"description": "Enables idempotent mutation execution using a provided key. Only supported on mutations that explicitly document idempotency support in their description. Example: `@idempotent(key: \"123e4567-e89b-12d3-a456-426614174000\")`. Note: The idempotency key cannot be an empty string or whitespace only.",
"locations": [
"FIELD"
],
"args": [
{
"name": "key",
"description": "The key to identify the idempotent mutation.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null
}
]
}
}
]
}