Recommend the best rewards for the customer
The endpoint recommends and orders the best rewards for the customer depending on the query parameters setup. This endpoint uses a machine learning-based CareCloud Recommendation Engine. The CareCloud Recommendation Engine requires additional setup and training of AI models. If the recommendation models are not trained for your project, The endpoint returns a list of all rewards filtered by query parameters.
⚠️ There is the logical AND between query parameters is_valid, valid_from and valid to.
Path parameters
The unique ID of the customer.
Query parameters
The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
Search record by name or a part of the name.
The unique ID of the store where customer can apply the reward. GET /stores
in validity range - true / before or after validity range - false / no value - all
Start of the validity period for filtering in ISO-8601 format (YYYY-MM-DD).
End of the validity period for filtering in ISO-8601 format (YYYY-MM-DD).
Code of the reward.
Filter of the automated rewards. Possible values: true - returns all automated rewards / false - returns all non automated rewards / no value - all rewards(filter is not applied)
The unique ID of the reward group. Possible values: 0 - cash desk reward (party time reward) / 1 - catalog reward / 2 - campaign reward / 4 - simple reward / 5 - gift reward (Multi Purpose Reward)
Select by list of customer types from customer-types resource. The list of values is available at GET /customer-types. In case you want to filter multiple options use array syntax : customer_type_id[]=86e05affc7a7abefcd513ab400&customer_type_id[]=82c06812c0756528660784fef Logic OR is used between values.
If true or not set, the data will not contain information about business units (stores). If false resource returns full structure with stores.
Parameter filters values by a list of tag IDs. Logic OR is used between values.
In case you want to filter multiple options use array syntax : tag_ids[]=8bc8ca16f9c5039951021700a2&tag_ids[]=82c06812c0756528660784fef
Unique ID of the partner from the resource GET /partners.
The type of reward describes the reward behavior. For example, a Percentage discount, Buy one + get one discounted product, and others. GET /reward-types
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"rewards": [
{
"reward_id": "83cfee22eabfbbb15a14815e30",
"code": "REWARD-001",
"name": "Dessert+Caffe",
"subtitle": "Valid for all menu items",
"points_cost": 200,
"valid_time_from": "09:00:00",
"valid_time_to": "22:00:00",
"reward_type_id": "8fdd651ff3f615bcebebad87ce",
"store_list": [
{
"store_id": "81eaeea13b8984a169c490a325",
"store_code": "84a169c490a325",
"name": "Another good store",
"store_address": {
"address1": "Old Town Square",
"address2": "34",
"address3": "1a",
"zip": "11000",
"city": "Prague 1",
"country_code": "cz"
},
"contact_email": "good.store@crmcarecloud.com",
"manager_name": "Andrew Black",
"phone_number": "420523828931",
"partner_id": "86e05affc7a7abefcd513ab400",
"system_id": "2375303497",
"url_address": "www.crmcarecloud.com",
"opening": [
{
"day_id": "MON",
"time_intervals": [
{
"from": "08:00:00",
"to": "15:30:00"
}
]
}
],
"visibility_for_customer": 1,
"short_description": "Another good store for buying beverages",
"description": "Another good store for buying beverages: beer, wine, juice, soda",
"registration_id": "81eaeea13b89",
"last_change": "2023-03-28 16:12:56",
"state": 1
}
],
"additional_properties": [
{
"property_record_id": "docasna_blokace_darce_do:8ea2591121e636086a4a9c0992",
"property_id": "docasna_blokace_darce_do",
"property_name": "Property #6",
"last_change": "2023-02-02 00:00:00"
}
],
"has_product_condition": true,
"has_product_bonus": true,
"reward_product_relation_conditions": [
{
"related_to": "product",
"count": 3,
"min_price": 11.3,
"max_price": 22
}
],
"reward_product_relation_bonuses": [
{
"related_to": "product",
"count": 3,
"min_price": 11.3,
"max_price": 22
}
],
"tags": [
{
"tag_id": "838b73aacb5ac326cec4030c80",
"name": "Recommended",
"text_id": "recommended_tag",
"state": 1,
"last_change": "2019-01-04 10:31:56"
}
],
"last_change": "2013-07-24 21:33:33",
"state": 1
}
],
"total_items": 1
}
}