abandonedCheckoutsCount

query

Requires read_orders access scope. Also: The user must have manage_abandoned_checkouts permission.

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

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. 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.
Anchor to created_at • time: The date and time (in ISO 8601 format) when the abandoned cart was created.
Anchor to email_state • string: Filter by abandoned_email_state value. Possible values: sent, not_sent, scheduled and suppressed.
Anchor to id • id: Filter by id range.
Anchor to recovery_state • string: Possible values: recovered and not_recovered.
Anchor to status • string: Possible values: open and closed.
Anchor to updated_at • time: The date and time (in ISO 8601 format) when the abandoned cart was last updated.

savedSearchId

•

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?

Retrieves a count of checkouts

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query AbandonedCheckoutsCount {

abandonedCheckoutsCount(limit: 1000) {

count

precision

}

}`,

);

const data = await response.json();

query AbandonedCheckoutsCount {
  abandonedCheckoutsCount(limit: 1000) {
    count
    precision
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query AbandonedCheckoutsCount { abandonedCheckoutsCount(limit: 1000) { count precision } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query AbandonedCheckoutsCount {
    abandonedCheckoutsCount(limit: 1000) {
      count
      precision
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query AbandonedCheckoutsCount {
    abandonedCheckoutsCount(limit: 1000) {
      count
      precision
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query AbandonedCheckoutsCount {
    abandonedCheckoutsCount(limit: 1000) {
      count
      precision
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"abandonedCheckoutsCount": {

"count": 38,

"precision": "EXACT"

}