HomeWiki
HomeWiki
  • Back to home
  • 5. Apps
  • Getting Started
  • Create App
  • Installation
  • Versioning
  • Events
  • Iframe
  • OAuth
  • Web Hooks

Events

Event Subscription Documentation#

This guide provides a detailed overview of all the available events that you can subscribe to in the Shopranos platform. These events allow you to trigger custom actions based on user interactions and behaviors on your eCommerce site.

Quick Reference: List of Events#

Cart Events#

add-to-cart
quick-add-to-cart
remove-from-cart
in-cart-items-changed
calculated-cart

Wishlist Events#

add-to-wishlist
remove-from-wishlist
view-wishlist

Page View Events#

page-view
product-view
collection-view
category-view
brand-view

Checkout Events#

proceed-to-checkout
abandon-checkout
initiate-payment
complete-checkout

Search Events#

search-results

Forms Events#

form-submission
subscribe-to-newsletter

Account Events#

user-sign-in
user-sign-out
user-register
user-forgot-password

Detailed Event Documentation#

Cart Events#

1.
add-to-cart
Description: Triggered when a user adds an item to the cart.
Example:
2.
quick-add-to-cart
Description: Triggered when a user quickly adds an item to the cart without viewing the product page.
Example:
3.
remove-from-cart
Description: Triggered when a user removes an item from the cart.
Example:
4.
in-cart-items-changed
Description: Triggered when the items in the cart are changed (e.g., quantity updates).
Example:
5.
calculated-cart
Description: Triggered when the cart is recalculated, such as when discounts or taxes are applied.
Example:

Wishlist Events#

1.
add-to-wishlist
Description: Triggered when a user adds an item to their wishlist.
Example:
2.
remove-from-wishlist
Description: Triggered when a user removes an item from their wishlist.
Example:
3.
view-wishlist
Description: Triggered when a user views their wishlist.
Example:

Page View Events#

1.
page-view
Description: Triggered when a user views any page on the site.
Example:
2.
product-view
Description: Triggered when a user views a product page.
Example:
3.
collection-view
Description: Triggered when a user views a collection or product grouping page.
Example:
4.
category-view
Description: Triggered when a user views a category page.
Example:
5.
brand-view
Description: Triggered when a user views a brand page.
Example:

Checkout Events#

1.
proceed-to-checkout
Description: Triggered when a user proceeds to the checkout page.
Example:
2.
abandon-checkout
Description: Triggered when a user abandons the checkout process.
Example:
3.
initiate-payment
Description: Triggered when a user initiates a payment process during checkout.
Example:
4.
complete-checkout
Description: Triggered when a user completes the checkout process.
Example:

Search Events#

1.
search-results
Description: Triggered when search results are returned for a user query.
Example:

Form Events#

1.
form-submission
Description: Triggered when a user submits a form on the site.
Example:
2.
subscribe-to-newsletter
Description: Triggered when a user subscribes to the newsletter.
Example:

Account Events#

1.
user-sign-in
Description: Triggered when a user signs into their account.
Example:
2.
user-sign-out
Description: Triggered when a user signs out of their account.
Example:
3.
user-register
Description: Triggered when a user registers a new account.
Example:
4.
user-forgot-password
Description: Triggered when a user requests a password reset.
Example:

Conclusion#

By subscribing to these events, you can customize the user experience on your Shopranos-powered eCommerce platform, respond to user actions in real-time, and build dynamic, responsive applications. Each event provides valuable data that can be leveraged to enhance functionality, improve user engagement, and optimize your online store's performance.
Modified at 2024-08-26 13:54:46
Previous
Versioning
Next
Iframe
Built with