Growth Automation Purchase Event
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
|