Skip to main content

​
📘 Overview

When a checkout is considered “abandoned,” the system captures the cart state, user details, and sends this information to configured external endpoints. This allows for automated recovery campaigns (e.g., via email or WhatsApp) with thrid party apps..

​
🚀 Webhook Payload (JSON)

​
Field Specifications

FieldTypeDescription
checkout_urlstringThe direct URL to resume the checkout session.
variantsarrayList of items left in the cart.
phonestringCustomer’s primary phone number.
user_detailsobjectContains name, email, and country.
shop_idstringThe unique identifier of the merchant store.
order_idint64The internal ID of the abandoned order/session.
addressobjectComprehensive shipping/billing address details.

​
Sample Payload

{
  "checkout_url": "https://quick.paytring.com/.......",
  "variants": [
    {
      "vairant_id": "987654321",
      "title": "Breeze Premium T-Shirt",
      "price": "999.00",
      "image_url": "https://cdn.example.com/item.jpg",
      "quantity": 1
    }
  ],
  "phone": "+919999999999",
  "user_details": {
    "name": "Jane Doe",
    "email": "[email protected]",
    "country": "IN"
  },
  "shop_id": "breeze-store",
  "order_id": 554433
}

​
🛠️ Testing with CURL

You can test your server’s endpoint using the following command: 
curl -X POST https://your-webhook-receiver.com/abandoned \
-H "Content-Type: application/json" \
-d '{
  "checkout_url": "https://quick.paytring.com/",
  "variants": [{"vairant_id": "123", "title": "Test Product", "price": "10.00", "quantity": 1}],
  "shop_id": "test-shop",
  "user_details": {"name": "Test User", "email": "[email protected]"}
}'