Skip to main content
query

Requires read_orders access scope or read_marketplace_orders access scope.

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 the query argument to filter the count by criteria like order status, financial state, or fulfillment status. The response includes both the count value and its precision, indicating whether the count is exact or an estimate.


Note

The count is limited to 10,000 orders by default. Use the limit argument to adjust this value, or pass null for no limit. 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.

nametypedescriptionacceptable_valuesdefault_valueexample_use
defaultstringFilter by a case-insensitive search of multiple fields
in a document.- query=Bob Norman
- query=title:green hoodie
cart_tokenstringFilter 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
channelstringFilter by the channel information handle
(ChannelInformation.channelDefinition.handle) field.-
channel:web
- channel:web,pos
channel_ididFilter by the channel id
field.- channel_id:123
chargeback_statusstringFilter 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_tokenstringFilter 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_numberstringFilter 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_attimeFilter 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_last4stringFilter 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_pricefloatFilter 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_ididFilter orders by the customer id
field.- customer_id:123
delivery_methodstringFilter by the delivery methodType
field.- shipping
- pick-up
- retail
- local
-
pickup-point
- none
- delivery_method:shipping
discount_codestringFilter 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
emailstringFilter by the email address that's associated with the
order to provide customer support or analyze purchasing patterns.-
email:example@shopify.com
financial_statusstringFilter by the order displayFinancialStatus
field.- paid
- pending
- authorized
-
partially_paid
- partially_refunded
- refunded
-
voided
- expired
- financial_status:authorized
fraud_protection_levelstringFilter 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_ididFilter by the fulfillment location id
(Fulfillment.location.id) field.- fulfillment_location_id:123
fulfillment_statusstringFilter by the displayFulfillmentStatus
field to prioritize shipments or monitor order processing.-
unshipped
- shipped
- fulfilled
- partial
-
scheduled
- on_hold
- unfulfilled
- request_declined
- fulfillment_status:fulfilled
gatewaystringFilter 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.- gateway:shopify_payments
ididFilter by id range.- id:1234
- id:>=1234
- id:<=1234
location_ididFilter 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.- location_id:123
metafields.{namespace}.{key}mixedFilters resources by metafield
value. Format: metafields.{namespace}.{key}:{value}. Learn more about
querying by metafield value.
- metafields.custom.on_sale:true
-
metafields.product.material:"gid://shopify/Metaobject/43458085"
namestringFilter by the order name
field.- name:1001-A
payment_idstringFilter by the payment ID that's associated with the
order to reconcile financial records or troubleshoot payment issues.-
payment_id:abc123
payment_provider_ididFilter 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_numberstringFilter by the order poNumber
field.- po_number:P01001
processed_attimeFilter by the order processedAt
field.- processed_at:2021-01-01T00:00:00Z
reference_location_ididFilter 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_statusstringFilter by the order's 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 field. | - high
    - medium
    - low
    - none
    - pending | | - risk_level:high | | sales_channel | string | Filter by the sales channel 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 field. Learn more about SKUs. | | | - 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 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.
•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

A numeric count with precision information indicating whether the count is exact or an estimate.

•Int!
non-null

The count of elements.

•CountPrecision!
non-null

The count's precision, or the exactness of the value.


Was this section helpful?