younifyd
Menu

abandonment

Returns a `Abandonment` resource by ID.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the abandonment action (under Abandonment).
  3. Fill in the fields below, then reference the result from later steps as {{abandonment.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql
query Abandonment($id: ID!) {
  abandonment(id: $id) {
    abandonedCheckoutPayload {
      abandonedCheckoutUrl
      billingAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        timeZone
        validationResultSummary
        zip
      }
      completedAt
      createdAt
      customAttributes {
        key
        value
      }
      customer {
        amountSpent
        canDelete
        companyContactProfiles
        createdAt
        dataSaleOptOut
        defaultAddress
        defaultEmailAddress
        defaultPhoneNumber
        displayName
        email
        emailMarketingConsent
        firstName
        hasTimelineComment
        id
        identityProviderSubjects
        lastName
        lastOrder
        legacyResourceId
        lifetimeDuration
        locale
        market
        mergeable
        multipassIdentifier
        note
        numberOfOrders
        phone
        productSubscriberStatus
        smsMarketingConsent
        state
        statistics
        tags
        taxExempt
        taxExemptions
        taxSettings
        unsubscribeUrl
        updatedAt
        validEmailAddress
        verifiedEmail
      }
      defaultCursor
      discountCodes
      id
      lineItemsQuantity
      name
      note
      shippingAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        timeZone
        validationResultSummary
        zip
      }
      subtotalPriceSet {
        presentmentMoney
        shopMoney
      }
      taxLines {
        channelLiable
        price
        priceSet
        rate
        ratePercentage
        source
        title
      }
      taxesIncluded
      totalDiscountSet {
        presentmentMoney
        shopMoney
      }
      totalDutiesSet {
        presentmentMoney
        shopMoney
      }
      totalLineItemsPriceSet {
        presentmentMoney
        shopMoney
      }
      totalPriceSet {
        presentmentMoney
        shopMoney
      }
      totalTaxSet {
        presentmentMoney
        shopMoney
      }
      updatedAt
    }
    abandonmentType
    app {
      apiKey
      appStoreAppUrl
      appStoreDeveloperUrl
      availableAccessScopes {
        description
        handle
      }
      banner {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      description
      developerName
      developerType
      developerUrl
      embedded
      failedRequirements {
        action
        message
      }
      features
      feedback {
        app
        channel
        feedbackGeneratedAt
        link
        messages
        state
      }
      handle
      icon {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      id
      installUrl
      installation {
        accessScopes
        activeSubscriptions
        app
        channel
        id
        launchUrl
        publication
        subscriptions
        uninstallUrl
      }
      isPostPurchaseAppInUse
      launchUrl
      navigationItems {
        id
        title
        url
      }
      optionalAccessScopes {
        description
        handle
      }
      previouslyInstalled
      pricingDetails
      pricingDetailsSummary
      privacyPolicyUrl
      publicCategory
      published
      requestedAccessScopes {
        description
        handle
      }
      screenshots {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      shopifyDeveloped
      title
      uninstallMessage
      uninstallUrl
      webhookApiVersion
    }
    cartUrl
    createdAt
    customer {
      amountSpent {
        amount
        currencyCode
      }
      canDelete
      companyContactProfiles {
        company
        createdAt
        customer
        id
        isMainContact
        lifetimeDuration
        locale
        title
        updatedAt
      }
      createdAt
      dataSaleOptOut
      defaultAddress {
        address1
        address2
        city
        company
        coordinatesValidated
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        timeZone
        validationResultSummary
        zip
      }
      defaultEmailAddress {
        emailAddress
        marketingOptInLevel
        marketingState
        marketingUnsubscribeUrl
        marketingUpdatedAt
        openTrackingLevel
        openTrackingUrl
        sourceLocation
        validFormat
      }
      defaultPhoneNumber {
        marketingCollectedFrom
        marketingOptInLevel
        marketingState
        marketingUpdatedAt
        phoneNumber
        sourceLocation
        whatsAppMarketingConsent
      }
      displayName
      email
      emailMarketingConsent {
        consentUpdatedAt
        marketingOptInLevel
        marketingState
        sourceLocation
      }
      firstName
      hasTimelineComment
      id
      identityProviderSubjects {
        createdAt
        id
        providerName
        subject
        updatedAt
      }
      lastName
      lastOrder {
        additionalFees
        alerts
        app
        attribution
        billingAddress
        billingAddressMatchesShippingAddress
        canMarkAsPaid
        canNotifyCustomer
        cancelReason
        cancellation
        cancelledAt
        capturable
        cartDiscountAmount
        cartDiscountAmountSet
        cartToken
        channel
        channelInformation
        checkoutToken
        clientIp
        closed
        closedAt
        confirmationNumber
        confirmed
        createdAt
        currencyCode
        currentCartDiscountAmountSet
        currentShippingPriceSet
        currentSubtotalLineItemsQuantity
        currentSubtotalPriceSet
        currentTaxLines
        currentTotalAdditionalFeesSet
        currentTotalDiscountsSet
        currentTotalDutiesSet
        currentTotalPriceSet
        currentTotalTaxSet
        currentTotalWeight
        customAttributes
        customer
        customerAcceptsMarketing
        customerJourney
        customerJourneySummary
        customerLocale
        discountCode
        discountCodes
        displayAddress
        displayFinancialStatus
        displayFulfillmentStatus
        disputes
        dutiesIncluded
        edited
        email
        estimatedTaxes
        fulfillable
        fulfillmentsCount
        fullyPaid
        hasTimelineComment
        id
        landingPageDisplayText
        landingPageUrl
        legacyResourceId
        merchantBusinessEntity
        merchantEditable
        merchantEditableErrors
        merchantOfRecordApp
        name
        netPayment
        netPaymentSet
        note
        number
        originalTotalAdditionalFeesSet
        originalTotalDutiesSet
        originalTotalPriceSet
        paymentCollectionDetails
        paymentGatewayNames
        paymentTerms
        phone
        physicalLocation
        poNumber
        presentmentCurrencyCode
        processedAt
        productNetwork
        publication
        purchasingEntity
        referralCode
        referrerDisplayText
        referrerUrl
        refundDiscrepancySet
        refundable
        registeredSourceUrl
        requiresShipping
        restockable
        retailLocation
        returnStatus
        risk
        riskLevel
        shippingAddress
        shippingLine
        shopifyProtect
        sourceIdentifier
        sourceName
        staffMember
        subtotalLineItemsQuantity
        subtotalPrice
        subtotalPriceSet
        tags
        taxExempt
        taxLines
        taxesIncluded
        test
        totalCapturable
        totalCapturableSet
        totalCashRoundingAdjustment
        totalDiscounts
        totalDiscountsSet
        totalOutstandingSet
        totalPrice
        totalPriceSet
        totalReceived
        totalReceivedSet
        totalRefunded
        totalRefundedSet
        totalRefundedShippingSet
        totalShippingPrice
        totalShippingPriceSet
        totalTax
        totalTaxSet
        totalTipReceived
        totalTipReceivedSet
        totalWeight
        transactionsCount
        unpaid
        updatedAt
      }
      legacyResourceId
      lifetimeDuration
      locale
      market {
        catalogsCount
        conditions
        currencySettings
        delivery
        discountsCount
        enabled
        handle
        id
        name
        priceInclusions
        priceList
        primary
        status
        type
        webPresence
      }
      mergeable {
        errorFields
        isMergeable
        mergeInProgress
        reason
      }
      multipassIdentifier
      note
      numberOfOrders
      phone
      productSubscriberStatus
      smsMarketingConsent {
        consentCollectedFrom
        consentUpdatedAt
        marketingOptInLevel
        marketingState
        sourceLocation
      }
      state
      statistics {
        predictedSpendTier
        rfmGroup
      }
      tags
      taxExempt
      taxExemptions
      taxSettings {
        taxId
      }
      unsubscribeUrl
      updatedAt
      validEmailAddress
      verifiedEmail
    }
    customerHasNoDraftOrderSinceAbandonment
    customerHasNoOrderSinceAbandonment
    daysSinceLastAbandonmentEmail
    emailSentAt
    emailState
    hoursSinceLastAbandonedCheckout
    id
    inventoryAvailable
    isFromCustomStorefront
    isFromOnlineStore
    isFromShopApp
    isFromShopPay
    isMostSignificantAbandonment
    lastBrowseAbandonmentDate
    lastCartAbandonmentDate
    lastCheckoutAbandonmentDate
    mostRecentStep
    visitStartedAt
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstringrequired

The ID of the `Abandonment` to return.

json
{
  "id": "string"
}

Response

Read the result with {{abandonment.response.data.data.abandonment}}. If the API returns errors, the step fails and they are at {{abandonment.response.data.errors}}.

abandonedCheckoutPayloadobject
abandonedCheckoutUrlstring
billingAddressobject21 fields
completedAtstring
createdAtstring
customAttributesarray<object>
customerobject38 fields
defaultCursorstring
discountCodesarray<object>
idstring
lineItemsQuantitynumber
namestring
notestring
shippingAddressobject21 fields
subtotalPriceSetobject2 fields
taxLinesarray<object>
taxesIncludedboolean
totalDiscountSetobject2 fields
totalDutiesSetobject2 fields
totalLineItemsPriceSetobject2 fields
totalPriceSetobject2 fields
totalTaxSetobject2 fields
updatedAtstring
abandonmentTypestring

One ofBROWSECARTCHECKOUT

appobject
apiKeystring
appStoreAppUrlstring
appStoreDeveloperUrlstring
availableAccessScopesarray<object>
bannerobject7 fields
descriptionstring
developerNamestring
developerTypestring

One ofSHOPIFYPARTNERMERCHANTUNKNOWN

developerUrlstring
embeddedboolean
failedRequirementsarray<object>
featuresarray<object>
feedbackobject6 fields
handlestring
iconobject7 fields
idstring
installUrlstring
installationobject9 fields
isPostPurchaseAppInUseboolean
launchUrlstring
navigationItemsarray<object>
optionalAccessScopesarray<object>
previouslyInstalledboolean
pricingDetailsstring
pricingDetailsSummarystring
privacyPolicyUrlstring
publicCategorystring

One ofPRIVATEPUBLICCUSTOMOTHER

publishedboolean
requestedAccessScopesarray<object>
screenshotsarray<object>
shopifyDevelopedboolean
titlestring
uninstallMessagestring
uninstallUrlstring
webhookApiVersionstring
cartUrlstring
createdAtstring
customerobject
amountSpentobject2 fields
canDeleteboolean
companyContactProfilesarray<object>
createdAtstring
dataSaleOptOutboolean
defaultAddressobject21 fields
defaultEmailAddressobject9 fields
defaultPhoneNumberobject7 fields
displayNamestring
emailstring
emailMarketingConsentobject4 fields
firstNamestring
hasTimelineCommentboolean
idstring
identityProviderSubjectsarray<object>
lastNamestring
lastOrderobject40 fields
legacyResourceIdstring
lifetimeDurationstring
localestring
marketobject15 fields
mergeableobject4 fields
multipassIdentifierstring
notestring
numberOfOrdersstring
phonestring
productSubscriberStatusstring

One ofACTIVECANCELLEDEXPIREDFAILEDNEVER_SUBSCRIBEDPAUSED

smsMarketingConsentobject5 fields
statestring

One ofDECLINEDDISABLEDENABLEDINVITED

statisticsobject2 fields
tagsarray<object>
taxExemptboolean
taxExemptionsarray<object>
taxSettingsobject1 fields
unsubscribeUrlstring
updatedAtstring
validEmailAddressboolean
verifiedEmailboolean
customerHasNoDraftOrderSinceAbandonmentboolean
customerHasNoOrderSinceAbandonmentboolean
daysSinceLastAbandonmentEmailnumber
emailSentAtstring
emailStatestring

One ofNOT_SENTSENTSCHEDULED

hoursSinceLastAbandonedCheckoutnumber
idstring
inventoryAvailableboolean
isFromCustomStorefrontboolean
isFromOnlineStoreboolean
isFromShopAppboolean
isFromShopPayboolean
isMostSignificantAbandonmentboolean
lastBrowseAbandonmentDatestring
lastCartAbandonmentDatestring
lastCheckoutAbandonmentDatestring
mostRecentStepstring

One ofBROWSECARTCHECKOUT

visitStartedAtstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.