onSaleCreated
Purpose
Triggered when a sale/promotion is created for a shop. Use this hook to log promotional activity and track marketing efforts.
When It Triggers
Owner or authorized employee creates a new sale
Sale is saved to the database
Parameters
Parameter
Type
Description
data.source
number
Server ID
data.shopId
string
Unique shop identifier
data.shopName
string
Display name of the shop
data.saleId
string
Unique sale identifier
data.saleName
string
Sale display name
data.discount
number
Discount percentage
data.startDate
string
Start date/time
data.endDate
string
End date/time
data.applicableItems
table
Array of item names (empty = all items)
data.isActive
boolean
Whether sale is active
data.createdBy
string
Name of creator
data.createdByIdentifier
string
Identifier of creator
data.timestamp
number
Server timestamp
Example
Last updated