Eligible Offers Input

Input representation to retrieve eligible offers.

JSON Example

1{
2  "dataspace": "default",
3  "individualId": "003xx000004WhNsAAK",
4  "unifiedIndividualDmoName": "UnifiedssotIndividualIr1__dlm",
5  "activityDate": "2024-01-15T10:30:00Z",
6  "lookupWindow": 30,
7  "channels": ["Email", "SMS", "Mobile App"],
8  "products": ["Premium Membership", "Travel Insurance"],
9  "categories": ["Insurance", "Membership"],
10  "limit" : 10,
11    "additionalOfferFilters": { "ssot__PriorityNumber__c": "2" }
12}

Properties

Name	Type	Description	Required or Optional	Available Version
`activityDate`	String	Activity date to filter offers. Only offers that are valid on this date are returned. Format: ISO 8601 date-time (e.g., 2024-01-15T10:30:00Z).	Required	66.0
`additionalOfferFilters`	Map<String, Object>	Field value filters for the offer DMO that can be used in the query for customization.	Optional	66.0
`categories`	String[]	List of category names to filter offers. An offer is included if it is configured for at least one product from this list or at least one category from the categories list. If both products and categories are provided, an offer matching either condition is returned.	Optional	66.0
`channels`	String[]	List of channel names to filter offers and offer treatments. Only offers configured for these specific channels are returned.	Optional	66.0
`dataspace`	String	Dataspace for which eligible offers are to be retrieved.	Required	66.0
`individualId`	String	ID of the individual to retrieve eligible offers. Either individualId or contactId must be provided.	Required	66.0
`limit`	Integer	Limits the number of active offers returned. Offers are sorted first based on priority (ascending) and then end date. This parameter doesn’t affect upcoming offers.	Optional	66.0
`lookupWindow`	Integer	Offers are retrieved for the time starting from the activity date up to the day calculated by adding the lookup window to the activity date. Results are segregated into ‘Active Offers’ and ‘Upcoming Offers’.	Optional	66.0
`offerGroups`	String[]	A list of offer group names that’s used to filter offers. Only offers configured for these offer groups are returned. Offer groups function like tags that help group similar types of offers. These differ from categories and are mainly used for offer personalization.	Optional	66.0
`products`	String[]	List of product names to filter offers. An offer is included if it is configured for at least one product from this list or at least one category from the categories list. If both products and categories are provided, an offer matching either condition is returned.	Optional	66.0
`unifiedIndividualDmoName`	String	Unified individual DMO name for which eligible offers are to be retrieved. This parameter must be specified if a unified individual is being queried.	Optional	66.0