Count

Filter by a case-insensitive search of multiple fields in a document.

The date and time (in ISO 8601 format) when the abandoned cart was created.

Filter by abandoned_email_state value. Possible values: sent, not_sent, scheduled and suppressed.

Filter by id range.

Possible values: recovered and not_recovered.

Possible values: open and closed.

The date and time (in ISO 8601 format) when the abandoned cart was last updated.

Filter by a case-insensitive search of multiple fields in a document.

Filter by id range.

Filter by a case-insensitive search of multiple fields in a document.

Filter by id range.

Filter by a case-insensitive search of multiple fields in a document.

Filter by id range.

Filter by collections containing a product by its ID.

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.

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.

Filter by the date and time when the collection was published to the Online Store.

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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel.

Filter by id range.

Filter by a case-insensitive search of multiple fields in a document.

Filter by id range.

Filter by a case-insensitive search of multiple fields in a document.

Filter by the discount code. Not supported for bulk discounts.

Filter by the Shopify Functions discount classes that the discount type can combine with.

Filter by the date and time, in the shop's timezone, when the discount was created.

Filter by the discount class.

Filter by the discount type.

Filter by the date and time, in the shop's timezone, when the discount ends.

Filter by id range.

Filter by the discount method.

Filter by the date and time, in the shop's timezone, when the discount becomes active and is available for customer use.

Filter by the status of the discount.

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.

Filter by the discount name that displays to merchants in the Shopify admin and to customers.

Filter by the discount type.

Filter by the date and time, in the shop's timezone, when the discount was last updated.

Filter by a case-insensitive search of multiple fields in a document.

Filter by id range.

The action that occured.

Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.

Filter by the date and time when the event occurred. Event data is retained for 1 year.

Filter by id range.

The resource type affected by this event. See EventSubjectType for possible values.

Filter by a case-insensitive search of multiple fields in a document, including gift card codes.

Filter by id range.

Filter by a case-insensitive search of multiple fields in a document.

Filter by id range.

Filter by a case-insensitive search of multiple fields in a document.

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.

Filter by the channel information handle (ChannelInformation.channelDefinition.handle) field.

Filter by the channel id field.

Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution.

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.

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.

Filter by the date and time when the order was created in Shopify's system.

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.

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.

Filter orders by the customer id field.

Filter by the delivery methodType field.

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.

Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns.

Filter by the order displayFinancialStatus field.

Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes.

Filter by the fulfillment location id (Fulfillment.location.id) field.

Filter by the displayFulfillmentStatus field to prioritize shipments or monitor order processing.

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.

Filter by id range.

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.

Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.

Filter by the order name field.

Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues.

Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions.

Filter by the order poNumber field.

Filter by the order processedAt field.

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.

Filter by the order's returnStatus to monitor returns processing and track which orders have active returns.

Filter by the order risk assessment riskLevel field.

Filter by the sales channel where the order was made to analyze performance or manage fulfillment processes.

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

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.

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.

Filter by the order's status to manage workflows or analyze the order lifecycle.

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.

Filter objects by the tag field.

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

Filter by test orders. Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.

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.

Filter by the date and time when the order was last updated in Shopify's system.

Filter by a case-insensitive search of multiple fields in a document.

Filter by the product variant barcode field.

Filter by a product bundle. A product bundle is a set of two or more related products, which are commonly offered at a discount.

Filter by the product category ID (product.category.id). A product category is the category of a product from Shopify's Standard Product Taxonomy.

Filter by the collection id field.

Filter by the role of the product in a combined listing.

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

Filter by the delivery profile id field.

Filter by products with publishing errors.

Filter by the product isGiftCard field.

Filter by a comma-separated list of product handles.

Filter by products that have only composite variants.

Filter by products that have only a default variant. A default variant is the only variant if no other variants are specified.

Filter by products that have variants with associated components.

Filter by id range.

Filter by inventory count.

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

Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.

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

Filter by the product variant price field.

Filter by the app id field.

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.

Filter by a comma-separated list of product types.

Filter by a comma-separated list of publication IDs that are associated with the product.

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.

Filter by the date and time when the product was published to the online store and other sales channels.

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 the channel app ID (Channel.app.id) with suffixes: - {channel_app_id}-published: Returns resources published to the specified channel. - {channel_app_id}-visible: Same as {channel_app_id}-published (kept for backwards compatibility). - {channel_app_id}-intended: Returns resources added to the channel but not yet published. - {channel_app_id}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel.

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

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.

Filter objects by the tag field.

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

Filter by the product title field.

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

Filter by the product variant id field.

Filter by the product variant title field.

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

Filter by a case-insensitive search of multiple fields in a document.

Filter by id range.

Filter by id range.