API Reference
ES Platform
API Reference
The ES Platform is a set of products that work together to deliver loyalty, promotions, engagement, and partner-enabled value exchange. While each product has its own functional scope, the API experience is designed to be consistent across the platform, including common authentication, environment configuration, and request tracing.
API suites and intended consumers
Each product organizes its APIs around the primary integration consumer.
Customer Experience Suite
Powers customer-facing interactions such as viewing and editing member profile data, browsing offers, checking eligibility, and interacting with account-related experiences.
Point of Sale Suite
Handles transactional interactions and real-time decisioning at checkout, including earn and redeem, promotion application, basket evaluation, and finalization of transaction outcomes.
Partner Programs Suite
Connects external partners to the ES Platform in a controlled, auditable way. Supports account linking, identifier exchange, eligibility validation, and partner-driven earn or benefit flows.
Not every product exposes every suite in the same way. Availability depends on the product and the access grant provided for your client credentials.
Environments and base URL construction
API requests are made against an environment-specific base URL. Integrations are typically configured using these values:
- A root base URL for the platform
- An environment name or identifier assigned to your ES instance
- Product and suite identifiers as applicable to form the full suite endpoint
This approach allows the same integration code to be promoted across environments such as sandbox, staging, and production by changing configuration rather than rewriting endpoints.
Authentication
The ES Platform uses OAuth 2.0 Client Credentials for server-to-server access.
- Exchange Solutions issues you a client identifier and client secret.
- You request an access token from the authorization endpoint.
- You include the resulting access token with API calls according to the suite requirements.
Access is granted on a per-suite basis. A single system such as an e-commerce platform may have access to multiple suites when needed, but credentials should be scoped and distributed according to your business unit and least-privilege practices. Client identifiers and secrets are sensitive and must be stored securely.
Request tracing and diagnostics
The ES Platform supports end-to-end traceability using identifiers passed with each request.
Call identifier
Traces individual requests at a granular level.
Correlation identifier
Traces a session or logical workflow across multiple requests. Must be globally unique — duplicates may be rejected.
These identifiers enable operational support, auditing, and performance troubleshooting across distributed systems.
Cross-product integration patterns
Implementations commonly combine products to support complete customer and transaction journeys.
Customer applications
Use Customer Experience APIs to display loyalty status, available offers, and personalized experiences.
Checkout and POS systems
Use Point of Sale APIs to evaluate baskets, apply promotions, calculate points, and commit earn and redeem outcomes.
Partner integrations
Use Partner Programs APIs to link accounts and participate in controlled earn or benefit exchanges.
Promo Enhance and LoyaltyBoost
Support real-time calculation and incremental reward logic at browse time and at transaction time.
ES Engage
Consumes events and eligibility outputs to trigger downstream engagement actions aligned to customer lifecycle and behavior.
Access and governance
API access is provisioned per suite and per environment. It is recommended that:
- Each business unit or integration domain has its own client credentials
- Credentials are rotated and managed under your organization's security standards
- Access is limited to only the products and suites required for the integration's responsibilities
This overview applies across ES Loyalty and serves as the foundation for the detailed endpoint references that follow for each product section and suite.