The Points Preview API enables pre-purchase queries to retrieve the points awarded for a purchase. This feature is ideal for providing customers with real-time information on potential point earnings. It calculates the total points for the entire cart, including points assigned by Campaign bonus workflow nodes.
The API predicts loyalty points based on submitted transaction data. Unlike the Events API, which awards points to customers, the Points Preview API returns information about potential points earned for the purchase, including workflow bonus points.
Note that this API is only available if the Workflows module is enabled in your workspace.
API Principles
The Points preview API follows RESTful principles, utilizing standard HTTP methods to interact with resources. All responses are formatted in JSON, ensuring easy integration into user interfaces.
Security and Compliance
All server-to-server calls must comply with the API security protocol and signing procedure and adhere to the defined API rate limits.