Abandoned Cart Recovery

{
  "cart_items": [
    {
      "image": "https://cdn.shopify.com/s/files/1/0598/4564/0276/files/wallnut_brownie_1st_slide.jpg?v=1745323290",
      "title": "400gms / Gluten-Free",
      "discount": 0,
      "price": 630,
      "quantity": 1,
      "variant": {
        "title": "400gms / Gluten-Free",
        "price": 630,
        "variant_id": 41564857663572,
        "compare_at_price": 700
      },
      "product_id": 7516974022740,
      "variant_id": 41564857663572,
      "grams": 0,
      "handle": "gluten-free-double-chocochunk-walnut",
      "total_price": 630,
      "sub_total_price": 630,
      "total_discount": 0,
      "single_variant": false
    }
  ],
  "checkout_url": "https://flexype.myshopify.com/?flx_s=331d47df-8461-495b-9c4f-27ed915d9c8e",
  "discount": 0,
  "total_payable": 630,
  "session_state": "ADDRESS_LOADED",
  "user": {
    "phone_no": "7777788888",
    "dial_code": "91",
    "address": {
      "address1": "A-11, Shakti Bhawan, Sailesh Vihar",
      "address2": "",
      "city": "Vadodara",
      "state": "Gujarat",
      "country": "India",
      "state_code": "GJ",
      "country_code": "IN",
      "postal_code": "391101"
    }
  },
  "store_link": "flexype.myshopify.com",
  "client_meta": {
    "client_ip": "1.1.1.1",
    "http_referer": "https://flexype.io",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/137.0.0.0 Safari/537.36"
  },
  "analytics": {
    "fb": {
      "fbc": "fb.1.1718171818181.1234567890",
      "fbp": "fb.1.1749629739196.52545909099157380"
    }
  },
  "metadata": {
    "utm": [
      {
        "name": "utm_source",
        "value": "Facebook_Mobile_Reels"
      },
      {
        "name": "utm_medium",
        "value": "Paid_Social"
      },
      {
        "name": "utm_campaign",
        "value": "SM_ToF_LuxuryTravel_MR28"
      },
      {
        "name": "utm_content",
        "value": "Video_THR&Q8"
      },
      {
        "name": "fbclid",
        "value": "IwZXh0bgNhZW0BMABhZGlkAasXP1Yg-jsBHsxu8sksf9L0IDtCbKwAtTELSmrMY-_SHwn507QuXkncpBXofqJes75cFFxX_aem_0HVwkeACTbIb2G8E87P0Xw"
      },
      {
        "name": "utm_term",
        "value": "120215375448050395"
      }
    ],
    "orig_referer": "https://www.google.com",
    "referer_host": "www.google.com",
    "landing_page": "/"
  }
}

{
  "cart_items": [
    {
      "image": "https://cdn.shopify.com/s/files/1/0598/4564/0276/files/wallnut_brownie_1st_slide.jpg?v=1745323290",
      "title": "400gms / Gluten-Free",
      "discount": 0,
      "price": 630,
      "quantity": 1,
      "variant": {
        "title": "400gms / Gluten-Free",
        "price": 630,
        "variant_id": 41564857663572,
        "compare_at_price": 700
      },
      "product_id": 7516974022740,
      "variant_id": 41564857663572,
      "grams": 0,
      "handle": "gluten-free-double-chocochunk-walnut",
      "total_price": 630,
      "sub_total_price": 630,
      "total_discount": 0,
      "single_variant": false
    }
  ],
  "checkout_url": "https://flexype.myshopify.com/?flx_s=331d47df-8461-495b-9c4f-27ed915d9c8e",
  "discount": 0,
  "total_payable": 630,
  "session_state": "ADDRESS_LOADED",
  "user": {
    "phone_no": "7777788888",
    "dial_code": "91",
    "address": {
      "address1": "A-11, Shakti Bhawan, Sailesh Vihar",
      "address2": "",
      "city": "Vadodara",
      "state": "Gujarat",
      "country": "India",
      "state_code": "GJ",
      "country_code": "IN",
      "postal_code": "391101"
    }
  },
  "store_link": "flexype.myshopify.com",
  "client_meta": {
    "client_ip": "1.1.1.1",
    "http_referer": "https://flexype.io",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/137.0.0.0 Safari/537.36"
  },
  "analytics": {
    "fb": {
      "fbc": "fb.1.1718171818181.1234567890",
      "fbp": "fb.1.1749629739196.52545909099157380"
    }
  },
  "metadata": {
    "utm": [
      {
        "name": "utm_source",
        "value": "Facebook_Mobile_Reels"
      },
      {
        "name": "utm_medium",
        "value": "Paid_Social"
      },
      {
        "name": "utm_campaign",
        "value": "SM_ToF_LuxuryTravel_MR28"
      },
      {
        "name": "utm_content",
        "value": "Video_THR&Q8"
      },
      {
        "name": "fbclid",
        "value": "IwZXh0bgNhZW0BMABhZGlkAasXP1Yg-jsBHsxu8sksf9L0IDtCbKwAtTELSmrMY-_SHwn507QuXkncpBXofqJes75cFFxX_aem_0HVwkeACTbIb2G8E87P0Xw"
      },
      {
        "name": "utm_term",
        "value": "120215375448050395"
      }
    ],
    "orig_referer": "https://www.google.com",
    "referer_host": "www.google.com",
    "landing_page": "/"
  }
}

The Abandoned Cart Recovery Webhook is triggered whenever a cart session is created or updated. It facilitates real-time synchronization of cart data with external systems, enabling accurate tracking of active shopping sessions. This webhook plays a vital role in identifying potential cart abandonment scenarios and allows businesses to automate recovery actions such as follow-up emails, whatsapp messages, personalized notifications, or remarketing efforts. By leveraging this integration, brands can engage customers at the right moment and significantly improve cart conversion rates.

Headers

X-Flexype-Authorization

string

A secret key used to verify that the webhook request originated from FlexyPe. Ensure this token is validated to prevent unauthorized access.

Body

cart_items

array

List of products currently added to the user’s cart at the time of checkout.

Show Item Properties

image

string

URL of the product image displayed to the user during checkout.

title

string

Title describing the selected product variant.

discount

number

default:"0"

The discount amount applied to the item, in the store’s currency.

price

number

The price per unit of the item after applying any discounts.

quantity

number

The number of units of the product added to the cart.

variant

object

Detailed information about the specific product variant selected.

Show Variant Properties

title

string

Descriptive label of the selected variant.

price

number

Price of the specific variant of the product.

variant_id

number

Unique identifier assigned to this variant in Shopify.

compare_at_price

number

The original price before discounts — shown as strikethrough on the UI.

product_id

number

Unique identifier for the base product in Shopify.

variant_id

number

ID of the variant selected, same as variant.variant_id (duplicated for convenience).

grams

number

default:"0"

Weight of the product variant in grams. Useful for shipping calculations.

handle

string

The URL-friendly handle of the product, used in Shopify product URLs.

total_price

number

Total payable price for this item, calculated as price × quantity.

sub_total_price

number

Total price for the item before any discounts are applied.

total_discount

number

Cumulative discount applied to the item (if any).

single_variant

boolean

default:"false"

Indicates whether the product has only one variant available (true/false).

checkout_url

string

URL to redirect the user to FlexyPe Checkout.

discount

number

default:"0"

The total discount applied to the entire cart, in the store’s currency.

total_payable

number

The final amount the user has to pay after discounts and calculations.

session_state

string

The current status of the checkout session. This field reflects which step the user is on during their cart journey.Possible values:

INITIATED: Cart session has been created but no user input has been provided.
PHONE_ENTERED: User has entered a phone number.
OTP_VERIFIED: User has successfully verified the OTP.
ADDRESS_LOADED: Address screen has been rendered or prefilled.
ADDRESS_SHIPPING_SELECTED: Shipping method has been selected after address submission.
PAYMENT_LOADED: Payment screen has been rendered.
PAYMENT_INITIATED: Payment has been initiated by the user.
COMPLETED: Order has been successfully completed.

user

User Object

Show properties

phone_no

string

The customer’s phone number used during checkout.

dial_code

string

The country code associated with the user’s phone number.

name

string

The customer’s name used during checkout.

string

The customer’s email used during checkout.

address

object

An object representing the user’s address based on session_state

Show Address Properties

address1

string

Primary address line, typically containing street name, building number, or apartment name.

address2

string

(Optional) Secondary address line, such as apartment number, suite, or additional details.

city

string

The city or locality of the user’s shipping or billing address.

state

string

Full name of the state or province associated with the address.

country

string

Full name of the country (e.g: “India”).

state_code

string

ISO 3166-2 code for the state (e.g: “GJ” for Gujarat).

country_code

string

ISO 3166-1 alpha-2 code for the country (e.g: “IN” for India).

postal_code

string

Postal or ZIP code corresponding to the address.

store_link

string

The Shopify domain/subdomain for the merchant store.

client_meta

ClientMeta Object

Metadata about the client’s device and request.

Show properties

client_ip

string

IP address of the client at the time of checkout initiation.

http_referer

string

Referring URL from which the user was directed to the store.

user_agent

string

User agent string from the user’s browser or device.

analytics

Analytics Object

Data related to marketing and tracking attribution.

Show properties

fb.fbc

string

Facebook Click ID (FBC) used for ad tracking. May be empty if unavailable.

fb.fbp

string

Facebook browser ID (FBP) for retargeting and attribution.

metadata

Metadata Object

Metadata captured from the user’s landing page and original source. This is typically used for attribution, analytics, and campaign performance tracking.

Show properties

utm

array

An array of key–value pairs representing UTM and tracking parameters passed in the landing page URL.Allowed keys:

fbclid: Facebook Click ID
gclid: Google Ads Click Identifier
utm_medium: Type of marketing channel
utm_source: Origin platform
utm_campaign: Campaign name or identifier
utm_content: Specific content or creative used
utm_term: Paid search keyword or targeting term

Show UTM Parameter Properties

name

string

One of the allowed analytics parameter keys listed above.

value

string

The value associated with the given analytics parameter.

orig_referer

string

The original referrer URL from which the user landed on the store.

referer_host

string

The host domain extracted from the original referrer URL.

landing_page

string

The specific page path on the store where the user first landed.

{
  "cart_items": [
    {
      "image": "https://cdn.shopify.com/s/files/1/0598/4564/0276/files/wallnut_brownie_1st_slide.jpg?v=1745323290",
      "title": "400gms / Gluten-Free",
      "discount": 0,
      "price": 630,
      "quantity": 1,
      "variant": {
        "title": "400gms / Gluten-Free",
        "price": 630,
        "variant_id": 41564857663572,
        "compare_at_price": 700
      },
      "product_id": 7516974022740,
      "variant_id": 41564857663572,
      "grams": 0,
      "handle": "gluten-free-double-chocochunk-walnut",
      "total_price": 630,
      "sub_total_price": 630,
      "total_discount": 0,
      "single_variant": false
    }
  ],
  "checkout_url": "https://flexype.myshopify.com/?flx_s=331d47df-8461-495b-9c4f-27ed915d9c8e",
  "discount": 0,
  "total_payable": 630,
  "session_state": "ADDRESS_LOADED",
  "user": {
    "phone_no": "7777788888",
    "dial_code": "91",
    "address": {
      "address1": "A-11, Shakti Bhawan, Sailesh Vihar",
      "address2": "",
      "city": "Vadodara",
      "state": "Gujarat",
      "country": "India",
      "state_code": "GJ",
      "country_code": "IN",
      "postal_code": "391101"
    }
  },
  "store_link": "flexype.myshopify.com",
  "client_meta": {
    "client_ip": "1.1.1.1",
    "http_referer": "https://flexype.io",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/137.0.0.0 Safari/537.36"
  },
  "analytics": {
    "fb": {
      "fbc": "fb.1.1718171818181.1234567890",
      "fbp": "fb.1.1749629739196.52545909099157380"
    }
  },
  "metadata": {
    "utm": [
      {
        "name": "utm_source",
        "value": "Facebook_Mobile_Reels"
      },
      {
        "name": "utm_medium",
        "value": "Paid_Social"
      },
      {
        "name": "utm_campaign",
        "value": "SM_ToF_LuxuryTravel_MR28"
      },
      {
        "name": "utm_content",
        "value": "Video_THR&Q8"
      },
      {
        "name": "fbclid",
        "value": "IwZXh0bgNhZW0BMABhZGlkAasXP1Yg-jsBHsxu8sksf9L0IDtCbKwAtTELSmrMY-_SHwn507QuXkncpBXofqJes75cFFxX_aem_0HVwkeACTbIb2G8E87P0Xw"
      },
      {
        "name": "utm_term",
        "value": "120215375448050395"
      }
    ],
    "orig_referer": "https://www.google.com",
    "referer_host": "www.google.com",
    "landing_page": "/"
  }
}

Google Analytics

⌘I

Get Started

Integrations

Webhooks

Abandoned Cart Recovery

Headers

Body

Get Started

Integrations

Webhooks

​Headers

​Body

Headers

Body