abandonedCheckouts
List of abandoned checkouts. Includes checkouts that were recovered after being abandoned.
AbandonedCheckoutConnection arguments
- Anchor to afterafter•
The elements that come after the specified cursor.
- Anchor to beforebefore•
The elements that come before the specified cursor.
- Anchor to firstfirst•
The first
n
elements from the paginated list.- Anchor to lastlast•
The last
n
elements from the paginated list.- Anchor to queryquery•
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.
query=Bob Norman
query=title:green hoodie
- 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
value. Possible values:
sent
,,
scheduled
andsuppressed
.- Anchor to recovery_state•string
Possible values:
recovered
and.
- Anchor to status•string
Possible values:
open
andclosed
.- Anchor to updated_at•time
The date and time (in ISO 8601 format) when the abandoned cart was last updated.
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to savedSearchIdsaved•
Search Id The ID of a saved search. The search’s query string is used as the query argument.
- Anchor to sortKeysort•
Key AbandonedCheckout Default:IDSort Keys 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.
Anchor to Possible returnsPossible returns
- Anchor to edgesedges•[Abandoned
Checkout non-nullEdge!]! The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
- Anchor to nodesnodes•[Abandoned
Checkout!]! non-null 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.
- Anchor to pageInfopage•
Info PageInfo! non-null An object that’s used to retrieve cursor information about the current page.
Retrieves a list of abandoned checkouts
query AbandonedCheckouts {
abandonedCheckouts(first: 1) {
nodes {
abandonedCheckoutUrl
billingAddress {
country
}
completedAt
createdAt
customer {
firstName
lastName
email
}
id
shippingAddress {
country
}
updatedAt
}
}
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query AbandonedCheckouts { abandonedCheckouts(first: 1) { nodes { abandonedCheckoutUrl billingAddress { country } completedAt createdAt customer { firstName lastName email } id shippingAddress { country } updatedAt } } }"
}'
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
query AbandonedCheckouts {
abandonedCheckouts(first: 1) {
nodes {
abandonedCheckoutUrl
billingAddress {
country
}
completedAt
createdAt
customer {
firstName
lastName
email
}
id
shippingAddress {
country
}
updatedAt
}
}
}`,
);
const data = await response.json();
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: `query AbandonedCheckouts {
abandonedCheckouts(first: 1) {
nodes {
abandonedCheckoutUrl
billingAddress {
country
}
completedAt
createdAt
customer {
firstName
lastName
email
}
id
shippingAddress {
country
}
updatedAt
}
}
}`,
});
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 AbandonedCheckouts {
abandonedCheckouts(first: 1) {
nodes {
abandonedCheckoutUrl
billingAddress {
country
}
completedAt
createdAt
customer {
firstName
lastName
email
}
id
shippingAddress {
country
}
updatedAt
}
}
}
QUERY
response = client.query(query: query)