API Reference

Recommend the best rewards for the customer

get
https://{project_url}/webservice/rest-api/{api_interface}/{version}/rewards/actions/reward-recommendations

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 100

The number of records to return in API response.

⚠️ We recommend adjusting the batch size based on the response time of the request. The default value of 100 records is used if the count parameter is not set.

integer
≥ 0
Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

string

Search record by name or a part of the name.

string

The unique ID of the store where customer can apply the reward. GET /stores

boolean
enum

in validity range - true / before or after validity range - false / no value - all

Allowed:
string

Start of the validity period for filtering in ISO-8601 format (YYYY-MM-DD).

string

End of the validity period for filtering in ISO-8601 format (YYYY-MM-DD).

string

Code of the reward.

boolean
enum

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)

Allowed:
integer
enum

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)

Allowed:
customer_type_id
array of strings
length ≤ 1000

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.

customer_type_id
boolean
enum

If true or not set, the data will not contain information about business units (stores). If false resource returns full structure with stores.

Allowed:
tag_ids
array of strings
length ≤ 1000

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

tag_ids
string

Unique ID of the partner from the resource GET /partners.

string

The type of reward describes the reward behavior. For example, a Percentage discount, Buy one + get one discounted product, and others. GET /reward-types

string
required

The unique ID of the customer. GET /customers

Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 6 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago

Did this page help you?