abandonedCheckoutsCount

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

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the abandonedCheckoutsCount action (under Abandoned).
Fill in the fields below, then reference the result from later steps as {{abandonedcheckoutscount.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query AbandonedCheckoutsCount($query: String, $savedSearchId: ID, $limit: Int) {
  abandonedCheckoutsCount(
    query: $query
    savedSearchId: $savedSearchId
    limit: $limit
  ) {
    count
    precision
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

querystring

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).

savedSearchIdstring

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.

limitnumber

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

json

{
  "query": "string",
  "savedSearchId": "string",
  "limit": 0
}

Response

Read the result with {{abandonedcheckoutscount.response.data.data.abandonedCheckoutsCount}}. If the API returns errors, the step fails and they are at {{abandonedcheckoutscount.response.data.errors}}.

countnumber

precisionstring

One ofEXACTAT_LEAST

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?