AbandonedCheckout - admin-graphql - OBJECT

Version: 2025-01

Description:

A checkout that was abandoned by the customer.

Access Scopes

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

Fields

  • abandonedCheckoutUrl: URL! - The URL for the buyer to recover their checkout.
  • billingAddress: MailingAddress - The billing address provided by the buyer. Null if the user did not provide a billing address.
  • completedAt: DateTime - The date and time when the buyer completed the checkout. Null if the checkout has not been completed.
  • createdAt: DateTime! - The date and time when the checkout was created.
  • customAttributes: Attribute! - A list of extra information that has been added to the checkout.
  • customer: Customer - The customer who created this checkout. May be null if the checkout was created from a draft order or via an app.
  • defaultCursor: String! - A default [cursor](https://shopify.dev/api/usage/pagination-graphql) that returns the single next record, sorted ascending by ID.
  • discountCodes: String! - The discount codes entered by the buyer at checkout.
  • id: ID! - A globally-unique ID.
  • lineItemsQuantity: Int! - The number of products in the checkout.
  • name: String! - Unique merchant-facing identifier for the checkout.
  • note: String! - A merchant-facing note added to the checkout. Not visible to the buyer.
  • shippingAddress: MailingAddress - The shipping address to where the line items will be shipped. Null if the user did not provide a shipping address.
  • subtotalPriceSet: MoneyBag! - The sum of all items in the checkout, including discounts but excluding shipping, taxes and tips.
  • taxLines: TaxLine! - Individual taxes charged on the checkout.
  • taxesIncluded: Boolean! - Whether taxes are included in line item and shipping line prices.
  • totalDiscountSet: MoneyBag! - The total amount of discounts to be applied.
  • totalDutiesSet: MoneyBag - The total duties applied to the checkout.
  • totalLineItemsPriceSet: MoneyBag! - The sum of the prices of all line items in the checkout.
  • totalPriceSet: MoneyBag! - The sum of all items in the checkout, including discounts, shipping, taxes, and tips.
  • totalTaxSet: MoneyBag - The total tax applied to the checkout.
  • updatedAt: DateTime! - The date and time when the checkout was most recently updated.

Connections

  • lineItems: AbandonedCheckoutLineItemConnection!

Related queries

  • abandonedCheckouts List of abandoned checkouts. Includes checkouts that were recovered after being abandoned.

Related mutations

Related Unions

Examples