collections Count
Requires access scope.
Count of collections. Limited to a maximum of 10000 by default.
Arguments
- 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 the publication 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.approvedrejectedneeds_actionawaiting_reviewpublisheddemotedscheduledprovisionally_publishedproduct_publication_status:189769876-approved- Anchor to publishable_status•string
Filter by the publishable status of the resource on a channel, such as the online store. The value is a composite of either the channel
appID (Channel.app.id) or channelnameand one of the valid values.online_store_channelpublishedunpublishedvisibleunavailablehiddenintendedvisiblepublishable_status:publishedpublishable_status:189769876-visiblepublishable_status:pos-hidden- 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 by the published status of the resource on a channel, such as the online store.
unsetpendingapprovednot approvedpublished_status:approved- 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
- Anchor to CountCount•Count
Details for count of elements.