Shopify.devDocs
Log inSign up
Anchor to productsCount

productsCount

query

Requires read_products access scope.

Count of products.

Anchor to Arguments

Arguments

Anchor to limitlimit
•
Int

The upper bound on count value before returning a result.

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.

Example:

  • query=Bob Norman

  • query=title:green hoodie

Anchor to barcode
•
string

Filter by the product variant barcode field.

Example:

  • barcode:ABC-abc-1234

Anchor to 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.

Example:

  • bundles:true

Anchor to created_at
•
time

Filter by the date and time when the product was created.

Example:

  • created_at:>'2020-10-21T23:39:20Z'

  • created_at:<now

  • created_at:<='2024'

Anchor to delivery_profile_id
•
id

Filter by the delivery profile id field.

Example:

  • delivery_profile_id:108179161409

Anchor to error_feedback
•
string

Filter by products with publishing errors.

Anchor to gift_card
•
boolean

Filter by the product isGiftCard field.

Example:

  • gift_card:true

Anchor to handle
•
string

Filter by a comma-separated list of product handles.

Example:

  • handle:the-minimal-snowboard

Anchor to has_only_composites
•
boolean

Filter by products that have only composite variants.

Example:

  • has_only_composites:true

Anchor to 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.

Example:

  • has_only_default_variant:true

Anchor to has_variant_with_components
•
boolean

Filter by products that have variants with associated components.

Example:

  • has_variant_with_components:true

Anchor to id
•
id

Filter by id range.

Example:

  • id:1234

  • id:>=1234

  • id:<=1234

Anchor to inventory_total
•
integer

Filter by inventory count.

Example:

  • inventory_total:0

  • inventory_total:>150

  • inventory_total:>=200

Anchor to is_price_reduced
•
boolean

Filter by products that have a reduced price. For more information, refer to the CollectionRule object.

Example:

  • is_price_reduced:true

Anchor to out_of_stock_somewhere
•
boolean

Filter by products that are out of stock in at least one location.

Example:

  • out_of_stock_somewhere:true

Anchor to price
•
bigdecimal

Filter by the product variant price field.

Example:

  • price:100.57

Anchor to product_configuration_owner
•
string

Filter by the app id field.

Example:

  • product_configuration_owner:10001

Anchor to product_publication_status
•
string

Filter by the publishable 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.

Example:

  • publishable_status:189769876-approved

Anchor to product_type
•
string

Filter by a comma-separated list of product types.

Example:

  • product_type:snowboard

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.

Example:

  • publishable_status:published

  • publishable_status:189769876:visible

  • publishable_status:pos:hidden

Anchor to published_status
•
string

Filter by the published status of the resource on a channel, such as the online store.

Example:

  • published_status:approved

Anchor to sku
•
string

Filter by the product variant sku field. Learn more about SKUs.

Example:

  • sku:XYZ-12345

Anchor to 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.

Example:

  • status:ACTIVE,DRAFT

Anchor to tag
•
string

Filter objects by the tag field.

Example:

  • tag:my_tag

Anchor to tag_not
•
string

Filter by objects that don’t have the specified tag.

Example:

  • tag_not:my_tag

Anchor to title
•
string

Filter by the product title field.

Example:

  • title:The Minimal Snowboard

Anchor to updated_at
•
time

Filter by the date and time when the product was last updated.

Example:

  • updated_at:>'2020-10-21T23:39:20Z'

  • updated_at:<now

  • updated_at:<='2024'

Anchor to vendor
•
string

Filter by the origin or source of the product. Learn more about vendors and managing vendor information.

Example:

  • vendor:Snowdevil

  • vendor:Snowdevil OR vendor:Icedevil

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.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CountCount
•
Count

Details for count of elements.

Was this section helpful?