Returns the count of orders for the given shop. Limited to a maximum of 10000.
Access Scopes
`read_orders` access scope or `read_marketplace_orders` access scope.
Arguments
limit:
Int -
The upper bound on count value before returning a result.
query:
String -
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, which references the cart that's associated with an order. | | | - `cart_token:abc123` |
| channel | string | Filter by the channel information [`handle`](https://shopify.dev/api/admin-graphql/latest/objects/ChannelInformation#field-channeldefinition) (`ChannelInformation.channelDefinition.handle`) field. | | | - `channel:web` - `channel:web,pos` |
| channel_id | id | Filter by the channel [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Channel#field-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, which 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: - `created_at:<=2024` |
| credit_card_last4 | string | Filter by the last four digits of the credit card that was used to pay for the order. | | | - `credit_card_last4:1234` |
| customer_id | id | Filter orders by the customer [`id`](https://shopify.dev/api/admin-graphql/latest/objects/Customer#field-id) field. | | | - `customer_id:123` |
| delivery_method | string | Filter by the delivery [`methodType`](https://shopify.dev/api/admin-graphql/2024-07/objects/DeliveryMethod#field-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. Maximum characters: 255. | | | - `discount_code:ABC123` |
| email | string | Filter by the email address that's associated with the order. | | | - `email:example@shopify.com` |
| financial_status | string | Filter by the order [`displayFinancialStatus`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-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. | - `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-location) (`Fulfillment.location.id`) field. | | | - `fulfillment_location_id:123` |
| fulfillment_status | string | Filter by the order's fulfillment status. | - `unfulfilled` - `fulfilled` - `partial` - `scheduled` - `on_hold` - `request_declined` | | - `fulfillment_status:fulfilled` |
| gateway | string | Filter by the order [`paymentGatewayNames`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-paymentgatewaynames) field. | | | - `gateway:shopify_payments` |
| id | id | Filter by `id` range. | | | - `id:1234` - `id:>=1234` - `id:<=1234` |
| location_id | id | Filter by the ID of the location that's associated with the order. | | | - `location_id:123` |
| 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 ID of the payment that's associated with the order. | | | - `payment_id:abc123` |
| payment_provider_id | id | Filter by the ID of the payment provider that's associated with the order. | | | - `payment_provider_id:123` |
| po_number | string | Filter by the order [`poNumber`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-ponumber) field. | | | - `po_number:P01001` |
| processed_at | time | Filter by the order [`processedAt`](https://shopify.dev/api/admin-graphql/latest/objects/Order#field-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 return status. | - `open` - `requested` - `declined` - `canceled` - `closed` | | - `return_status:open` |
| risk_level | string | Filter by the order risk assessment [`riskLevel`](https://shopify.dev/api/admin-graphql/latest/objects/OrderRiskAssessment#field-risklevel) field. | - `high` - `medium` - `low` - `none` - `pending` | | - `risk_level:high` |
| sales_channel | string | Filter by the sales channel that the order is attributed to. | | | - `sales_channel: some_sales_channel` |
| sku | string | Filter by the product variant [`sku`](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant#field-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 name of the originating platform that's associated with the checkout for the order. | | | - `source_name:web` - `source_name:shopify_draft_order` |
| status | string | Filter by the order status. | - `open` - `closed` - `cancelled` - `not_closed` | | - `status:open` |
| subtotal_line_items_quantity | string |
| 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) or a payment provider with test mode enabled. | | | - `test:true` |
| 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: - `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).
savedSearchId:
ID -
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.