7/10/2026, 12:01:04 AM
Shopify’s unstable GraphQL schema adds a new "analyticsIssues" query that lists analytics issues ordered by newest creation date and can be filtered by status. The legacy "customerSavedSearches" field is now deprecated; developers should use the upcoming "segments" field instead. The "customers" field’s search syntax description was updated, but no functionality changes were introduced. Several query arguments have been refined: "giftCards", "giftCardsCount", and "ordersCount" now use a "created_at:>='
List of analytics issues ordered by creation date (newest first).
List of the shop's customer saved searches.
Returns a list of customers in your Shopify store, including key information such as name, email, location, and purchase history.
Use this query to segment your audience, personalize marketing campaigns, or analyze customer behavior by applying filters based on location, order history, marketing preferences and tags.
The customers query supports pagination and sorting.
Returns a paginated list of GiftCard objects issued for the shop.
You can filter gift cards by attributes such as status, last characters of the code, balance status, and other values using the query parameter. You can also apply SavedSearch objects to filter results.
Returns the total count of gift cards that have been issued by the shop. Use this for dashboard summaries or to understand the scale of a merchant's gift card program. The count includes all gift cards regardless of status (active, disabled, or fully redeemed). Limited to a maximum of 10000 by default.
Returns a list of metafield definitions.
Returns a list of orders placed in the store, including data such as order status, customer, and line item details.
Use the orders query to build reports, analyze sales performance, or automate fulfillment workflows. The orders query supports pagination,
sorting, and filtering.
Returns the number of orders in the shop. You can filter orders using search syntax or a SavedSearch, and set a maximum count limit to control query performance.
Use the query argument to filter the count by criteria like order status, financial state, or fulfillment status. The response includes both the count value and its precision, indicating whether the count is exact or an estimate.
Note:
The count is limited to 10,000 orders by default. Use thelimitargument to adjust this value, or passnullfor no limit. Limited to a maximum of 10000 by default.
Retrieves a list of product variants
associated with a product.
A product variant is a specific version of a product that comes in more than
one option,
such as size or color. For example, if a merchant sells t-shirts with options for size and color,
then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another.
Use the productVariants query when you need to:
The productVariants query supports pagination
to handle large product catalogs and saved searches
for frequently used product variant queries.
The productVariants query returns product variants with their associated metadata, including:
Learn more about working with Shopify's product model.
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.
A list of a shop's segment migrations.
Returns a SubscriptionContractConnection containing subscription contracts. Subscription contracts are agreements between customers and merchants for recurring purchases with defined billing and delivery schedules.
Filter results with the query argument. You can paginate results using standard cursor-based pagination.
An analytics issue record.
The severity level of an analytics issue.
The status of an analytics issue.
The surface where the issue is displayed.
metafieldDefinitionsmetafieldDefinitions on ArticleList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on BlogList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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.
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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.
metafieldDefinitionsmetafieldDefinitions on CollectionList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on CompanyList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
ordersorders on CompanyThe list of the company's orders.
OrderConnection!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: OrderSortKeys - 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 |
||
| cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | - cart_token:abc123 |
||
| channel | string | Filter by the channel information handle (ChannelInformation.channelDefinition.handle) field. |
- channel:web- channel:web,pos |
||
| channel_id | id | Filter by the channel id field. |
- channel_id:123 |
||
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - accepted- charge_refunded- lost- needs_response- under_review- won |
- chargeback_status:accepted |
|
| checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | - checkout_token:abc123 |
||
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | - confirmation_number:ABC123 |
||
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | - created_at:2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | - credit_card_last4:1234 |
||
| current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | - current_total_price:10- current_total_price:>=5.00 current_total_price:<=20.99 |
||
| customer_id | id | Filter orders by the customer id field. |
- customer_id:123 |
||
| delivery_method | string | Filter by the delivery methodType field. |
- shipping- pick-up- retail- local- pickup-point- none |
- delivery_method:shipping |
|
| discount_code | string | Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255. | - discount_code:ABC123 |
||
| string | Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns. | - email:example@shopify.com |
|||
| financial_status | string | Filter by the order displayFinancialStatus field. |
- paid- pending- authorized- partially_paid- partially_refunded- refunded- voided- expired |
- financial_status:authorized |
|
| fraud_protection_level | string | Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes. | - fully_protected- partially_protected- not_protected- pending- not_eligible- not_available |
- fraud_protection_level:fully_protected |
|
| fulfillment_location_id | id | Filter by the fulfillment location id (Fulfillment.location.id) field. |
- fulfillment_location_id:123 |
||
| fulfillment_status | string | Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing. |
- unshipped- shipped- fulfilled- partial- scheduled- on_hold- unfulfilled- request_declined |
- fulfillment_status:fulfilled |
|
| gateway | string | Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways. |
- gateway:shopify_payments |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| location_id | id | Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned. |
- location_id:123 |
||
| metafields.{namespace}.{key} | mixed | Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value. |
- metafields.custom.on_sale:true- metafields.product.material:"gid://shopify/Metaobject/43458085" |
||
| name | string | Filter by the order name field. |
- name:1001-A |
||
| payment_id | string | Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues. | - payment_id:abc123 |
||
| payment_provider_id | id | Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions. | - payment_provider_id:123 |
||
| po_number | string | Filter by the order poNumber field. |
- po_number:P01001 |
||
| processed_at | time | Filter by the order processedAt field. |
- processed_at:2021-01-01T00:00:00Z |
||
| reference_location_id | id | Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location. | - reference_location_id:123 |
||
| return_status | string | Filter by the order's returnStatus to monitor returns processing and track which orders have active returns. |
- return_requested- in_progress- inspection_complete- returned- return_failed- no_return |
- return_status:in_progress |
|
| risk_level | string | Filter by the order risk assessment riskLevel field. |
- high- medium- low- none- pending |
- risk_level:high |
|
| sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | - sales_channel: some_sales_channel |
||
| shipping_address_validation_result_summary | string | Filter by the validation status of the shipping address. Learn more about validating addresses. | - has_issues- no_issues- not_validated |
- shipping_address_validation_result_summary:no_issues |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:ABC123 |
||
| source_identifier | string | Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order. | - source_identifier:1234-12-1000 |
||
| source_name | string | Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods. | - source_name:web- source_name:shopify_draft_order |
||
| status | string | Filter by the order's status to manage workflows or analyze the order lifecycle. | - open- closed- cancelled- not_closed |
- status:open |
|
| subtotal_line_items_quantity | string | Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns. | - subtotal_line_items_quantity:10- subtotal_line_items_quantity:5..20 |
||
| tag | string | Filter objects by the tag field. |
- tag:my_tag |
||
| tag_not | string | Filter by objects that don’t have the specified tag. | - tag_not:my_tag |
||
| test | boolean | Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. | - test:true |
||
| total_weight | string | Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz. | - total_weight:10.5kg- total_weight:>=5g total_weight:<=20g- total_weight:.5 lb |
||
| updated_at | time | Filter by the date and time when the order was last updated in Shopify's system. | - updated_at:2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
The list of the company's orders.
OrderConnection!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: OrderSortKeys - 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 |
||
| cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | - cart_token:abc123 |
||
| channel | string | Filter by the order attribution handle (Order.attribution.handle) field. The legacy channel information handle (ChannelInformation.channelDefinition.handle) field is deprecated but remains supported during the deprecation period. |
- channel:web- channel:web,pos |
||
| channel_id | id | Filter by the channel id field. |
- channel_id:123 |
||
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - accepted- charge_refunded- lost- needs_response- under_review- won |
- chargeback_status:accepted |
|
| checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | - checkout_token:abc123 |
||
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | - confirmation_number:ABC123 |
||
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | - created_at:'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | - credit_card_last4:1234 |
||
| current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | - current_total_price:10- current_total_price:>=5.00 current_total_price:<=20.99 |
||
| customer_id | id | Filter orders by the customer id field. |
- customer_id:123 |
||
| delivery_method | string | Filter by the delivery methodType field. |
- shipping- pick-up- retail- local- pickup-point- none |
- delivery_method:shipping |
|
| discount_code | string | Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255. | - discount_code:ABC123 |
||
| string | Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns. | - email:example@shopify.com |
|||
| financial_status | string | Filter by the order displayFinancialStatus field. |
- paid- pending- authorized- partially_paid- partially_refunded- refunded- voided- expired |
- financial_status:authorized |
|
| fraud_protection_level | string | Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes. | - fully_protected- partially_protected- not_protected- pending- not_eligible- not_available |
- fraud_protection_level:fully_protected |
|
| fulfillment_location_id | id | Filter by the fulfillment location id (Fulfillment.location.id) field. |
- fulfillment_location_id:123 |
||
| fulfillment_status | string | Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing. |
- unshipped- shipped- fulfilled- partial- scheduled- on_hold- unfulfilled- request_declined |
- fulfillment_status:fulfilled |
|
| gateway | string | Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways. |
- gateway:shopify_payments |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| location_id | id | Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned. |
- location_id:123 |
||
| metafields.{namespace}.{key} | mixed | Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value. |
- metafields.custom.on_sale:true- metafields.product.material:"gid://shopify/Metaobject/43458085" |
||
| name | string | Filter by the order name field. |
- name:1001-A |
||
| payment_id | string | Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues. | - payment_id:abc123 |
||
| payment_provider_id | id | Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions. | - payment_provider_id:123 |
||
| po_number | string | Filter by the order poNumber field. |
- po_number:P01001 |
||
| processed_at | time | Filter by the order processedAt field. |
- processed_at:'2021-01-01T00:00:00Z' |
||
| reference_location_id | id | Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location. | - reference_location_id:123 |
||
| return_status | string | Filter by the order's returnStatus to monitor returns processing and track which orders have active returns. |
- return_requested- in_progress- inspection_complete- returned- return_failed- no_return |
- return_status:in_progress |
|
| risk_level | string | Filter by the order risk assessment riskLevel field. |
- high- medium- low- none- pending |
- risk_level:high |
|
| sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | - sales_channel: some_sales_channel |
||
| shipping_address_validation_result_summary | string | Filter by the validation status of the shipping address. Learn more about validating addresses. | - has_issues- no_issues- not_validated |
- shipping_address_validation_result_summary:no_issues |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:ABC123 |
||
| source_identifier | string | Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order. | - source_identifier:1234-12-1000 |
||
| source_name | string | Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods. | - source_name:web- source_name:shopify_draft_order |
||
| status | string | Filter by the order's status to manage workflows or analyze the order lifecycle. | - open- closed- cancelled- not_closed |
- status:open |
|
| subtotal_line_items_quantity | string | Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns. | - subtotal_line_items_quantity:10- subtotal_line_items_quantity:5..20 |
||
| tag | string | Filter objects by the tag field. |
- tag:my_tag |
||
| tag_not | string | Filter by objects that don’t have the specified tag. | - tag_not:my_tag |
||
| test | boolean | Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. | - test:true |
||
| total_weight | string | Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz. | - total_weight:10.5kg- total_weight:>=5g total_weight:<=20g- total_weight:.5 lb |
||
| updated_at | time | Filter by the date and time when the order was last updated in Shopify's system. | - updated_at:'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on CompanyLocationList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on CustomerList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
ordersorders on CustomerA list of the customer's orders.
OrderConnection!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: OrderSortKeys - 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 |
||
| cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | - cart_token:abc123 |
||
| channel | string | Filter by the channel information handle (ChannelInformation.channelDefinition.handle) field. |
- channel:web- channel:web,pos |
||
| channel_id | id | Filter by the channel id field. |
- channel_id:123 |
||
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - accepted- charge_refunded- lost- needs_response- under_review- won |
- chargeback_status:accepted |
|
| checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | - checkout_token:abc123 |
||
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | - confirmation_number:ABC123 |
||
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | - created_at:2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | - credit_card_last4:1234 |
||
| current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | - current_total_price:10- current_total_price:>=5.00 current_total_price:<=20.99 |
||
| customer_id | id | Filter orders by the customer id field. |
- customer_id:123 |
||
| delivery_method | string | Filter by the delivery methodType field. |
- shipping- pick-up- retail- local- pickup-point- none |
- delivery_method:shipping |
|
| discount_code | string | Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255. | - discount_code:ABC123 |
||
| string | Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns. | - email:example@shopify.com |
|||
| financial_status | string | Filter by the order displayFinancialStatus field. |
- paid- pending- authorized- partially_paid- partially_refunded- refunded- voided- expired |
- financial_status:authorized |
|
| fraud_protection_level | string | Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes. | - fully_protected- partially_protected- not_protected- pending- not_eligible- not_available |
- fraud_protection_level:fully_protected |
|
| fulfillment_location_id | id | Filter by the fulfillment location id (Fulfillment.location.id) field. |
- fulfillment_location_id:123 |
||
| fulfillment_status | string | Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing. |
- unshipped- shipped- fulfilled- partial- scheduled- on_hold- unfulfilled- request_declined |
- fulfillment_status:fulfilled |
|
| gateway | string | Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways. |
- gateway:shopify_payments |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| location_id | id | Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned. |
- location_id:123 |
||
| metafields.{namespace}.{key} | mixed | Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value. |
- metafields.custom.on_sale:true- metafields.product.material:"gid://shopify/Metaobject/43458085" |
||
| name | string | Filter by the order name field. |
- name:1001-A |
||
| payment_id | string | Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues. | - payment_id:abc123 |
||
| payment_provider_id | id | Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions. | - payment_provider_id:123 |
||
| po_number | string | Filter by the order poNumber field. |
- po_number:P01001 |
||
| processed_at | time | Filter by the order processedAt field. |
- processed_at:2021-01-01T00:00:00Z |
||
| reference_location_id | id | Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location. | - reference_location_id:123 |
||
| return_status | string | Filter by the order's returnStatus to monitor returns processing and track which orders have active returns. |
- return_requested- in_progress- inspection_complete- returned- return_failed- no_return |
- return_status:in_progress |
|
| risk_level | string | Filter by the order risk assessment riskLevel field. |
- high- medium- low- none- pending |
- risk_level:high |
|
| sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | - sales_channel: some_sales_channel |
||
| shipping_address_validation_result_summary | string | Filter by the validation status of the shipping address. Learn more about validating addresses. | - has_issues- no_issues- not_validated |
- shipping_address_validation_result_summary:no_issues |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:ABC123 |
||
| source_identifier | string | Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order. | - source_identifier:1234-12-1000 |
||
| source_name | string | Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods. | - source_name:web- source_name:shopify_draft_order |
||
| status | string | Filter by the order's status to manage workflows or analyze the order lifecycle. | - open- closed- cancelled- not_closed |
- status:open |
|
| subtotal_line_items_quantity | string | Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns. | - subtotal_line_items_quantity:10- subtotal_line_items_quantity:5..20 |
||
| tag | string | Filter objects by the tag field. |
- tag:my_tag |
||
| tag_not | string | Filter by objects that don’t have the specified tag. | - tag_not:my_tag |
||
| test | boolean | Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. | - test:true |
||
| total_weight | string | Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz. | - total_weight:10.5kg- total_weight:>=5g total_weight:<=20g- total_weight:.5 lb |
||
| updated_at | time | Filter by the date and time when the order was last updated in Shopify's system. | - updated_at:2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
A list of the customer's orders.
OrderConnection!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: OrderSortKeys - 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 |
||
| cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | - cart_token:abc123 |
||
| channel | string | Filter by the order attribution handle (Order.attribution.handle) field. The legacy channel information handle (ChannelInformation.channelDefinition.handle) field is deprecated but remains supported during the deprecation period. |
- channel:web- channel:web,pos |
||
| channel_id | id | Filter by the channel id field. |
- channel_id:123 |
||
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - accepted- charge_refunded- lost- needs_response- under_review- won |
- chargeback_status:accepted |
|
| checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | - checkout_token:abc123 |
||
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | - confirmation_number:ABC123 |
||
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | - created_at:'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | - credit_card_last4:1234 |
||
| current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | - current_total_price:10- current_total_price:>=5.00 current_total_price:<=20.99 |
||
| customer_id | id | Filter orders by the customer id field. |
- customer_id:123 |
||
| delivery_method | string | Filter by the delivery methodType field. |
- shipping- pick-up- retail- local- pickup-point- none |
- delivery_method:shipping |
|
| discount_code | string | Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255. | - discount_code:ABC123 |
||
| string | Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns. | - email:example@shopify.com |
|||
| financial_status | string | Filter by the order displayFinancialStatus field. |
- paid- pending- authorized- partially_paid- partially_refunded- refunded- voided- expired |
- financial_status:authorized |
|
| fraud_protection_level | string | Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes. | - fully_protected- partially_protected- not_protected- pending- not_eligible- not_available |
- fraud_protection_level:fully_protected |
|
| fulfillment_location_id | id | Filter by the fulfillment location id (Fulfillment.location.id) field. |
- fulfillment_location_id:123 |
||
| fulfillment_status | string | Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing. |
- unshipped- shipped- fulfilled- partial- scheduled- on_hold- unfulfilled- request_declined |
- fulfillment_status:fulfilled |
|
| gateway | string | Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways. |
- gateway:shopify_payments |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| location_id | id | Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned. |
- location_id:123 |
||
| metafields.{namespace}.{key} | mixed | Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value. |
- metafields.custom.on_sale:true- metafields.product.material:"gid://shopify/Metaobject/43458085" |
||
| name | string | Filter by the order name field. |
- name:1001-A |
||
| payment_id | string | Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues. | - payment_id:abc123 |
||
| payment_provider_id | id | Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions. | - payment_provider_id:123 |
||
| po_number | string | Filter by the order poNumber field. |
- po_number:P01001 |
||
| processed_at | time | Filter by the order processedAt field. |
- processed_at:'2021-01-01T00:00:00Z' |
||
| reference_location_id | id | Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location. | - reference_location_id:123 |
||
| return_status | string | Filter by the order's returnStatus to monitor returns processing and track which orders have active returns. |
- return_requested- in_progress- inspection_complete- returned- return_failed- no_return |
- return_status:in_progress |
|
| risk_level | string | Filter by the order risk assessment riskLevel field. |
- high- medium- low- none- pending |
- risk_level:high |
|
| sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | - sales_channel: some_sales_channel |
||
| shipping_address_validation_result_summary | string | Filter by the validation status of the shipping address. Learn more about validating addresses. | - has_issues- no_issues- not_validated |
- shipping_address_validation_result_summary:no_issues |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:ABC123 |
||
| source_identifier | string | Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order. | - source_identifier:1234-12-1000 |
||
| source_name | string | Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods. | - source_name:web- source_name:shopify_draft_order |
||
| status | string | Filter by the order's status to manage workflows or analyze the order lifecycle. | - open- closed- cancelled- not_closed |
- status:open |
|
| subtotal_line_items_quantity | string | Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns. | - subtotal_line_items_quantity:10- subtotal_line_items_quantity:5..20 |
||
| tag | string | Filter objects by the tag field. |
- tag:my_tag |
||
| tag_not | string | Filter by objects that don’t have the specified tag. | - tag_not:my_tag |
||
| test | boolean | Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. | - test:true |
||
| total_weight | string | Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz. | - total_weight:10.5kg- total_weight:>=5g total_weight:<=20g- total_weight:.5 lb |
||
| updated_at | time | Filter by the date and time when the order was last updated in Shopify's system. | - updated_at:'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on DeliveryCustomizationList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on DiscountAutomaticNodeList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on DiscountCodeNodeList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
productDiscountsWithTagsOnSameCartLineproductDiscountsWithTagsOnSameCartLine on DiscountCombinesWithControls which product discounts can apply together on the same cart line. By
default, only one product discount applies per line. Available only on a Shopify
Plus plan and requires the productDiscounts field to be set to true.
For discounts to apply together, they must match tags in both directions. Each
discount has two tag sets: the tags that identify the discount, and the tags that
it agrees to apply with. Use the tags field on the discount input to set the
discount's own tags. This field returns the tags that this discount agrees to
apply with. Two discounts apply together only if each one allows at least one tag
that the other is tagged with. Any number of product discounts can apply to the
same line if this two-way match holds for every pair in the group.
Example: Discount A is tagged with LOYALTY and allows SEASONAL, and Discount B
is tagged with SEASONAL and allows LOYALTY. They apply together. To add a
third discount, it must meet the same mutual-match rule with both A and B.
[String!]Controls which product discounts can apply together on the same cart line. By
default, only one product discount applies per line. Available only on a Shopify
Plus plan and requires the productDiscounts field to be set to true.
For discounts to apply together, they must match tags in both directions. Each
discount has two tag sets: the tags that identify the discount, and the tags that
it agrees to apply with. Use the tags field on the discount input to set the
discount's own tags. This field returns the tags that this discount agrees to
apply with. Two discounts apply together only if each one allows at least one tag
that the other is tagged with. Any number of product discounts can apply to the
same line if this two-way match holds for every pair in the group.
Example: Discount A is tagged with LOYALTY and allows SEASONAL, and Discount B
is tagged with SEASONAL and allows LOYALTY. They apply together. To add a
third discount, it must meet the same mutual-match rule with both A and B.
Buy X Get Y discounts stack only on the customer-gets products (GY), not the
customer-buys products (BX). See
Limitations for discount combinations
for details.
[String!]metafieldDefinitionsmetafieldDefinitions on DiscountNodeList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on HasMetafieldDefinitionsList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on InventoryTransferList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on LocationList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on MarketList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
SHIPPING_NOT_COMPATIBLE_WITH_CONDITION_TYPESMANAGED_MARKETS_RESOURCE_NOT_ALLOWEDGLOBAL_E_PRICING_STRATEGY_NOT_PERMITTEDmetafieldDefinitionsmetafieldDefinitions on OrderList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
FULFILLMENT_NOT_REQUIREDmetafieldDefinitionsmetafieldDefinitions on PageList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on PaymentCustomizationList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on ProductList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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. |
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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. |
variantsInCollectionA list of variants
associated with the product that are members of the specified
collection.
Returns null for products whose collection membership is product-scoped rather than variant-scoped.
variantsInCollectionCountThe number of variants
associated with the product that are members of the specified
collection.
metafieldDefinitionsmetafieldDefinitions on ProductVariantList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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. |
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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.
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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.
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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.
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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.
INCOMPATIBLE_WITH_STANDARD_POLICYmetafieldDefinitionsmetafieldDefinitions on SellingPlanList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
CARRIER_NOT_SUPPORTEDcustomerscustomers on ShopCustomer accounts associated to the shop.
CustomerConnection!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: CustomerSortKeys - 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 |
||
| accepts_marketing | boolean | Filter by whether a customer has consented to receive marketing material. | - accepts_marketing:true |
||
| country | string | Filter by the country associated with the customer's address. Use either the country name or the two-letter country code. | - country:Canada- country:JP |
||
| customer_date | time | Filter by the date and time when the customer record was created. This query parameter filters by the createdAt field. |
- customer_date:'2024-03-15T14:30:00Z'- customer_date: >='2024-01-01' |
||
| string | The customer's email address, used to communicate information about orders and for the purposes of email marketing campaigns. You can use a wildcard value to filter the query by customers who have an email address specified. Please note that email is a tokenized field: To retrieve exact matches, quote the email address (phrase query) as described in Shopify API search syntax. | - email:gmail.com- email:"bo.wang@example.com"- email:* |
|||
| first_name | string | Filter by the customer's first name. | - first_name:Jane |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| last_abandoned_order_date | time | Filter by the date and time of the customer's most recent abandoned checkout. An abandoned checkout occurs when a customer adds items to their cart, begins the checkout process, but leaves the site without completing their purchase. | - last_abandoned_order_date:'2024-04-01T10:00:00Z'- last_abandoned_order_date: >='2024-01-01' |
||
| last_name | string | Filter by the customer's last name. | - last_name:Reeves |
||
| order_date | time | Filter by the date and time that the order was placed by the customer. Use this query filter to check if a customer has placed at least one order within a specified date range. | - order_date:'2024-02-20T00:00:00Z'- order_date: >='2024-01-01'- order_date:'2024-01-01..2024-03-31' |
||
| orders_count | integer | Filter by the total number of orders a customer has placed. | - orders_count:5 |
||
| phone | string | The phone number of the customer, used to communicate information about orders and for the purposes of SMS marketing campaigns. You can use a wildcard value to filter the query by customers who have a phone number specified. | - phone:+18005550100- phone:* |
||
| state | string | Filter by the state of the customer's account with the shop. This filter is only valid when Classic Customer Accounts is active. | - state:ENABLED- state:INVITED- state:DISABLED- state:DECLINED |
||
| tag | string | Filter by the tags that are associated with the customer. This query parameter accepts multiple tags separated by commas. | - tag:'VIP'- tag:'Wholesale,Repeat' |
||
| tag_not | string | Filter by the tags that aren't associated with the customer. This query parameter accepts multiple tags separated by commas. | - tag_not:'Prospect'- tag_not:'Test,Internal' |
||
| total_spent | float | Filter by the total amount of money a customer has spent across all orders. | - total_spent:100.50- total_spent:50.00- total_spent:>100.50- total_spent:>50.00 |
||
| updated_at | time | The date and time, matching a whole day, when the customer's information was last updated. | - updated_at:2024-01-01T00:00:00Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
Customer accounts associated to the shop.
CustomerConnection!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: CustomerSortKeys - 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 |
||
| accepts_marketing | boolean | Filter by whether a customer has consented to receive marketing material. | - accepts_marketing:true |
||
| country | string | Filter by the country associated with the customer's address. Use either the country name or the two-letter country code. | - country:Canada- country:JP |
||
| customer_date | time | Filter by the date and time when the customer record was created. This query parameter filters by the createdAt field. |
- customer_date:'2024-03-15T14:30:00Z'- customer_date: >='2024-01-01' |
||
| string | The customer's email address, used to communicate information about orders and for the purposes of email marketing campaigns. You can use a wildcard value to filter the query by customers who have an email address specified. Please note that email is a tokenized field: To retrieve exact matches, quote the email address (phrase query) as described in Shopify API search syntax. | - email:gmail.com- email:"bo.wang@example.com"- email:* |
|||
| first_name | string | Filter by the customer's first name. | - first_name:Jane |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| last_abandoned_order_date | time | Filter by the date and time of the customer's most recent abandoned checkout. An abandoned checkout occurs when a customer adds items to their cart, begins the checkout process, but leaves the site without completing their purchase. | - last_abandoned_order_date:'2024-04-01T10:00:00Z'- last_abandoned_order_date: >='2024-01-01' |
||
| last_name | string | Filter by the customer's last name. | - last_name:Reeves |
||
| order_date | time | Filter by the date and time that the order was placed by the customer. Use this query filter to check if a customer has placed at least one order within a specified date range. | - order_date:'2024-02-20T00:00:00Z'- order_date: >='2024-01-01'- order_date:'2024-01-01..2024-03-31' |
||
| orders_count | integer | Filter by the total number of orders a customer has placed. | - orders_count:5 |
||
| phone | string | The phone number of the customer, used to communicate information about orders and for the purposes of SMS marketing campaigns. You can use a wildcard value to filter the query by customers who have a phone number specified. | - phone:+18005550100- phone:* |
||
| state | string | Filter by the state of the customer's account with the shop. This filter is only valid when Classic Customer Accounts is active. | - state:ENABLED- state:INVITED- state:DISABLED- state:DECLINED |
||
| tag | string | Filter by the tags that are associated with the customer. This query parameter accepts multiple tags separated by commas. | - tag:'VIP'- tag:'Wholesale,Repeat' |
||
| tag_not | string | Filter by the tags that aren't associated with the customer. This query parameter accepts multiple tags separated by commas. | - tag_not:'Prospect'- tag_not:'Test,Internal' |
||
| total_spent | float | Filter by the total amount of money a customer has spent across all orders. | - total_spent:100.50- total_spent:50.00- total_spent:>100.50- total_spent:>50.00 |
||
| updated_at | time | The date and time, matching a whole day, when the customer's information was last updated. | - updated_at:'2024-01-01T00:00:00Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
metafieldDefinitionsmetafieldDefinitions on ShopList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
ordersorders on ShopA list of the shop's orders.
OrderConnection!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: OrderSortKeys - 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 |
||
| cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | - cart_token:abc123 |
||
| channel | string | Filter by the channel information handle (ChannelInformation.channelDefinition.handle) field. |
- channel:web- channel:web,pos |
||
| channel_id | id | Filter by the channel id field. |
- channel_id:123 |
||
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - accepted- charge_refunded- lost- needs_response- under_review- won |
- chargeback_status:accepted |
|
| checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | - checkout_token:abc123 |
||
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | - confirmation_number:ABC123 |
||
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | - created_at:2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | - credit_card_last4:1234 |
||
| current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | - current_total_price:10- current_total_price:>=5.00 current_total_price:<=20.99 |
||
| customer_id | id | Filter orders by the customer id field. |
- customer_id:123 |
||
| delivery_method | string | Filter by the delivery methodType field. |
- shipping- pick-up- retail- local- pickup-point- none |
- delivery_method:shipping |
|
| discount_code | string | Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255. | - discount_code:ABC123 |
||
| string | Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns. | - email:example@shopify.com |
|||
| financial_status | string | Filter by the order displayFinancialStatus field. |
- paid- pending- authorized- partially_paid- partially_refunded- refunded- voided- expired |
- financial_status:authorized |
|
| fraud_protection_level | string | Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes. | - fully_protected- partially_protected- not_protected- pending- not_eligible- not_available |
- fraud_protection_level:fully_protected |
|
| fulfillment_location_id | id | Filter by the fulfillment location id (Fulfillment.location.id) field. |
- fulfillment_location_id:123 |
||
| fulfillment_status | string | Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing. |
- unshipped- shipped- fulfilled- partial- scheduled- on_hold- unfulfilled- request_declined |
- fulfillment_status:fulfilled |
|
| gateway | string | Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways. |
- gateway:shopify_payments |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| location_id | id | Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned. |
- location_id:123 |
||
| metafields.{namespace}.{key} | mixed | Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value. |
- metafields.custom.on_sale:true- metafields.product.material:"gid://shopify/Metaobject/43458085" |
||
| name | string | Filter by the order name field. |
- name:1001-A |
||
| payment_id | string | Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues. | - payment_id:abc123 |
||
| payment_provider_id | id | Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions. | - payment_provider_id:123 |
||
| po_number | string | Filter by the order poNumber field. |
- po_number:P01001 |
||
| processed_at | time | Filter by the order processedAt field. |
- processed_at:2021-01-01T00:00:00Z |
||
| reference_location_id | id | Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location. | - reference_location_id:123 |
||
| return_status | string | Filter by the order's returnStatus to monitor returns processing and track which orders have active returns. |
- return_requested- in_progress- inspection_complete- returned- return_failed- no_return |
- return_status:in_progress |
|
| risk_level | string | Filter by the order risk assessment riskLevel field. |
- high- medium- low- none- pending |
- risk_level:high |
|
| sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | - sales_channel: some_sales_channel |
||
| shipping_address_validation_result_summary | string | Filter by the validation status of the shipping address. Learn more about validating addresses. | - has_issues- no_issues- not_validated |
- shipping_address_validation_result_summary:no_issues |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:ABC123 |
||
| source_identifier | string | Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order. | - source_identifier:1234-12-1000 |
||
| source_name | string | Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods. | - source_name:web- source_name:shopify_draft_order |
||
| status | string | Filter by the order's status to manage workflows or analyze the order lifecycle. | - open- closed- cancelled- not_closed |
- status:open |
|
| subtotal_line_items_quantity | string | Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns. | - subtotal_line_items_quantity:10- subtotal_line_items_quantity:5..20 |
||
| tag | string | Filter objects by the tag field. |
- tag:my_tag |
||
| tag_not | string | Filter by objects that don’t have the specified tag. | - tag_not:my_tag |
||
| test | boolean | Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. | - test:true |
||
| total_weight | string | Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz. | - total_weight:10.5kg- total_weight:>=5g total_weight:<=20g- total_weight:.5 lb |
||
| updated_at | time | Filter by the date and time when the order was last updated in Shopify's system. | - updated_at:2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
A list of the shop's orders.
OrderConnection!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: OrderSortKeys - 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 |
||
| cart_token | string | Filter by the cart token's unique value to track abandoned cart conversions or troubleshoot checkout issues. The token references the cart that's associated with an order. | - cart_token:abc123 |
||
| channel | string | Filter by the order attribution handle (Order.attribution.handle) field. The legacy channel information handle (ChannelInformation.channelDefinition.handle) field is deprecated but remains supported during the deprecation period. |
- channel:web- channel:web,pos |
||
| channel_id | id | Filter by the channel id field. |
- channel_id:123 |
||
| chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - accepted- charge_refunded- lost- needs_response- under_review- won |
- chargeback_status:accepted |
|
| checkout_token | string | Filter by the checkout token's unique value to analyze conversion funnels or resolve payment issues. The checkout token's value references the checkout that's associated with an order. | - checkout_token:abc123 |
||
| confirmation_number | string | Filter by the randomly generated alpha-numeric identifier for an order that can be displayed to the customer instead of the sequential order name. This value isn't guaranteed to be unique. | - confirmation_number:ABC123 |
||
| created_at | time | Filter by the date and time when the order was created in Shopify's system. | - created_at:'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| credit_card_last4 | string | Filter by the last four digits of the payment card that was used to pay for the order. This filter matches only the last four digits of the card for heightened security. | - credit_card_last4:1234 |
||
| current_total_price | float | Filter by the current total price of the order in the shop currency, including any returns/refunds/removals. This filter supports both exact values and ranges. | - current_total_price:10- current_total_price:>=5.00 current_total_price:<=20.99 |
||
| customer_id | id | Filter orders by the customer id field. |
- customer_id:123 |
||
| delivery_method | string | Filter by the delivery methodType field. |
- shipping- pick-up- retail- local- pickup-point- none |
- delivery_method:shipping |
|
| discount_code | string | Filter by the case-insensitive discount code that was applied to the order at checkout. Limited to the first discount code used on an order. Maximum characters: 255. | - discount_code:ABC123 |
||
| string | Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns. | - email:example@shopify.com |
|||
| financial_status | string | Filter by the order displayFinancialStatus field. |
- paid- pending- authorized- partially_paid- partially_refunded- refunded- voided- expired |
- financial_status:authorized |
|
| fraud_protection_level | string | Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes. | - fully_protected- partially_protected- not_protected- pending- not_eligible- not_available |
- fraud_protection_level:fully_protected |
|
| fulfillment_location_id | id | Filter by the fulfillment location id (Fulfillment.location.id) field. |
- fulfillment_location_id:123 |
||
| fulfillment_status | string | Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing. |
- unshipped- shipped- fulfilled- partial- scheduled- on_hold- unfulfilled- request_declined |
- fulfillment_status:fulfilled |
|
| gateway | string | Filter by the paymentGatewayNames field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways. |
- gateway:shopify_payments |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| location_id | id | Filter by the location id that's associated with the order to view and manage orders for specific locations. For POS orders, locations must be defined in the Shopify admin under Settings > Locations. If no ID is provided, then the primary location of the shop is returned. |
- location_id:123 |
||
| metafields.{namespace}.{key} | mixed | Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value. |
- metafields.custom.on_sale:true- metafields.product.material:"gid://shopify/Metaobject/43458085" |
||
| name | string | Filter by the order name field. |
- name:1001-A |
||
| payment_id | string | Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues. | - payment_id:abc123 |
||
| payment_provider_id | id | Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions. | - payment_provider_id:123 |
||
| po_number | string | Filter by the order poNumber field. |
- po_number:P01001 |
||
| processed_at | time | Filter by the order processedAt field. |
- processed_at:'2021-01-01T00:00:00Z' |
||
| reference_location_id | id | Filter by the ID of a location that's associated with the order, such as locations from fulfillments, refunds, or the shop's primary location. | - reference_location_id:123 |
||
| return_status | string | Filter by the order's returnStatus to monitor returns processing and track which orders have active returns. |
- return_requested- in_progress- inspection_complete- returned- return_failed- no_return |
- return_status:in_progress |
|
| risk_level | string | Filter by the order risk assessment riskLevel field. |
- high- medium- low- none- pending |
- risk_level:high |
|
| sales_channel | string | Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes. | - sales_channel: some_sales_channel |
||
| shipping_address_validation_result_summary | string | Filter by the validation status of the shipping address. Learn more about validating addresses. | - has_issues- no_issues- not_validated |
- shipping_address_validation_result_summary:no_issues |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:ABC123 |
||
| source_identifier | string | Filter by the ID of the order placed on the originating platform, such as a unique POS or third-party identifier. This value doesn't correspond to the Shopify ID that's generated from a completed draft order. | - source_identifier:1234-12-1000 |
||
| source_name | string | Filter by the platform where the order was placed to distinguish between web orders, POS sales, draft orders, or third-party channels. Use this filter to analyze sales performance across different ordering methods. | - source_name:web- source_name:shopify_draft_order |
||
| status | string | Filter by the order's status to manage workflows or analyze the order lifecycle. | - open- closed- cancelled- not_closed |
- status:open |
|
| subtotal_line_items_quantity | string | Filter by the total number of items across all line items in an order. This filter supports both exact values and ranges, and is useful for identifying bulk orders or analyzing purchase volume patterns. | - subtotal_line_items_quantity:10- subtotal_line_items_quantity:5..20 |
||
| tag | string | Filter objects by the tag field. |
- tag:my_tag |
||
| tag_not | string | Filter by objects that don’t have the specified tag. | - tag_not:my_tag |
||
| test | boolean | Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled. | - test:true |
||
| total_weight | string | Filter by the order weight. This filter supports both exact values and ranges, and is to be used to filter orders by the total weight of all items (excluding packaging). It takes a unit of measurement as a suffix. It accepts the following units: g, kg, lb, oz. | - total_weight:10.5kg- total_weight:>=5g total_weight:<=20g- total_weight:.5 lb |
||
| updated_at | time | Filter by the date and time when the order was last updated in Shopify's system. | - updated_at:'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
productVariantsproductVariants on ShopList of the shop's product variants.
ProductVariantConnection!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: ProductVariantSortKeys - 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-123 |
||
| collection | string | Filter by the ID of the collection that the product variant belongs to. | - collection:465903092033 |
||
| delivery_profile_id | id | Filter by the product variant delivery profile ID (ProductVariant.deliveryProfile.id). |
- delivery_profile_id:108179161409 |
||
| exclude_composite | boolean | Filter by product variants that aren't composites. | - exclude_composite:true |
||
| exclude_variants_with_components | boolean | Filter by whether there are components that are associated with the product variants in a bundle. | - exclude_variants_with_components:true |
||
| gift_card | boolean | Filter by the product isGiftCard field. |
- gift_card:true |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| inventory_quantity | integer | Filter by an aggregate of inventory across all locations where the product variant is stocked. | - inventory_quantity:10 |
||
| location_id | id | Filter by the location ID for the product variant. | - location_id:88511152449 |
||
| managed | boolean | Filter by whether there is fulfillment service tracking associated with the product variants. | - managed:true |
||
| managed_by | string | Filter by the fulfillment service that tracks the number of items in stock for the product variant. | - managed_by:shopify |
||
| option1 | string | Filter by a custom property that a shop owner uses to define product variants. | - option1:small |
||
| option2 | string | Filter by a custom property that a shop owner uses to define product variants. | - option2:medium |
||
| option3 | string | Filter by a custom property that a shop owner uses to define product variants. | - option3:large |
||
| product_id | id | Filter by the product id field. |
- product_id:8474977763649 |
||
| product_ids | string | Filter by a comma-separated list of product IDs. | - product_ids:8474977763649,8474977796417 |
||
| product_publication_status | string | Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead. |
- * {channel_app_id}-approved- * {channel_app_id}-rejected- * {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_status | string | Filter by a comma-separated list of product statuses. | - product_status:ACTIVE,DRAFT |
||
| product_type | string | Filter by the product type that's associated with the product variants. | - product_type:snowboard- product_type:snowboard,skis- product_type:snowboard OR product_type:skis |
||
| publishable_status | string | Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (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_status | string | Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| requires_components | boolean | Filter by whether the product variant can only be purchased with components. Learn more. | - requires_components:true |
||
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| tag | string | Filter objects by the tag field. |
- tag:my_tag |
||
| tag_not | string | Filter by objects that don’t have the specified tag. | - tag_not:my_tag |
||
| taxable | boolean | Filter by the product variant taxable field. |
- taxable:false |
||
| title | string | Filter by the product variant title field. |
- title:ice |
||
| updated_at | time | Filter by date and time when the product variant was updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| vendor | string | Filter by the origin or source of the product variant. Learn more about vendors and managing vendor information. | - vendor:Snowdevil- vendor:Snowdevil,Icedevil- vendor:Snowdevil OR vendor:Icedevil |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of the shop's product variants.
ProductVariantConnection!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: ProductVariantSortKeys - 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-123 |
||
| collection | string | Filter by the ID of the collection that the product variant belongs to. | - collection:465903092033 |
||
| delivery_profile_id | id | Filter by the product variant delivery profile ID (ProductVariant.deliveryProfile.id). |
- delivery_profile_id:108179161409 |
||
| exclude_composite | boolean | Filter by product variants that aren't composites. | - exclude_composite:true |
||
| exclude_variants_with_components | boolean | Filter by whether there are components that are associated with the product variants in a bundle. | - exclude_variants_with_components:true |
||
| gift_card | boolean | Filter by the product isGiftCard field. |
- gift_card:true |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| inventory_quantity | integer | Filter by an aggregate of inventory across all locations where the product variant is stocked. | - inventory_quantity:10 |
||
| location_id | id | Filter by the location ID for the product variant. | - location_id:88511152449 |
||
| managed | boolean | Filter by whether there is fulfillment service tracking associated with the product variants. | - managed:true |
||
| managed_by | string | Filter by the fulfillment service that tracks the number of items in stock for the product variant. | - managed_by:shopify |
||
| option1 | string | Filter by a custom property that a shop owner uses to define product variants. | - option1:small |
||
| option2 | string | Filter by a custom property that a shop owner uses to define product variants. | - option2:medium |
||
| option3 | string | Filter by a custom property that a shop owner uses to define product variants. | - option3:large |
||
| product_id | id | Filter by the product id field. |
- product_id:8474977763649 |
||
| product_ids | string | Filter by a comma-separated list of product IDs. | - product_ids:8474977763649,8474977796417 |
||
| product_publication_status | string | Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead. |
- * {channel_app_id}-approved- * {channel_app_id}-rejected- * {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_status | string | Filter by a comma-separated list of product statuses. | - product_status:ACTIVE,DRAFT |
||
| product_type | string | Filter by the product type that's associated with the product variants. | - product_type:snowboard- product_type:snowboard,skis- product_type:snowboard OR product_type:skis |
||
| publishable_status | string | Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (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_status | string | Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| requires_components | boolean | Filter by whether the product variant can only be purchased with components. Learn more. | - requires_components:true |
||
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| tag | string | Filter objects by the tag field. |
- tag:my_tag |
||
| tag_not | string | Filter by objects that don’t have the specified tag. | - tag_not:my_tag |
||
| taxable | boolean | Filter by the product variant taxable field. |
- taxable:false |
||
| title | string | Filter by the product variant title field. |
- title:ice |
||
| updated_at | time | Filter by date and time when the product variant was updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| vendor | string | Filter by the origin or source of the product variant. Learn more about vendors and managing vendor information. | - vendor:Snowdevil- vendor:Snowdevil,Icedevil- vendor:Snowdevil OR vendor:Icedevil |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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.
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 a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel. |
- online_store_channel- published- visible- unpublished- * {channel_id_or_handle}-published- * {channel_id_or_handle}-visible- * {channel_id_or_handle}-intended- * {channel_id_or_handle}-hidden- * {channel_app_id_or_handle}-published- * {channel_app_id_or_handle}-visible- * {channel_app_id_or_handle}-intended- * {channel_app_id_or_handle}-hidden- unavailable |
- published_status:online_store_channel- published_status:published- published_status:580111-published- published_status:580111-hidden- published_status:my-channel-handle-published- published_status:unavailable |
|
| sku | string | Filter by the product variant sku field. Learn more about SKUs. |
- sku:XYZ-12345 |
||
| status | string | Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps. |
- active- archived- draft- unlisted |
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.
INVALID_STANDARD_METAOBJECTINVALID_AMOUNTINVALID_CVCINCORRECT_CVCINCORRECT_PININVALID_REQUESTINVALID_AMOUNTINVALID_CVCINCORRECT_CVCINCORRECT_PININVALID_REQUESTmetafieldDefinitionsmetafieldDefinitions on ValidationList of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>2020-10-21T23:39:20Z- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>2020-10-21T23:39:20Z- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
List of metafield definitions.
MetafieldDefinitionConnection!namespace: String - Filter metafield definitions by namespace.
pinnedStatus: MetafieldDefinitionPinnedStatus - Filter by the definition's pinned status.
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: MetafieldDefinitionSortKeys - 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 |
||
| created_at | time | Filter by the date and time when the metafield definition was created. | - created_at:>'2020-10-21T23:39:20Z'- created_at:<now- created_at:<=2024 |
||
| id | id | Filter by id range. |
- id:1234- id:>=1234- id:<=1234 |
||
| key | string | Filter by the metafield definition key field. |
- key:some-key |
||
| namespace | string | Filter by the metafield definition namespace field. |
- namespace:some-namespace |
||
| owner_type | string | Filter by the metafield definition ownerType field. |
- owner_type:PRODUCT |
||
| type | string | Filter by the metafield definition type field. |
- type:single_line_text_field |
||
| updated_at | time | Filter by the date and time when the metafield definition was last updated. | - updated_at:>'2020-10-21T23:39:20Z'- updated_at:<now- updated_at:<=2024 |
||
| You can apply one or more filters to a query. Learn more about Shopify API search syntax. |
VARIANTS_DELETEMANAGED_MARKETS_ADAPTIVE_PRICING_UPDATED