collections Count
Requires access scope.
Count of collections. Limited to a maximum of 10000 by default.
Arguments
- limit (Int)
- query (String)
- savedSearchId (ID)
- Anchor to limitlimit•IntDefault:10000
The upper bound on count value before returning a result. Use
nullto 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 default•string
Filter by a case-insensitive search of multiple fields in a document.
query=Bob Normanquery=title:green hoodie- Anchor to collection_type•string
customsmart- Anchor to handle•string
- Anchor to product_id•id
Filter by collections containing a product by its ID.
- Anchor to 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
appID (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_publishedproduct_publication_status:189769876-approved- Anchor to 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
appID (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_approvedpublishable_status:580111-unsetpublishable_status:580111-pending- Anchor to published_at•time
Filter by the date and time when the collection was published to the Online Store.
- Anchor to published_status•string
Filter resources by their visibility and publication state on a channel. Online store channel filtering: -
: Returns all resources in the online store channel, regardless of publication status. -published/visible: Returns resources that are published to the online store. -unpublished: Returns resources that are not published to the online store. Channel-specific filtering using the channelappID (Channel.app.id) with suffixes: -: Returns resources published to the specified channel. -: Same as(kept for backwards compatibility). -: Returns resources added to the channel but not yet published. -: Returns resources not added to the channel or not published. Other: -unavailable: Returns resources not published to any channel.online_store_channelpublishedvisibleunpublished* {channel_app_id}-published* {channel_app_id}-visible* {channel_app_id}-intended* {channel_app_id}-hiddenunavailablepublished_status:online_store_channelpublished_status:publishedpublished_status:580111-publishedpublished_status:580111-hiddenpublished_status:unavailable- Anchor to title•string
- Anchor to updated_at•time
Example:
Valid values:
Valid values:
Example:
Valid values:
Example:
Valid values:
Example:
- Anchor to savedSearchIdsaved•ID
Search Id
Anchor to Possible returnsPossible returns
- Count (Count)
- Anchor to CountCount•Count
A numeric count with precision information indicating whether the count is exact or an estimate.
- Anchor to countcount•Int!non-null
The count of elements.
- Anchor to precisionprecision•Count
Precision! non-null The count's precision, or the exactness of the value.