Choose a version:

Count

object

A numeric count with precision information indicating whether the count is exact or an estimate.

Anchor to FieldsFields

Anchor to countcount

•Int!

non-null

The count of elements.

Anchor to precisionprecision

•CountPrecision!

non-null

The count's precision, or the exactness of the value.

Was this section helpful?

Anchor to QueriesQueries

Anchor to abandonedCheckoutsCount abandonedCheckoutsCount

•query

Returns the count of abandoned checkouts for the given shop. Limited to a maximum of 10000 by default.

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

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
created_at time The date and time (in [ISO 8601
format](http://en.wikipedia.org/wiki/ISO_8601)) when the abandoned cart was created.
email_state string Filter by abandoned_email_state value. Possible
values: sent, not_sent, scheduled and suppressed.
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
recovery_state string Possible values: recovered and not_recovered.
status string Possible values: open and closed.
updated_at time The date and time (in [ISO 8601
format](http://en.wikipedia.org/wiki/ISO_8601)) when the abandoned cart was
last updated.
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).
Anchor to savedSearchIdsavedSearchId •ID: The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

Anchor to blogsCount blogsCount

•query

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

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

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
created_at time
handle string
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
title string
updated_at time
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).

Anchor to catalogsCount catalogsCount

•query

The count of catalogs belonging to the shop. Limited to a maximum of 10000 by default.

Arguments

Anchor to limitlimit

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to queryquery

•String

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

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
app_id	id
company_id	id
company_location_id	id
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
managed_country_id	id
market_id	id
status	string
title	string
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).

Anchor to typetype

•CatalogType

Default:null

The type of the catalogs to be returned.

Anchor to collectionsCount collectionsCount

•query

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

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

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
collection_type string - custom
- smart
handle string
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
product_id id Filter by collections containing a product by its ID.
product_publication_status string Filter by channel approval process
status of the resource on a channel, such as the online store. The value is
a composite of the channel app ID
(Channel.app.id) and one of the valid values. For simple visibility checks, use published_status
instead. - * {channel_app_id}-approved
- `*
{channel_app_id}-rejected - * {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
publishable_status string Deprecated: This parameter is deprecated
as of 2025-12 and will be removed in a future API version. Use published_status
for visibility checks. Filter by the publishable status of the resource on a
channel. The value is a composite of the [channel app
ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price)
(Channel.app.id) and one of the valid status values. - `*
{channel_app_id}-unset - * {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 collection was published to the Online Store.
published_status string Filter resources by their visibility and
publication state on a channel. Online store channel filtering: -
online_store_channel: Returns all resources in the online store channel,
regardless of publication status. - published/visible: Returns resources
that are published to the online store. - unpublished: Returns resources
that are not published to the online store. Channel-specific filtering using
a channel ID, channel handle, [channel app
ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price)
(Channel.app.id), or app handle with suffixes: -
{id_or_handle}-published: Returns resources published to the specified
channel. - {id_or_handle}-visible: Same as {id_or_handle}-published
(kept for backwards compatibility). - {id_or_handle}-intended: Returns
resources added to the channel but not yet published. -
{id_or_handle}-hidden: Returns resources not added to the channel or not
published. Other: - unavailable: Returns resources not published to any
channel. - online_store_channel
- published
- visible

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

published_status:580111-hidden
- published_status:my-channel-handle-published
- published_status:unavailable | | title | string | | updated_at | time | You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Anchor to savedSearchIdsavedSearchId •ID: The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

Anchor to companiesCount companiesCount

•query

The number of companies for a shop. Limited to a maximum of 10000 by default.

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

Anchor to customersCount customersCount

•query

The number of customers. Limited to a maximum of 10000 by default.

Arguments

Anchor to limitlimit

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

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

Anchor to discountCodesCount discountCodesCount

•query

The total number of discount codes for the shop. Limited to a maximum of 10000 by default.

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

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
times_used integer
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).

Anchor to discountNodesCount discountNodesCount

•query

The total number of discounts for the shop. Limited to a maximum of 10000 by default.

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

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
code string Filter by the discount code. Not supported for bulk discounts. - code:WELCOME10
combines_with string Filter by the [Shopify Functions discount
classes](https://shopify.dev/docs/apps/build/discounts#discount-classes)
that the discount type
can combine with. Supports multiple values separated by commas (e.g.,
combines_with:product_discounts,order_discounts). - order_discounts

product_discounts
- shipping_discounts | | - combines_with:product_discounts
- combines_with:product_discounts,order_discounts | | combines_with.product_discounts_with_tags_on_same_cart_line | string | Filter by a combines with tag applied to discounts on the same cart line. Supports multiple tags separated by commas (e.g., combines_with.product_discounts_with_tags_on_same_cart_line:priority,exclusive). | | | - combines_with.product_discounts_with_tags_on_same_cart_line:priority
- combines_with.product_discounts_with_tags_on_same_cart_line:priority,exclusive | | created_at | time | Filter by the date and time, in the shop's timezone, when the discount was created. | | | - created_at:>'2020-10-21T23:39:20Z'
- created_at:<now
- created_at:<='2024' | | discount_class | string | Filter by the discount class. Supports multiple classes separated by commas (e.g., discount_class:product,order). | - order
- product
- shipping | | - discount_class:product
- discount_class:product,order | | discount_type | string | Filter by the discount type. Supports multiple types separated by commas (e.g., discount_type:percentage,fixed_amount). | - app
- bogo
- fixed_amount
- free_shipping
- percentage | | - discount_type:fixed_amount
- discount_type:percentage,fixed_amount | | ends_at | time | Filter by the date and time, in the shop's timezone, when the discount ends. | | | - ends_at:>'2020-10-21T23:39:20Z'
- ends_at:<now
- ends_at:<='2024' | | id | id | Filter by id range. | | | - id:1234
- id:>=1234
- id:<=1234 | | method | string | Filter by the discount method. Supports multiple methods separated by commas (e.g., method:code,automatic). | - automatic
- code | | - method:code
- method:code,automatic | | starts_at | time | Filter by the date and time, in the shop's timezone, when the discount becomes active and is available for customer use. | | | - starts_at:>'2020-10-21T23:39:20Z'
- starts_at:<now
- starts_at:<='2024' | | status | string | Filter by the status of the discount. Supports multiple statuses separated by commas (e.g., status:active,scheduled). | - active
- expired
- scheduled | | - status:scheduled
- status:active,scheduled | | tag | string | Filter by a tag applied to the discount. Supports multiple tags separated by commas (e.g., tag:loyalty,clearance). | | | - tag:loyalty
- tag:loyalty,clearance | | times_used | integer | Filter by the number of times the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times.

This value is updated asynchronously. As a result, it might be different than the actual usage count. | | | - times_used:0

times_used:>150
- times_used:>=200 | | title | string | Filter by the discount name that displays to merchants in the Shopify admin and to customers. | | | - title:Black Friday Sale | | type | string | Filter by the discount type. Supports multiple types separated by commas (e.g., type:percentage,fixed_amount). | - all
- all_with_app
- app
- bxgy
- fixed_amount
- free_shipping
- percentage | | - type:percentage
- type:percentage,fixed_amount | | updated_at | time | Filter by the date and time, in the shop's timezone, when the discount 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.
Anchor to savedSearchIdsavedSearchId •ID: The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

Anchor to draftOrdersCount draftOrdersCount

•query

Returns the number of draft orders that match the query. Limited to a maximum of 10000 by default.

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

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
created_at time
customer_id id
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
ids string
source string
status string
tag string
updated_at time
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).
Anchor to savedSearchIdsavedSearchId •ID: The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

Anchor to eventsCount eventsCount

•query

Count of events. Limited to a maximum of 10000.

Arguments

Anchor to queryquery

•String

Anchor to action •string: The action that occured.

Anchor to giftCardsCount giftCardsCount

•query

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.

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

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document, including gift card codes. -
query=a5bh6h64b329j4k7
- query=Bob Norman
balance_status string - full
- partial
- empty

full_or_partial | | - balance_status:full | | created_at | time | | | | - created_at:>=2020-01-01T12:00:00Z | | customer_id | id | | expires_on | date | | | | - expires_on:>=2020-01-01 | | id | id | Filter by id range. | | | - id:1234
- id:>=1234
- id:<=1234 | | initial_value | string | | | | - initial_value:>=100 | | recipient_id | id | | source | string | | - manual
- purchased
- api_client | | - source:manual | | status | string | | - disabled
- enabled
- expired
- expiring | | - status:disabled OR status:expired | You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Anchor to savedSearchIdsavedSearchId •ID: The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

Anchor to locationsCount locationsCount

•query

Returns the count of locations for the given shop. Limited to a maximum of 10000 by default.

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

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
active string
address1 string
address2 string
city string
country string
created_at time
geolocated boolean
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
legacy boolean
location_id id
name string
pickup_in_store string - enabled
- disabled
province string
zip string
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).

Anchor to ordersCount ordersCount

•query

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 the limit argument to adjust this value, or pass null for no limit. Limited to a maximum of 10000 by default.

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

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

return_requested
- in_progress
- inspection_complete

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

total_weight:.5 lb | | updated_at | time | Filter by the date and time when the order was last updated in Shopify's system. | | | - updated_at:2020-10-21T23:39:20Z

updated_at:<now
- updated_at:<=2024 | You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Anchor to savedSearchIdsavedSearchId •ID: The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

Anchor to pagesCount pagesCount

•query

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

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

Anchor to pendingOrdersCount pendingOrdersCount

•query

The number of pendings orders. Limited to a maximum of 10000.

Anchor to productsCount productsCount

•query

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

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

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

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

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

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

Anchor to productVariantsCount productVariantsCount

•query

Count of product variants. Limited to a maximum of 10000 by default.

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

Anchor to publicationsCount publicationsCount

•query

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

Arguments

Anchor to catalogTypecatalogType

•CatalogType

Filter publications by catalog type.

Anchor to limitlimit

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to publishedProductsCount publishedProductsCount

•query

Returns a count of published products by publication ID. Limited to a maximum of 10000 by default.

Anchor to limitlimit •Int Default:10000: The maximum number of products to count.
Anchor to publicationIdpublicationId •ID! required: The ID of the publication that the products are published to.

Anchor to segmentsCount segmentsCount

•query

The number of segments for a shop. Limited to a maximum of 10000 by default.

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

Anchor to urlRedirectsCount urlRedirectsCount

•query

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

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

name type description acceptable_values default_value example_use
default string Filter by a case-insensitive search of multiple fields
in a document. - query=Bob Norman
- query=title:green hoodie
created_at time
id id Filter by id range. - id:1234
- id:>=1234
- id:<=1234
path string
target string
You can apply one or more filters to a query. Learn more about [Shopify API
search syntax](https://shopify.dev/api/usage/search-syntax).
Anchor to savedSearchIdsavedSearchId •ID: The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

Anchor to webhookSubscriptionsCount webhookSubscriptionsCount

•query

The count of webhook subscriptions.

Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your shopify.app.toml may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions. Limited to a maximum of 10000 by default.

Arguments

Anchor to limitlimit

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at •time
Anchor to endpoint •string
Anchor to id •id: Filter by id range.
Anchor to topic •string
Anchor to updated_at •time

Was this section helpful?

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

name	type	description	acceptable_values
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
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` -

name	type	description	acceptable_values	example_use
default	string	Filter by a case-insensitive search of multiple fields
in a document.			- `query=Bob Norman` - `query=title:green hoodie`
barcode	string	Filter by the product variant `barcode`
field.			- `barcode:ABC-abc-1234`
bundles	boolean	Filter by a [product
bundle](https://shopify.dev/docs/apps/build/product-merchandising/bundles).
A product bundle is a set of two or more related products, which are
commonly offered at a discount.			- `bundles:true`
category_id	string	Filter by the product category ID
(`product.category.id`). A product category is the category of a product
from Shopify's Standard Product Taxonomy.
		- `category_id:sg-4-17-2-17`
collection_id	id	Filter by the collection `id`
field.			- `collection_id:108179161409`
combined_listing_role	string	Filter by the role of the product in a combined listing.
- `parent` - `child` - `no_role`		-
`combined_listing_role:parent`
created_at	time	Filter by the date and time when the product was
created.			- `created_at:>'2020-10-21T23:39:20Z'` -
`created_at:<now` - `created_at:<='2024'`
delivery_profile_id	id	Filter by the delivery profile `id`
field.			- `delivery_profile_id:108179161409`
error_feedback	string	Filter by products with publishing errors.
gift_card	boolean	Filter by the product `isGiftCard`
field.			- `gift_card:true`
handle	string	Filter by a comma-separated list of product handles.
		- `handle:the-minimal-snowboard`
has_only_composites	boolean	Filter by products that have only
composite variants.			- `has_only_composites:true`
has_only_default_variant	boolean	Filter by products that have only a
default variant. A default variant is the only variant if no other variants
are specified.			- `has_only_default_variant:true`
has_variant_with_components	boolean	Filter by products that have
variants with associated components.			-
`has_variant_with_components:true`
id	id	Filter by `id` range.		- `id:1234` - `id:>=1234` - `id:<=1234`
inventory_total	integer	Filter by inventory count.		-
`inventory_total:0` - `inventory_total:>150` -
`inventory_total:>=200`
is_price_reduced	boolean	Filter by products that have a reduced price.