Skip to main content
query

Requires read_products access scope.

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

•Int
Default:10000

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

•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.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to collection_type
•string

Valid values:

  • custom
  • smart
•string
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
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 app ID (Channel.app.id) and one of the valid values.

Valid values:

  • approved
  • rejected
  • needs_action
  • awaiting_review
  • published
  • demoted
  • scheduled
  • provisionally_published

Example:

  • 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 app ID (Channel.app.id) or channel name and one of the valid values.

Valid values:

  • online_store_channel
  • published
  • unpublished
  • visible
  • unavailable
  • hidden
  • intended
  • visible

Example:

  • publishable_status:published
  • publishable_status:189769876-visible
  • publishable_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.

Valid values:

  • unset
  • pending
  • approved
  • not approved

Example:

  • published_status:approved
•string
Anchor to updated_at
•time
•ID

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.


Was this section helpful?

•Count

Details for count of elements.


Was this section helpful?