Introduction
12 min
Overview
These APIs are meant to keep the record of the site activity in order to track the user behavior and system events.
In This Section
Site Activity Consumer APIs
- Add Events: This endpoint adds the information about the consumer's activity to be distributed inside the system.
- Get Events: This endpoint fetches the information about the consumer's activity to be distributed inside the system.
- Get Viewed Catalog Items: This endpoint returns the list of entries of catalog items that have been recently viewed by the current consumer.
Site Activity Management APIs
- Get Viewed Catalog Items by ID: This endpoint returns the list of viewed catalog items for a specific consumer.
Site Activity Events
For all the asynchronous operations, you can monitor the activity using events. These events are generated for the client to monitor the activity in the site. Following is the list of the site events against the following endpoints:
Shopping Cart
- Cart Creation: This event is triggered whenever a cart is created.
- Cart Updation: This event is triggered on updating a cart such as updating items in the cart or changing the shipping method.
- Delete Items from Cart: This event is triggered if items are removed from the cart.
Return Policy
- Return Policy Creation : This event is triggered whenever a return policy is created.
- Return Policy Updated : This event is triggered whenever a return policy is updated.
Quote Management
- Quote Creation : This event is triggered whenever a quote is created.
- Quote Updated : This event is triggered whenever a quote is updated.
Catalog Management
- Catalog Item Created : This event is triggered whenever a new catalog item is created.
- Catalog Item Updated : This event is triggered whenever an already existing catalog item is modified such as pricing.
- Catalog Item Published : This event is triggered whenever a catalog item is made live on the website.
- Catalog Item Type Creation : Thos event is triggered whenever a catalog item type is created.
- Catalog Item Type Updated : This event is triggered whenever an already existing catalog item type is updated.
Swatch Management
- Swatch Collection Type Creation : This event is triggered whenever a swatch collection type is created.
- Swatch Collection Type Updated : This event is triggered whenever a swatch collection type is updated.
- Swatch Collection Type Deleted : This event is triggered whenever a swatch collection type is deleted.
- Swatch Collection Creation : This event is triggered whenever a swatch collection is created.
- Swatch Collection Updated : This event is triggered whenever a swatch collection is modified.
- Swatch Collection Deleted : This event is triggered whenever a swatch collection is deleted.
- Swatch Creation : This event is triggered whenever a new swatch is created.
- Swatch Updated : This event is triggered whenever an already existing swatch is modified.
- Swatch Deleted : This event is triggered whenever a new swatch is deleted.
- Customer Creation : This event is triggered whenever a new customer is created.
Finance Offer Management
- Financial Offer Created : This item is triggered whenever a new financial offer is made.
- Financial Offer Updated : This item is triggered whenever an already existing financial offer is modified.
- Financial Offer Toggle : This event is triggered whenever a finance offer is enabled or disabled.
Inventory Management
- Inventory Updated : This event is triggered whenever any item in the inventory is updated.
- Inventory Deleted : This event is triggered in case an inventory is deleted.
Location Management
- Location Creation : This event is triggered whenever a new store or warehouse location is created.
- Location Updated : This event is triggered whenever an already existing location information is updated.
- Location Address Updated : This event is triggered whenever a location address is changed.
- Location Contact Info Added : This event is triggered whenever a location contact information is added.
- Location Contact Info Updated : This event is triggered whenever a location contact information is modified.
- Location Contact Info Deleted : This event is triggered whenever a location contact information is deleted.
- Location Coordinated Updated : This event is triggered whenever a location's coordinates are updated.
- Location Hour Of Operation Updated : This event is triggered whenever a location's hours of exceptions are modified.
- Location Closed : This event is triggered whenever a location is closed.
Pricing Management
- Pricing Updated : This event is triggered whenever pricing of anything is updated.
Promotion Management
- Promotion Creation : This event is triggered whenever a new promotion offer is created.
- Promotion Updated : This event is triggered whenever an already existing promotion offer is updated.
- Promotion Archived : This event is triggered whenever an already existing promotion offer is archived.
Role Management
- Role Creation : This event is triggered whenever a new role is created.
- Role Updated : This event is triggered whenever an already existing role is updated.
- Role Deleted : This event is triggered whenever an already existing role is deleted.
- User Role Updated : This event is triggered whenever an already existing role is changed to another role.
- User Creation : This event is triggered whenever a new user for the portal is created.
- User Deleted : This event is triggered whenever an already existing user is deleted.