Events

Item Restocked

Notify waitlist that product variant is back in stock.
Suggested source: server
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

no
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

no
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
backorderable
boolean
Whether the variant can be backordered

no
currency
string
Currency code of the transaction (for example, "USD")
Pattern: ^[A-Z]{3}$

no
email
string
Email address to notify when the product is back in stock

no
total_on_hand
integer
Quantity of the variant currently available (for example, 5000)

no
stock_request_id
string
ID of waitlist signup

no
variant_id
string
Database ID of the product variant

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",
    "backorderable": true,
    "currency": "USD",
    "email": "[email protected]",
    "total_on_hand": 30,
    "stock_request_id": "sr123456",
    "variant_id": "v987654"
}
{
    "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",
    "backorderable": true,
    "currency": "USD",
    "email": "customer@example.com",
    "total_on_hand": 30,
    "stock_request_id": "sr123456",
    "variant_id": "v987654"
}
﻿
  
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	no
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	no
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
backorderable	boolean	Whether the variant can be backordered	no
currency	string	Currency code of the transaction (for example, "USD") Pattern: ^[A-Z]{3}$	no
email	string	Email address to notify when the product is back in stock	no
total_on_hand	integer	Quantity of the variant currently available (for example, 5000)	no
stock_request_id	string	ID of waitlist signup	no
variant_id	string	Database ID of the product variant	no

Gift Card Removed