Shopify.devDocs
Log inSign up

Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.

Anchor to ordersCount

ordersCount

query

Requires read_orders access scope or read_marketplace_orders access scope.

Returns the count of orders for the given shop. Limited to a maximum of 10000.

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 cart_token
•
string

Filter by the cart token's unique value, which references the cart that's associated with an order.

Example:

  • cart_token:abc123
Anchor to channel
•
string

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

Example:

  • channel:web
  • channel:web,pos
Anchor to channel_id
•
id

Filter by the channel id field.

Example:

  • channel_id:123
Anchor to 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.

Valid values:

  • accepted
  • charge_refunded
  • lost
  • needs_response
  • under_review
  • won

Example:

  • chargeback_status:accepted
Anchor to checkout_token
•
string

Filter by the checkout token's unique value, which references the checkout that's associated with an order.

Example:

  • checkout_token:abc123
Anchor to 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.

Example:

  • confirmation_number:ABC123
Anchor to created_at
•
time

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

Example:

  • created_at:2020-10-21T23:39:20Z
  • created_at:<now
  • created_at:<=2024
Anchor to credit_card_last4
•
string

Filter by the last four digits of the credit card that was used to pay for the order.

Example:

  • credit_card_last4:1234
Anchor to customer_id
•
id

Filter orders by the customer id field.

Example:

  • customer_id:123
Anchor to delivery_method
•
string

Filter by the delivery methodType field.

Valid values:

  • shipping
  • pick-up
  • retail
  • local
  • pickup-point
  • none

Example:

  • delivery_method:shipping
Anchor to discount_code
•
string

Filter by the case-insensitive discount code that was applied to the order at checkout. Maximum characters: 255.

Example:

  • discount_code:ABC123
Anchor to email
•
string

Filter by the email address that's associated with the order.

Example:

  • email:example@shopify.com
Anchor to financial_status
•
string

Filter by the order displayFinancialStatus field.

Valid values:

  • paid
  • pending
  • authorized
  • partially_paid
  • partially_refunded
  • refunded
  • voided
  • expired

Example:

  • financial_status:authorized
Anchor to fraud_protection_level
•
string

Filter by the level of fraud protection that's applied to the order.

Valid values:

  • fully_protected
  • partially_protected
  • not_protected
  • pending
  • not_eligible
  • not_available

Example:

  • fraud_protection_level:fully_protected
Anchor to fulfillment_location_id
•
id

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

Example:

  • fulfillment_location_id:123
Anchor to fulfillment_status
•
string

Filter by the order's fulfillment status.

Valid values:

  • unshipped
  • shipped
  • fulfilled
  • partial
  • scheduled
  • on_hold
  • unfulfilled
  • request_declined

Example:

  • fulfillment_status:fulfilled
Anchor to gateway
•
string

Filter by the order paymentGatewayNames field.

Example:

  • gateway:shopify_payments
Anchor to id
•
id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to location_id
•
id

Filter by the ID of the location that's associated with the order.

Example:

  • location_id:123
Anchor to name
•
string

Filter by the order name field.

Example:

  • name:1001-A
Anchor to payment_id
•
string

Filter by the ID of the payment that's associated with the order.

Example:

  • payment_id:abc123
Anchor to payment_provider_id
•
id

Filter by the ID of the payment provider that's associated with the order.

Example:

  • payment_provider_id:123
Anchor to po_number
•
string

Filter by the order poNumber field.

Example:

  • po_number:P01001
Anchor to processed_at
•
time

Filter by the order processedAt field.

Example:

  • processed_at:2021-01-01T00:00:00Z
Anchor to 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.

Example:

  • reference_location_id:123
Anchor to return_status
•
string

Filter by the order's return status.

Valid values:

  • return_requested
  • in_progress
  • inspection_complete
  • returned
  • return_failed
  • no_return

Example:

  • return_status:in_progress
Anchor to risk_level
•
string

Filter by the order risk assessment riskLevel field.

Valid values:

  • high
  • medium
  • low
  • none
  • pending

Example:

  • risk_level:high
Anchor to sales_channel
•
string

Filter by the sales channel that the order is attributed to.

Example:

  • sales_channel: some_sales_channel
Anchor to sku
•
string

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

Example:

  • sku:ABC123
Anchor to 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.

Example:

  • source_identifier:1234-12-1000
Anchor to source_name
•
string

Filter by the name of the originating platform that's associated with the checkout for the order.

Example:

  • source_name:web
  • source_name:shopify_draft_order
Anchor to status
•
string

Filter by the order status.

Valid values:

  • open
  • closed
  • cancelled
  • not_closed

Example:

  • status:open
Anchor to subtotal_line_items_quantity
•
string
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 test
•
boolean

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

Example:

  • test:true
Anchor to updated_at
•
time

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

Example:

  • updated_at:2020-10-21T23:39:20Z
  • updated_at:<now
  • updated_at:<=2024
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?