# abandonedCheckouts - admin-graphql - QUERY Version: 2024-10 ## Description List of abandoned checkouts. Includes checkouts that were recovered after being abandoned. ### Access Scopes ## Arguments * [after](/docs/api/admin-graphql/2024-10/scalars/String): String - The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * [before](/docs/api/admin-graphql/2024-10/scalars/String): String - The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * [first](/docs/api/admin-graphql/2024-10/scalars/Int): Int - The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * [last](/docs/api/admin-graphql/2024-10/scalars/Int): Int - The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * [query](/docs/api/admin-graphql/2024-10/scalars/String): 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`
- `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`
- `id:>=1234`
- `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). * [reverse](/docs/api/admin-graphql/2024-10/scalars/Boolean): Boolean - Reverse the order of the underlying list. * [savedSearchId](/docs/api/admin-graphql/2024-10/scalars/ID): ID - The ID of a [saved search](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch#field-id). The search’s query string is used as the query argument. * [sortKey](/docs/api/admin-graphql/2024-10/enums/AbandonedCheckoutSortKeys): AbandonedCheckoutSortKeys - Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations). ## Returns * [edges](/docs/api/admin-graphql/2024-10/objects/AbandonedCheckoutEdge): AbandonedCheckoutEdge! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node. * [nodes](/docs/api/admin-graphql/2024-10/objects/AbandonedCheckout): AbandonedCheckout! A list of nodes that are contained in AbandonedCheckoutEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve. * [pageInfo](/docs/api/admin-graphql/2024-10/objects/PageInfo): PageInfo! An object that’s used to retrieve [cursor information](https://shopify.dev/api/usage/pagination-graphql) about the current page. ## Examples ### Retrieves a list of abandoned 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 AbandonedCheckouts { abandonedCheckouts(first: 1) { nodes { abandonedCheckoutUrl billingAddress { country } completedAt createdAt customer { firstName lastName email } id shippingAddress { country } updatedAt } } }\"\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query AbandonedCheckouts {\n abandonedCheckouts(first: 1) {\n nodes {\n abandonedCheckoutUrl\n billingAddress {\n country\n }\n completedAt\n createdAt\n customer {\n firstName\n lastName\n email\n }\n id\n shippingAddress {\n country\n }\n updatedAt\n }\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 AbandonedCheckouts {\n abandonedCheckouts(first: 1) {\n nodes {\n abandonedCheckoutUrl\n billingAddress {\n country\n }\n completedAt\n createdAt\n customer {\n firstName\n lastName\n email\n }\n id\n shippingAddress {\n country\n }\n updatedAt\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query AbandonedCheckouts {\n abandonedCheckouts(first: 1) {\n nodes {\n abandonedCheckoutUrl\n billingAddress {\n country\n }\n completedAt\n createdAt\n customer {\n firstName\n lastName\n email\n }\n id\n shippingAddress {\n country\n }\n updatedAt\n }\n }\n }`,\n);\n\nconst data = await response.json();\n" Graphql query: "query AbandonedCheckouts {\n abandonedCheckouts(first: 1) {\n nodes {\n abandonedCheckoutUrl\n billingAddress {\n country\n }\n completedAt\n createdAt\n customer {\n firstName\n lastName\n email\n }\n id\n shippingAddress {\n country\n }\n updatedAt\n }\n }\n}" #### Graphql Input null #### Graphql Response { "data": { "abandonedCheckouts": { "nodes": [ { "abandonedCheckoutUrl": "https://www.snowdevil.ca/26371970/checkouts/ac/cart_token_k23sabns3/recover?key=secret_token_i23kd8f88&locale=en", "billingAddress": { "country": "Canada" }, "completedAt": null, "createdAt": "2125-07-31T15:57:11Z", "customer": { "firstName": "Bob", "lastName": "Bobsen", "email": "bob@example.com" }, "id": "gid://shopify/AbandonedCheckout/123", "shippingAddress": { "country": "Canada" }, "updatedAt": "2125-07-31T15:57:11Z" } ] } } }