Events

Product Shared

Shared a product with one or more friends.
Suggested source: website front-end
Properties
Name
Type
Description
Required
affiliation
string
Product affiliation to designate a supplying company or brick and mortar store location (for example, "Google Store")

no
brand
string
Brand associated with the product

no
bundle
boolean
Product belongs to a bundle

no
category
string
Product category

no
coupon
string
Coupon code associated with a product (for example, "MAY_DEALS_3")

no
description
string
Short description of the product

no
image_url
string
Image URL of the product

no
name
string
Name of the product

yes
option_values
string[]
Option values of the product variant

no
position
integer
Position in the product list (for example, 3)

no
price
number
Price ($) of the product

no
product_id
string
Database ID of the product

yes
quantity
integer
Quantity of the product

no
sku
string
SKU of the product variant

no
slug
string
Slug of the product, often used in URLs (for example, "product-red")

no
url
string
URL of the product page

no
variant
string
Name of the product variant

no
share_message
string
Message that the sender sent

no
share_via
string
Method of sharing

no
recipient
string
Recipient of the sharing

no
Example
JSON
{
    "affiliation": "My Plant Store",
    "brand": "Green Thumb Nurseries",
    "bundle": false,
    "category": "Outdoor Plants",
    "description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
    "image_url": "https://example.com/images/petunia.jpg",
    "name": "Petunia",
    "option_values": [
        "Purple",
        "Red",
        "White"
    ],
    "position": 3,
    "price": 7.99,
    "product_id": "123456789",
    "sku": "PETUNIA-001",
    "slug": "petunia",
    "url": "https://example.com/plants/petunia",
    "variant": "Purple",
    "share_message": "I think your garden needs this!",
    "share_via": "email",
    "recipient": "[email protected]"
}
{
    "affiliation": "My Plant Store",
    "brand": "Green Thumb Nurseries",
    "bundle": false,
    "category": "Outdoor Plants",
    "description": "A vibrant, easy-to-care-for garden plant perfect for adding a splash of color to any outdoor space.",
    "image_url": "https://example.com/images/petunia.jpg",
    "name": "Petunia",
    "option_values": [
        "Purple",
        "Red",
        "White"
    ],
    "position": 3,
    "price": 7.99,
    "product_id": "123456789",
    "sku": "PETUNIA-001",
    "slug": "petunia",
    "url": "https://example.com/plants/petunia",
    "variant": "Purple",
    "share_message": "I think your garden needs this!",
    "share_via": "email",
    "recipient": "friend@example.com"
}
﻿
  
option_values[] array
Option values of the product variant
Option value (for example, "red")
Item Type: stringExample
JSON
[
    "Purple"
]
[
    "Purple"
]
﻿
﻿

Name	Type	Description	Required
affiliation	string	Product affiliation to designate a supplying company or brick and mortar store location (for example, "Google Store")	no
brand	string	Brand associated with the product	no
bundle	boolean	Product belongs to a bundle	no
category	string	Product category	no
coupon	string	Coupon code associated with a product (for example, "MAY_DEALS_3")	no
description	string	Short description of the product	no
image_url	string	Image URL of the product	no
name	string	Name of the product	yes
option_values	string[]	Option values of the product variant	no
position	integer	Position in the product list (for example, 3)	no
price	number	Price ($) of the product	no
product_id	string	Database ID of the product	yes
quantity	integer	Quantity of the product	no
sku	string	SKU of the product variant	no
slug	string	Slug of the product, often used in URLs (for example, "product-red")	no
url	string	URL of the product page	no
variant	string	Name of the product variant	no
share_message	string	Message that the sender sent	no
share_via	string	Method of sharing	no
recipient	string	Recipient of the sharing	no

Product Reviewed

Product Viewed