Abandoned
Requires access scope. Also: The user must have manage_abandoned_checkouts permission.
An incomplete checkout where the customer added items and provided contact information but didn't complete the purchase. Tracks the customer's cart contents, pricing details, addresses, and timestamps to enable recovery campaigns and abandonment analytics.
The checkout includes a recovery URL that merchants can send to customers to resume their purchase. objects preserve the original Product selections, quantities, and pricing at the time of abandonment.
Anchor to FieldsFields
- abandonedCheckoutUrl (URL!)
- billingAddress (MailingAddress)
- completedAt (DateTime)
- createdAt (DateTime!)
- customAttributes ([Attribute!]!)
- customer (Customer)
- defaultCursor (String!)
- discountCodes ([String!]!)
- id (ID!)
- lineItems (AbandonedCheckoutLineItemConnection!)
- name (String!)
- note (String!)
- shippingAddress (MailingAddress)
- subtotalPriceSet (MoneyBag!)
- taxesIncluded (Boolean!)
- taxLines ([TaxLine!]!)
- totalDiscountSet (MoneyBag!)
- totalDutiesSet (MoneyBag)
- totalLineItemsPriceSet (MoneyBag!)
- totalPriceSet (MoneyBag!)
- totalTaxSet (MoneyBag)
- updatedAt (DateTime!)
- lineItemsQuantity (Int!): deprecated
- Anchor to abandonedCheckoutUrlabandoned•URL!
Checkout Url non-null The URL for the buyer to recover their checkout.
- Anchor to billingAddressbilling•Mailing
Address Address The billing address provided by the buyer. Null if the user did not provide a billing address.
- Anchor to completedAtcompleted•Date
At Time The date and time when the buyer completed the checkout. Null if the checkout has not been completed.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the checkout was created.
- Anchor to customAttributescustom•[Attribute!]!
Attributes non-null A list of extra information that has been added to the checkout.
- Anchor to customercustomer•Customer
The customer who created this checkout. May be null if the checkout was created from a draft order or via an app.
- Anchor to defaultCursordefault•String!
Cursor non-null A default cursor that returns the single next record, sorted ascending by ID.
- Anchor to discountCodesdiscount•[String!]!
Codes non-null The discount codes entered by the buyer at checkout.
- •ID!non-null
A globally-unique ID.
- Anchor to lineItemsline•Abandoned
Items Checkout Line Item Connection! non-null A list of the line items in this checkout.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to namename•String!non-null
Unique merchant-facing identifier for the checkout.
- Anchor to notenote•String!non-null
A merchant-facing note added to the checkout. Not visible to the buyer.
- Anchor to shippingAddressshipping•Mailing
Address Address The shipping address to where the line items will be shipped. Null if the user did not provide a shipping address.
- Anchor to subtotalPriceSetsubtotal•Money
Price Set Bag! non-null The sum of all items in the checkout, including discounts but excluding shipping, taxes and tips.
- Anchor to taxesIncludedtaxes•Boolean!
Included non-null Whether taxes are included in line item and shipping line prices.
- Anchor to taxLinestax•[Tax
Lines Line!]! non-null Individual taxes charged on the checkout.
- Anchor to totalDiscountSettotal•Money
Discount Set Bag! non-null The total amount of discounts to be applied.
- Anchor to totalDutiesSettotal•Money
Duties Set Bag The total duties applied to the checkout.
- Anchor to totalLineItemsPriceSettotal•Money
Line Items Price Set Bag! non-null The sum of the prices of all line items in the checkout.
- Anchor to totalPriceSettotal•Money
Price Set Bag! non-null The sum of all items in the checkout, including discounts, shipping, taxes, and tips.
- Anchor to totalTaxSettotal•Money
Tax Set Bag The total tax applied to the checkout.
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the checkout was most recently updated.
- Anchor to lineItemsQuantityline•Int!
Items Quantity non-nullDeprecated
Anchor to QueriesQueries
- abandonedCheckouts (AbandonedCheckoutConnection!)
- •query
Returns a list of abandoned checkouts. A checkout is considered abandoned when a customer adds contact information but doesn't complete their purchase. Includes both abandoned and recovered checkouts.
Each checkout provides
Customerdetails,objects, pricing information, and a recovery URL for re-engaging customers who didn't complete their purchase.- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Abandoned
Key Checkout Sort Keys Default:ID 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 queryquery•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.
query=Bob Normanquery=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,,scheduledandsuppressed.- Anchor to recovery_state•string
Possible values:
recoveredand.- Anchor to status•string
Possible values:
openandclosed.- Anchor to updated_at•time
The date and time (in ISO 8601 format) when the abandoned cart was last updated.
Example:
- Anchor to savedSearchIdsaved•ID
Search Id The ID of a saved search. The search’s query string is used as the query argument.
Arguments