Attribuly API Docs
  • Introduction
  • Authentication
  • Endpoint
    • Google Looker Studio
  • API Reference
    • Event summary
    • Order: first and last touchpoint
    • Order: total conversion journey
    • The number of visitors who visited the landing page and then completed the event.
  • Common data structures
    • Customer
    • Order
    • Product
    • Event
      • Page viewed
      • Cart viewed
      • Product viewed
      • Collection viewed
      • Search submitted
      • Product added to cart
      • Product removed to cart
      • Lead form
      • Checkout started
      • Checkout address info submitted
      • Checkout contact info submitted
      • Checkout shipping info submitted
      • Payment info submitted
      • Checkout completed
Powered by GitBook
On this page

Was this helpful?

  1. Common data structures
  2. Event

Cart viewed

{
  "clientId": "Required, string type, represents the unique identifier of the client",
  "clientIp": "Required, string type, represents the IP address of the client",
  "context": "Required, please refer to the context definition in the basic structure",
  "data": {
    "cart": {
      "attributes": "Optional, array type, represents the list of cart attributes",
      "cost": {
        "totalAmount": {
          "amount": "Required, numeric type, represents the total amount",
          "currencyCode": "Required, string type, represents the currency code (e.g., HKD)"
        }
      },
      "id": "Required, string type, represents the unique identifier of the cart",
      "lines": [
        {
          "cost": {
            "totalAmount": {
              "amount": "Required, numeric type, represents the total amount for this line item",
              "currencyCode": "Required, string type, represents the currency code (e.g., HKD)"
            }
          },
          "merchandise": {
            "id": "Required, string type, represents the unique identifier of the product",
            "image": {
              "src": "Required, string type, represents the image URL"
            },
            "price": {
              "amount": "Required, numeric type, represents the unit price amount",
              "currencyCode": "Required, string type, represents the currency code (e.g., HKD)"
            },
            "product": {
              "id": "Required, string type, represents the unique identifier of the product",
              "title": "Required, string type, represents the product title",
              "type": "Optional, string type, represents the product type",
              "untranslatedTitle": "Required, string type, represents the untranslated product title",
              "url": "Required, string type, represents the product URL",
              "vendor": "Required, string type, represents the vendor name"
            },
            "sku": "Optional, string type, represents the stock keeping unit",
            "title": "Optional, string type, represents the variant title of the product",
            "untranslatedTitle": "Optional, string type, represents the untranslated variant title of the product"
          },
          "quantity": "Required, numeric type, represents the quantity of the product"
        }
      ],
      "totalQuantity": "Required, numeric type, represents the total quantity of items in the cart"
    }
  },
  "id": "Required, string type, represents the unique identifier of the event or record",
  "name": "Required, string type, represents the event name: cart_viewed",
  "seq": "Required, numeric type, represents the sequence number",
  "timestamp": "Required, string type, represents the timestamp (ISO 8601 format)",
  "type": "Required, string type, represents the form type"
}
{
  "clientId": "53C0AAA0-d993-4919-bbd1-1a2c7b66b763",
  "clientIp": "5.34.216.118",
  "context": context,
  "data": {
    "cart": {
      "attributes": [],
      "cost": {
        "totalAmount": {
          "amount": 315,
          "currencyCode": "HKD"
        }
      },
      "id": "Z2NwLWFzaWEtc291dGhlYXN0MTowMUpTRUNGOEpGTU1OQzZDRDNUUkFFTTVESg",
      "lines": [
        {
          "cost": {
            "totalAmount": {
              "amount": 237,
              "currencyCode": "HKD"
            }
          },
          "merchandise": {
            "id": "51295154798805",
            "image": {
              "src": "//test-xq.myshopify.com/cdn/shop/files/CherriesPremiumPunnet1kg.png?v=1743471343"
            },
            "price": {
              "amount": 237,
              "currencyCode": "HKD"
            },
            "product": {
              "id": "8931051602133",
              "title": "Cherries Premium Punnet",
              "type": "",
              "untranslatedTitle": "Cherries Premium Punnet",
              "url": "/products/cherries-premium-punnet",
              "vendor": "App-Dmap"
            },
            "sku": "",
            "title": "1.0",
            "untranslatedTitle": "1.0"
          },
          "quantity": 1
        },
        {
          "cost": {
            "totalAmount": {
              "amount": 78,
              "currencyCode": "HKD"
            }
          },
          "merchandise": {
            "id": "51295154897109",
            "image": {
              "src": "//test-xq.myshopify.com/cdn/shop/files/FigsPunnet250g.webp?v=1743471350"
            },
            "price": {
              "amount": 39,
              "currencyCode": "HKD"
            },
            "product": {
              "id": "8931051667669",
              "title": "Figs Punnet 250g",
              "type": "",
              "untranslatedTitle": "Figs Punnet 250g",
              "url": "/products/figs-punnet-250g",
              "vendor": "App-Dmap"
            },
            "sku": "",
            "title": "Default Title",
            "untranslatedTitle": "Default Title"
          },
          "quantity": 2
        }
      ],
      "totalQuantity": 3
    }
  },
  "id": "shu-5cd18d96-EB25-4583-01A4-B713DD3C7138",
  "name": "cart_viewed",
  "seq": 1,
  "timestamp": "2025-04-22T09:25:58.945Z",
  "type": "standard"
}
PreviousPage viewedNextProduct viewed

Last updated 7 days ago

Was this helpful?