abandonedCheckoutsCount - admin-graphql - QUERY

Version: 2024-10

Description:

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

Access Scopes

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

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`<br/> - `query=title:green hoodie` | | created_at | time | The date and time (in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the abandoned cart was created. | | email_state | string | Filter by `abandoned_email_state` value. Possible values: `sent`, `not_sent`, `scheduled` and `suppressed`. | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | recovery_state | string | Possible values: `recovered` and `not_recovered`. | | status | string | Possible values: `open` and `closed`. | | updated_at | time | The date and time (in [ISO 8601 format](http://en.wikipedia.org/wiki/ISO_8601)) when the abandoned cart was last updated. | 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.

Returns

• count: Int! The count of elements.
• precision: CountPrecision! The count's precision, or the exactness of the value.

Examples

• Retrieves a count of checkouts

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query AbandonedCheckoutsCount { abandonedCheckoutsCount(limit: 1000) { count precision } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query AbandonedCheckoutsCount {\n    abandonedCheckoutsCount(limit: 1000) {\n      count\n      precision\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query AbandonedCheckoutsCount {\n    abandonedCheckoutsCount(limit: 1000) {\n      count\n      precision\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query AbandonedCheckoutsCount {\n    abandonedCheckoutsCount(limit: 1000) {\n      count\n      precision\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query AbandonedCheckoutsCount {\n    abandonedCheckoutsCount(limit: 1000) {\n      count\n      precision\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query AbandonedCheckoutsCount {\n  abandonedCheckoutsCount(limit: 1000) {\n    count\n    precision\n  }\n}"
        

  input: null

  response: {
    "data": {
      "abandonedCheckoutsCount": {
        "count": 38,
        "precision": "EXACT"
      }
    }
  }