Skip to main content
Anchor to draftOrdersCount

draftOrdersCount

query

Requires read_draft_orders access scope.

Returns the number of draft orders that match the query. Limited to a maximum of 10000 by default.

Anchor to Arguments

Arguments

Anchor to limitlimit
•Int
Default:10000

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

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 created_at
•time
Anchor to customer_id
•id
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to ids
•string
Anchor to source
•string
Anchor to status
•string
Anchor to tag
•string
Anchor to updated_at
•time
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?