Abandonment - admin-graphql - OBJECT

Version: 2024-10

Description:

A browse, cart, or checkout that was abandoned by a customer.

Access Scopes

Fields

  • abandonedCheckoutPayload: AbandonedCheckout - The abandonment payload for the abandoned checkout.
  • abandonmentType: AbandonmentAbandonmentType! - The abandonment type.
  • app: App! - The app associated with an abandoned checkout.
  • cartUrl: URL - Permalink to the cart page.
  • createdAt: DateTime! - The date and time when the abandonment was created.
  • customer: Customer! - The customer who abandoned this event.
  • customerHasNoDraftOrderSinceAbandonment: Boolean! - Whether the customer has a draft order since this abandonment has been abandoned.
  • customerHasNoOrderSinceAbandonment: Boolean! - Whether the customer has completed an order since this checkout has been abandoned.
  • daysSinceLastAbandonmentEmail: Int! - The number of days since the last abandonment email was sent to the customer.
  • emailSentAt: DateTime - When the email was sent, if that's the case.
  • emailState: AbandonmentEmailState - The email state (e.g., sent or not sent).
  • hoursSinceLastAbandonedCheckout: Float - The number of hours since the customer has last abandoned a checkout.
  • id: ID! - A globally-unique ID.
  • inventoryAvailable: Boolean! - Whether the products in abandonment are available.
  • isFromCustomStorefront: Boolean! - Whether the abandonment event comes from a custom storefront channel.
  • isFromOnlineStore: Boolean! - Whether the abandonment event comes from the Online Store sales channel.
  • isFromShopApp: Boolean! - Whether the abandonment event comes from the Shop app sales channel.
  • isFromShopPay: Boolean! - Whether the abandonment event comes from Shop Pay.
  • isMostSignificantAbandonment: Boolean! - Whether the customer didn't complete another most significant step since this abandonment.
  • lastBrowseAbandonmentDate: DateTime! - The date for the latest browse abandonment.
  • lastCartAbandonmentDate: DateTime! - The date for the latest cart abandonment.
  • lastCheckoutAbandonmentDate: DateTime! - The date for the latest checkout abandonment.
  • mostRecentStep: AbandonmentAbandonmentType! - The most recent step type.
  • visitStartedAt: DateTime - The date and time when the visit started.

Connections

  • productsAddedToCart: CustomerVisitProductInfoConnection!
  • productsViewed: CustomerVisitProductInfoConnection!

Related queries

  • abandonment Returns an abandonment by ID.
  • abandonmentByAbandonedCheckoutId Returns an Abandonment by the Abandoned Checkout ID.

Related mutations

  • abandonmentEmailStateUpdate Updates the email state value for an abandonment.
  • abandonmentUpdateActivitiesDeliveryStatuses Updates the marketing activities delivery statuses for an abandonment.

Related Unions

Examples