API Domains

The SessionM API ecosystem is designed to power dynamic customer engagement through a suite of interconnected domains: Customers, Campaigns, Point of Sale (POS), Offers, Incentives (Loyalty), Catalog, Transactions, Advanced, and Deprecated. These APIs enable businesses to create personalized experiences, drive customer loyalty, and manage transactional data with precision and scalability.

Customers Domain

The Customers domain supports foundational operations related to customer (or "user") data within the SessionM Platform. These APIs enable the management of customer profiles, account relationships, and behavioral data, forming the backbone of personalized engagement strategies. Key APIs include:

  • Customer Profile API: Manage core customer data and attributes.

  • Customer Accounts Merge API: Merge duplicate or related customer accounts.

  • Customer Account Notes API: Add and retrieve notes associated with customer accounts.

  • Tags API: Apply and manage tags for customer segmentation.

  • Events API: Record and process customer-related events.

  • Timeline API: Retrieve chronological views of customer activity.

  • Data Privacy API: Handle privacy-related operations such as data access and deletion.

  • Device Tokens API: Manage device tokens for push notification delivery.

Campaigns Domain

The Campaigns domain supports scheduled and targeted customer engagement across a variety of channels. These APIs enable brands to deliver promotions, display advertising, personalized push notifications, and in-app messaging. Whether you're orchestrating a broad campaign or delivering a one-to-one message, the Campaigns APIs provide the tools to reach users effectively. Key APIs include:

  • Campaigns API: Manages the creation and execution of targeted campaigns.

  • Inbox API: Supports in-app messaging and notification delivery.

  • Promo Code API: Enables the generation and management of promotional codes for user engagement.

Point of Sale (POS) Domain

The Point of Sale (POS) domain supports integration between third-party POS or ecommerce platforms and the SessionM Platform. These APIs allow external systems to programmatically send transaction data and associate it with known members of a loyalty program. They enable a range of operations essential for real-time customer engagement at the point of sale, including:

  • Send Transaction API: Sending transaction data.

  • User Lookup API: Looking up a customer and retrieving their offers and loyalty information, such as point balances.

  • Immediate Redeem API: Redeeming offers

  • Reinstate Offer API: Reinstating offer after it was redeemed.

  • Lock Offer API: Locking offer in a transaction.

  • Unlock Offer API: Unlocking offer after it has been locked.

These APIs are purpose-built for POS and ecommerce use cases and should be used in place of general SessionM Platform APIs for such integrations, unless a custom solution is specifically required. Additionally, the domain contains a General Request Container for its APIs, which describe the properties for required headers and bodies specified in requests and responses.

Offers Domain

The Offers domain provides a robust framework for rewarding and incentivizing users through various outcome types. Offers can be integrated with point-of-sale systems to enable closed-loop discounts and support fulfillment workflows—whether manual, digital, or physical. The lifecycle of a user offer—from issuance to redemption—is fully trackable, with restrictions available to control both acquisition and redemption. Key APIs include:

AcquisitionV2 API: Manages user offer acquisition via app purchases, campaigns, or user activities.

  • InfoV2 API: Provides read-only access to offer details.

  • ManagementV2 API: Enables creation, deletion, and deactivation of offers.

  • RedemptionV2 API: Supports offer redemption and code generation, including POS integration.

  • RewardStoresV2 API: Facilitates offer acquisition through various user actions.

  • Saga API: Manages asynchronous saga jobs for complex workflows.

Incentives (Loyalty) Domain

The Incentives domain integrates Offers and Transactions with a powerful loyalty rules engine and user points system. This enables highly customizable loyalty programs that reward users with points, offers, and tier progression based on specific actions. The domain supports point management, GDPR compliance, and campaign triggers. Key APIs include:

  • DynamicRuleTemplate & DynamicRuleTree API: Manage loyalty rule configurations.

  • Gdpr API: Ensures data anonymization for privacy compliance.

  • Ingest API: Processes incoming transactions for loyalty interactions.

  • PointAuditLog: Tracks point history for transparency and insights.

  • Progress API: Reports user progress against targeting systems.

  • SimulateOutcomes API: Tests Loyalty 2.0 outcomes.

  • TierLevels, TierMovement, TierLevelConstraint APIs: Manage tier systems and user progression.

  • Trigger & UserEvents APIs: Initiate rule evaluations and reward actions.

  • UserPoints & UserPointsV2 APIs: Manage and audit user point balances.

  • UserState & UserTiers APIs: Track user rule states and tier status.

Catalog Domain

The Catalog domain plays an integral role across the SessionM Platform. It is essential for client integrations involving transactional ingests, product and location-restricted offers, incentive programs, and campaigns. The domain supports a wide variety of hierarchical data structures, allowing for flexible and extensible taxonomies. All data is normalized to ensure maximum interoperability across SessionM infrastructure and third-party APIs. Key APIs include:

  • Saga API: Enqueues saga jobs for orchestrated catalog workflows.

  • V3 Enqueue API: Handles catalog job queuing.

  • V3 Master Catalog API: Manages master catalog data.

  • V3 Catalog Status API: Determines which catalog jobs can run and fetches their status.

  • V3 Cross Catalog API: Fetches IDs for items and categories in a catalog.

  • V3 Catalog Types API: Manages catalog type data.

Transactions Domain

The Transactions domain focuses on processing transactions procedurally, storing related items and payments. Each processed transaction is linked to a retailer-specific, normalized master menu retrieved from the Catalog domain. The domain also includes endpoints for retrieving transaction data—either as individual records or as pageable, sortable lists per store. Additionally, the publishing feature enables broadcasting to the Incentives domain to support point economy operations. Key APIs include:

  • Info API: A collection of endpoints that return information about processed transactions.

  • InfoV2 API: An updated set of endpoints for retrieving processed transaction data, offering improved performance and flexibility.

  • Normalizing API: Handles normalization of transaction data to align with catalog standards.

  • Processing API: Enables near real-time ingestion of transaction details from ecommerce platforms and POS systems. These calls are asynchronous to avoid slowing down user queue processing. Offline transactions should be stored locally and batched to SessionM once connectivity is restored.

  • ProcessingV2 API: A newer version of the Processing API with similar functionality, optimized for performance and reliability in real-time and offline scenarios.

  • Saga API: Allows users to enqueue saga jobs for orchestrated transaction workflows.

  • SchemaManagement API: Provides endpoints to manage and retrieve schema-related information for processed transactions.

  • SimulateOutcomes API: Offers endpoints to simulate outcomes—typically points—based on transaction data. As of March 2025, this supports Loyalty 2.0 Outcomes only.

Advanced Domain

The Advanced domain includes APIs and procedures designed to support complex and less common implementation goals within the SessionM Platform. These tools are typically used for specialized use cases that require deeper customization or control. Key APIs include:

  • Divisions API: Manages organizational divisions for advanced segmentation.

  • Model API: Supports custom modeling operations.

  • Lockout API: Handles user or system lockout scenarios.

  • Limiter API: Enforces rate limits or usage constraints.

  • Encrypting Requests: Provides mechanisms for secure API communication.

Deprecated APIs

These APIs have been superseded by newer versions but are still supported for legacy implementations. However, they remain available to ensure backward compatibility for systems that have not yet migrated. Key APIs include:

  • Orders API

  • Points API

  • Tiers API

  • Core Loyalty API

  • Places API

  • Access Tokens API

  • Identity Services API

  • SMS Validation API

  • Customer Affiliation API

  • Image Validation API

  • Campaign Creation API

  • Campaigns Management API