Get a reward

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/rewards/{reward_id}

Get information about a specific reward.

Responses

Response body

object

data

object

Reward structure.

reward_id

string

The unique ID of the reward.

code

string

required

Code of the reward.

name

string

required

Name of the reward.

note

string

Additional text.

subtitle

string

Text of subtitle.

points_cost

float

Number of points, that will be spent by the voucher redemption.

valid_time_from

string

Time the reward is valid from. (HH:MM:SS)

valid_time_to

string

Time the reward is valid to. (HH:MM:SS)

reward_group

integer

required

The unique ID of the reward group.
Possible values: 0 - party time voucher / 1 - catalog voucher / 2 - campaign voucher/ 4 - simple reward

1 2 4

reward_type_id

string

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

store_list

array of objects

required

List of the stores where the reward can be redeemed.

store_list*

object

store_id

string

required

The unique ID of the store in CareCloud.

store_code

string

required

External code of the store.

name

string

required

Name of the store.

store_address

object

The Address Structure in the API defines the standardized format for representing addresses throughout the system. This resource ensures consistency and accuracy in capturing address details, facilitating seamless integration and data exchange.

contact_email

string

Contact email of the store.

manager_name

string

Name of the store manager.

phone_number

string

Phone number of the store with international prefix (420000000000).

partner_id

string

required

The unique ID of the partner.

system_id

string

required

The external unique ID of the store in external system.

gps_coordinates

object

GPS coordinates of the store.

url_address

string

URL address of the store.

opening

array of objects

List of opening days.

opening

object

day_id

string

required

The unique ID of the day of the week.

time_intervals

array of objects

required

List of time Intervals.

time_intervals*

object

from

string

required

Time from. (HH:MM:SS)

string

required

Time to. (HH:MM:SS)

image_urls

array of strings

A list of image URL addresses.

image_urls

visibility_for_customer

integer

State of the visibility for the customer.
Possible values are: 0 - invisible / 1 - visible

1

short_description

string

Short description of the store.

description

string

Long description of the store.

registration_id

string

Legal registration number of the store.

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the store
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

additional_properties

array of objects

Additional properties.

additional_properties

object

property_record_id

string

The unique ID of the property record.

property_id

string

required

The unique ID of the property.

property_name

string

Name of the property.

property_value

Value of the property.

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

priority

integer

Priority of the reward. 1 is the highest priority

1 2 3 4 5 6 7 8 9

image_urls

array of strings

List of reward image URL addresses.

image_urls

reward_external_url

string

External URL addresses.

has_product_condition

boolean

Parameter says, if there is product condition on reward.

has_group_condition

boolean

Parameter says, if there is group condition on reward.

has_brand_condition

boolean

Parameter says, if there is brand condition on reward.

has_product_bonus

boolean

Parameter says, if there is product bonus on reward.

has_group_bonus

boolean

Parameter says, if there is group bonus on reward.

has_brand_bonus

boolean

Parameter says, if there is brand bonus on reward.

reward_product_relation_conditions

array of objects

Conditions between reward and product.

reward_product_relation_conditions

object

related_to

string

Parameter defines where is the reward condition related to. Possible values: product - relation between reward and product / product_group - relation between reward and product group / product_brand - relation between reward and product brand

product product_group product_brand

count

integer

Count of the type(product, group or brand) in the shopping cart to fulfill the condition.

min_price

float

Minimum price of the type (product, group, brand) in the shopping cart to fulfill the condition.

max_price

float

Maximum price of the type (product, group, brand) in the shopping cart to fulfill the condition.

reward_product_relation_bonuses

array of objects

Bonuses between reward and product.

reward_product_relation_bonuses

object

related_to

string

product product_group product_brand

count

integer

Count of the type(product, group or brand) in the shopping cart to fulfill the bonus.

min_price

float

Minimum price of the type (product, group, brand) in the shopping cart to fulfill the bonus.

max_price

float

Maximum price of the type (product, group, brand) in the shopping cart to fulfill the bonus.

is_automated

boolean

Parameter says, if reward is automated or not. If reward is automated, means it's applied by rules of the reward. Otherwise have to be applied manually.

tags

object

tag_id

string

The unique ID of the tag.

name

string

Name of the tag in language from the HTTP header.

text_id

string

Text ID of the tag.

state

integer

State of the tag.
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the reward
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

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.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/rewards/reward_id \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
111
}
1
{
2
  "data": {
3
    "reward_id": "83cfee22eabfbbb15a14815e30",
4
    "code": null,
5
    "name": "Dessert+Caffe",
6
    "note": "",
7
    "subtitle": null,
8
    "points_cost": 200,
9
    "valid_time_from": null,
10
    "valid_time_to": null,
11
    "reward_group": 0,
12
    "reward_type_id": "8fdd651ff3f615bcebebad87ce",
13
    "store_list": [
14
      {
15
        "store_id": "81eaeea13b8984a169c490a325",
16
        "store_code": "84a169c490a325",
17
        "name": "Another good store",
18
        "store_address": {
19
          "address1": "Old Town Square",
20
          "address2": "34",
21
          "address3": "1a",
22
          "address4": "",
23
          "address5": "",
24
          "address6": "",
25
          "address7": "",

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.