SaaSquatch Help Center

Details about the SaaSquatch User Purchase Event.

The SaaSquatch system is configured to accept being sent a wide range of event data about actions users take within your product. This event information will power the programs within your SaaSquatch project, and can be used to trigger sending emails and providing rewards.

Events can be sent to SaaSquatch through our REST API or squatch.js Javascript Library.

The `puchase` event is a reserved user event type within the SaaSquatch system, and requires information to be sent to SaaSquatch in a defined format. This format is as follows:

Fields



checkout_id
string
The checkout ID associated with this purchase
order_id
string
The order or transaction ID associated with this purchase
affiliation
string
Store or affiliation from which this transaction occurred (e.g. Google Store)
total
number
Revenue with discounts and coupons added in
revenue
number
Revenue associated with the transaction (excluding shipping and tax). This is the field we use to calculate a customer's LTV.
shipping
number
Shipping cost associated with the transaction
tax
number
Total tax associated with the transaction
discount
number
Total discount associated with the transaction
coupon
string
Transaction coupon redeemed with the transaction
currency
string
The ISO currency code used in this purchase
products
array
Array of products in the purchase
Required product_id
string
Database id of the product being viewed
sku
string
Sku of the product being viewed
category
string
Product category being viewed
name
string
Name of the product being viewed
brand
string
Brand associated with the product
variant
string
Variant of the product (e.g. Black)
price
number
Price of the product being viewed
quantity
integer
Quantity of a product
coupon
string
Coupon code associated with a product (e.g MAY_DEALS_3)
position
integer
Position in the product list (ex. 3)
url
string
URL of the product page
image_url
string
Image url of the product