API Reference
Start typing to search…

Get all rewards

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

Get information about rewards as a list of all rewards.

⚠️ There is the logical AND between query parameters `is_valid`, `valid_from` and `valid to`.

Log in to see full request history
Query Params
integer
≥ 1
Defaults to 100

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.

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

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

string

Direction of sorting the response list.

string

Search record by name or a part of the name.

string

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

boolean

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

string

Date from when is record already valid. (YYYY-MM-DD)

string

Date to when is record still valid. (YYYY-MM-DD)

string

Code of the reward.

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)

integer

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

customer_type_id
array of strings

Select by list of customer types from customer-types resource. Logic OR is used between values.

customer_type_id
boolean

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

tag_ids
array of strings

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.

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

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

Responses

Response body
object
data
object
rewards
array of objects

List of all rewards.

rewards
object
string

The unique ID of the reward.

string
required

Code of the reward.

string
required

Name of the reward.

string

Additional text.

string

Text of subtitle.

float

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

string

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

string

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

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

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
string
required

The unique ID of the store in CareCloud.

string
required

External code of the store.

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.

string

Contact email of the store.

string

Name of the store manager.

string

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

string
required

The unique ID of the partner.

string
required

The external unique ID of the store in external system.

gps_coordinates
object

GPS coordinates of the store.

string

URL address of the store.

opening
array of objects

List of opening days.

opening
object
string
required

The unique ID of the day of the week.

time_intervals
array of objects
required

List of time Intervals.

time_intervals*
object
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
integer

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

1

string

Short description of the store.

string

Long description of the store.

string

Legal registration number of the store.

string

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

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
string

The unique ID of the property record.

string
required

The unique ID of the property.

string

Name of the property.

Value of the property.

string

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

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
string

External URL addresses.

boolean

Parameter says, if there is product condition on reward.

boolean

Parameter says, if there is group condition on reward.

boolean

Parameter says, if there is brand condition on reward.

boolean

Parameter says, if there is product bonus on reward.

boolean

Parameter says, if there is group bonus on reward.

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
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

integer

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

float

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

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
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

integer

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

float

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

float

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

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
array of objects

List of the tags assigned to the reward.

tags
object
string

The unique ID of the tag.

string

Name of the tag in language from the HTTP header.

string

Text ID of the tag.

integer

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

1 2

string

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

string

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

integer

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

1 2

integer

The number of all found rewards.

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 over 1 year ago

Did this page help you?
Language
Credentials
URL

Updated over 1 year ago

Did this page help you?