ordersCount

Returns the number of orders in the shop. You can filter orders using search syntax or a SavedSearch, and set a maximum count limit to control query performance.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the ordersCount action (under Orders).
Fill in the fields below, then reference the result from later steps as {{orderscount.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query OrdersCount($query: String, $savedSearchId: ID, $limit: Int) {
  ordersCount(query: $query, savedSearchId: $savedSearchId, limit: $limit) {
    count
    precision
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman` - `query=title:green hoodie` | | cart_token | string | 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. | | | - `cart_token:abc123` | | channel | string | Filter by the order attribution [`handle`](https://shopify.dev/api/admin-graphql/latest/objects/OrderAttribution#field-OrderAttribution.fields.handle) (`Order.attribution.handle`) field. The legacy channel information [`handle`](https://shopify.dev/api/admin-graphql/latest/objects/ChannelInformation#field-ChannelInformation.fields.channelDefinition.handle) (`ChannelInformation.channelDefinition.handle`) field is deprecated but remains supported during the deprecation period. | | | - `channel:web` - `channel:web,pos` | | channel_id | id | Filter by the channel [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Channel#field-Channel.fields.id) field. | | | - `channel_id:123` | | chargeback_status | string | Filter by the order's chargeback status. A chargeback occurs when a customer questions the legitimacy of a charge with their financial institution. | - `accepted` - `charge_refunded` - `lost` - `needs_response` - `under_review` - `won` | | - `chargeback_status:accepted` | | checkout_token | string | 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. | | | - `checkout_token:abc123` | | confirmation_number | string | 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. | | | - `confirmation_number:ABC123` | | created_at | time | Filter by the date and time when the order was created in Shopify's system. | | | - `created_at:'2020-10-21T23:39:20Z'` - `created_at:<now` - `created_at:<=2024` | | credit_card_last4 | string | 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. | | | - `credit_card_last4:1234` | | current_total_price | float | 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. | | | - `current_total_price:10` - `current_total_price:>=5.00 current_total_price:<=20.99` | | customer_id | id | Filter orders by the customer [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Customer#field-Customer.fields.id) field. | | | - `customer_id:123` | | delivery_method | string | Filter by the delivery [`methodType`](https://shopify.dev/api/admin-graphql/2024-07/objects/DeliveryMethod#field-DeliveryMethod.fields.methodType) field. | - `shipping` - `pick-up` - `retail` - `local` - `pickup-point` - `none` | | - `delivery_method:shipping` | | discount_code | string | 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. | | | - `discount_code:ABC123` | | email | string | Filter by the email address that's associated with the order to provide customer support or analyze purchasing patterns. | | | - `email:example@shopify.com` | | financial_status | string | Filter by the order [`displayFinancialStatus`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-Order.fields.displayFinancialStatus) field. | - `paid` - `pending` - `authorized` - `partially_paid` - `partially_refunded` - `refunded` - `voided` - `expired` | | - `financial_status:authorized` | | fraud_protection_level | string | Filter by the level of fraud protection that's applied to the order. Use this filter to manage risk or handle disputes. | - `fully_protected` - `partially_protected` - `not_protected` - `pending` - `not_eligible` - `not_available` | | - `fraud_protection_level:fully_protected` | | fulfillment_location_id | id | Filter by the fulfillment location [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Fulfillment#field-Fulfillment.fields.location.id) (`Fulfillment.location.id`) field. | | | - `fulfillment_location_id:123` | | fulfillment_status | string | Filter by the [`displayFulfillmentStatus`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.displayFulfillmentStatus) field to prioritize shipments or monitor order processing. | - `unshipped` - `shipped` - `fulfilled` - `partial` - `scheduled` - `on_hold` - `unfulfilled` - `request_declined` | | - `fulfillment_status:fulfilled` | | gateway | string | Filter by the [`paymentGatewayNames`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.paymentGatewayNames) field. Use this filter to find orders that were processed through specific payment providers like Shopify Payments, PayPal, or other custom payment gateways. | | | - `gateway:shopify_payments` | | id | id | Filter by `id` range. | | | - `id:1234` - `id:>=1234` - `id:<=1234` | | location_id | id | Filter by the location [`id`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location#field-Location.fields.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. | | | - `location_id:123` | | metafields.{namespace}.{key} | mixed | Filters resources by metafield value. Format: `metafields.{namespace}.{key}:{value}`. Learn more about [querying by metafield value](https://shopify.dev/apps/build/custom-data/metafields/query-by-metafield-value). | | | - `metafields.custom.on_sale:true` - `metafields.product.material:"gid://shopify/Metaobject/43458085"` | | name | string | Filter by the order [`name`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-name) field. | | | - `name:1001-A` | | payment_id | string | Filter by the payment ID that's associated with the order to reconcile financial records or troubleshoot payment issues. | | | - `payment_id:abc123` | | payment_provider_id | id | Filter by the ID of the payment provider that's associated with the order to manage payment methods or troubleshoot transactions. | | | - `payment_provider_id:123` | | po_number | string | Filter by the order [`poNumber`](https://shopify.dev/api/admin-graphql/latest/objects/order#field-Order.fields.poNumber) field. | | | - `po_number:P01001` | | processed_at | time | Filter by the order [`processedAt`](https://shopify.dev/api/admin-graphql/latest/objects/order#field-Order.fields.processedAt) field. | | | - `processed_at:'2021-01-01T00:00:00Z'` | | reference_location_id | id | 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. | | | - `reference_location_id:123` | | return_status | string | Filter by the order's [`returnStatus`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-Order.fields.returnStatus) to monitor returns processing and track which orders have active returns. | - `return_requested` - `in_progress` - `inspection_complete` - `returned` - `return_failed` - `no_return` | | - `return_status:in_progress` | | risk_level | string | Filter by the order risk assessment [`riskLevel`](https://shopify.dev/api/admin-graphql/latest/objects/OrderRiskAssessment#field-OrderRiskAssessment.fields.riskLevel) field. | - `high` - `medium` - `low` - `none` - `pending` | | - `risk_level:high` | | sales_channel | string | Filter by the [sales channel](https://shopify.dev/docs/apps/build/sales-channels) where the order was made to analyze performance or manage fulfillment processes. | | | - `sales_channel: some_sales_channel` | | sku | string | Filter by the product variant [`sku`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-ProductVariant.fields.sku) field. [Learn more about SKUs](https://help.shopify.com/manual/products/details/sku). | | | - `sku:ABC123` | | source_identifier | string | 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. | | | - `source_identifier:1234-12-1000` | | source_name | string | 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. | | | - `source_name:web` - `source_name:shopify_draft_order` | | status | string | Filter by the order's status to manage workflows or analyze the order lifecycle. | - `open` - `closed` - `cancelled` - `not_closed` | | - `status:open` | | subtotal_line_items_quantity | string | 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. | | | - `subtotal_line_items_quantity:10` - `subtotal_line_items_quantity:5..20` | | tag | string | Filter objects by the `tag` field. | | | - `tag:my_tag` | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - `tag_not:my_tag` | | test | boolean | Filter by test orders. Test orders are made using the [Shopify Bogus Gateway](https://help.shopify.com/manual/checkout-settings/test-orders/payments-test-mode#bogus-gateway) or a payment provider with test mode enabled. | | | - `test:true` | | total_weight | string | 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. | | | - `total_weight:10.5kg` - `total_weight:>=5g total_weight:<=20g` - `total_weight:.5 lb` | | updated_at | time | Filter by the date and time when the order was last updated in Shopify's system. | | | - `updated_at:'2020-10-21T23:39:20Z'` - `updated_at:<now` - `updated_at:<=2024` | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

savedSearchIdstring

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the [`SavedSearch`](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch) object.

limitnumber

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

json

{
  "query": "string",
  "savedSearchId": "string",
  "limit": 0
}

Response

Read the result with {{orderscount.response.data.data.ordersCount}}. If the API returns errors, the step fails and they are at {{orderscount.response.data.errors}}.

countnumber

precisionstring

One ofEXACTAT_LEAST

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?