Different types of Rewards for Customers can be created and managed in CRM CareCloud. The Reward and its features is a pattern for creation of individual customer Vouchers that can be applied to the Customer purchases directly. It is defined by a set of parameters like Reward validity, prioroty or number of points, that will be spent by application and many other. You can create rewards and get the information about actual rewards processed in CRM CareCloud by this resource.
All available methods for resource rewards.
HTTP method | Endpoint | Description |
---|---|---|
[badge-blue GET] | /rewards | List of all rewards |
[badge-blue GET] | /rewards/{reward_id} | Detail of a specific reward |
All available methods for sub-resources of resource rewards.
HTTP method | Endpoint | Description |
---|---|---|
[badge-blue GET] | /rewards/{reward_id}/vouchers | List of all vouchers tied to a reward |
[badge-blue GET] | /rewards/{reward_id}/products | List of all products tied to a reward |
[badge-blue GET] | /rewards/{reward_id}/product-groups | List of all product groups tied to a reward |
[badge-blue GET] | /rewards/{reward_id}/product-brands | List of all product brands tied to a reward |
[badge-blue GET] | /rewards/{reward_id}/stores | List of all stores tied to a reward |
Action methods for resource rewards
HTTP method | Endpoint | Description |
---|---|---|
[badge-green POST] | /rewards/{reward_id}/actions/create-voucher | Create a new individual voucher based on a reward features definition |
Get information about rewards as a list of all rewards
[badge-blue GET] /rewards
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
count | integer | The number of records to return. Default value is 100. |
No |
offset | integer | The number of records from a collection to skip. Default value is 0. | No |
sort_field | string | One of the query string parameters for sorting. Response is sorted by the specified field. | No |
sort_direction | string | Direction of sorting the response list. Possible values are: ASC / DESC | No |
name | string | The name or a part of the name of the reward | No |
store_id | string | The unique id for the store where customer can apply the reward | No |
is_valid | boolean | Filter for valid rewards. Possible values: true - all rewards valid in the moment / false - all rewards not valid in the moment / no value - all rewards |
No |
valid_from | string | Date from where is reward valid already. (YYYY-MM-DD) | No |
valid_to | string | Date to where is reward valid still. (YYYY-MM-DD) | No |
is_automated | boolean | 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) |
No |
reward_group | integer | The unique id for the reward group Possible values: 0 - cash desk reward (party time reward) / 1 - catalog reward / 2 - campaign reward |
No |
customer_type_id | array | Select by list of customer types from customer-types resource. Logic OR is used between values | No |
without_stores | boolean | If true, resource call returns rewards without list of stores. If false, or not set resource returns default strucutre. | No |
There is the logical AND between parameters is_valid, valid_from and valid to.
Status code: 200 OK
Output structure : object
Parameter name | Type | Description |
---|---|---|
rewards | Reward[] | List of all rewards |
total_items | integer | Count of all found rewards |
Get information about a specific reward
[badge-blue GET] /rewards/{reward_id}
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
reward_id | string | The unique id for the reward | Yes |
Status code: 200 OK
Output structure : Reward
Create a new voucher for a specific customer based on a reward features definition
[badge-green POST] /rewards/{reward_id}/actions/create-voucher
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
reward_id | string | The unique id for the reward | Yes |
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
customer_id | string | The unique id for the customer | Yes |
code | string | voucher | No |
Status code: 201 Created
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
voucher_id | string | The unique id for the voucher | Yes |