Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Eligible Offers

List of the offers eligible for the channels and members. If channels aren't set, only the offers eligible for the members are returned.

JSON example

This example shows a sample response.

1{
2  "activeOffers": [
3    {
4      "offerId": "0fxxx000000001AAA",
5      "name": "Summer Sale 2024",
6      "description": "Get 20% off on all products",
7      "startDate": "2024-01-01T00:00:00Z",
8      "endDate": "2024-12-31T23:59:59Z",
9      "promotionId": "0c8xx000000001AAA",
10      "priority": 1,
11      "campaignId": "701xx000000001AAA",
12      "couponCode": "SUMMER20",
13      "offerCode": "OFFER-2024-001",
14      "offerTreatments": [
15        {
16          "treatmentId": "0ftxx000000001AAA",
17          "communicationChannelType": "Email",
18          "name": "Email Treatment",
19          "offerHeading": "Exclusive Summer Offer!",
20          "imageUrl": "https://example.com/images/summer-sale.jpg",
21          "offerBody": "Don't miss out on our biggest sale of the year!",
22          "callToActionText": "Shop Now",
23          "callToActionUrl": "https://example.com/shop"
24        }
25      ]
26    }
27  ],
28  "upcomingOffers": [
29    {
30      "offerId": "0fxxx000000002AAA",
31      "name": "Fall Collection Launch",
32      "description": "New arrivals coming soon",
33      "startDate": "2024-02-01T00:00:00Z",
34      "endDate": "2024-02-28T23:59:59Z",
35      "offerTreatments": []
36    }
37  ]
38}

Property Name	Type	Description	Filter Group and Version	Available Version
`activeOffers`	Offer Details[]	List of offers that are currently active based on the activity date.	Big, 66.0	66.0
`totalOffersCount`	Integer	Total count of eligible offers returned. Only applicable when channels are set.	Big, 66.0	66.0
`upcomingOffers`	Offer Details[]	List of offers that are active within the lookup window (only present when lookupWindow is specified).	Big, 66.0	66.0

Real-Time Offer Management Developer Guide

Eligible Offers