Get all customer vouchers

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/customers/{customer_id}/vouchers

Get information about all customer vouchers.

Path Params

customer_id

string

required

The unique ID of the customer.

Query Params

count

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.

offset

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.

sort_field

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.

sort_direction

string

Direction of sorting the response list.

code

string

Unique code of the voucher.

store_id

string

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

is_valid

boolean

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

is_applied

boolean

Filter by voucher application and reservation.
Possible values: true - all applied or reserved vouchers / false - all vouchers that have not been applied yet or that are not reserved actually / no value - all vouchers

without_stores

boolean

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

reward_id

string

The unique ID of the reward in CareCloud. In case you want to filter multiple options use array syntax : reward_id[]=8bc8ca16f9c5039951021700a2&reward_id[]=82c06812c0756528660784fef

Headers

Accept-Language

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

vouchers

array of objects

List of all recent vouchers.

vouchers

object

voucher_id

string

The unique ID of the voucher.

customer_id

string

required

The unique ID of the customer.

store_id

string

The unique ID of the store where voucher was applied.

code

string

Code of the voucher.

value

float

Value of the voucher when applied by the purchase.

applied_date

string

Voucher application date. (YYYY-MM-DD HH:MM:SS)

valid_from

string

Date from the voucher is valid. (YYYY-MM-DD HH:MM:SS)

valid_to

string

Date to the voucher is valid. (YYYY-MM-DD HH:MM:SS)

reward_group

string

The unique ID of the reward group.

note

string

Voucher's note.

reward

object

Reward structure.

created_at

string

Date of the voucher creation. (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 voucher.
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

total_items

integer

The number of all recent vouchers.

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/customers/customer_id/vouchers?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
131
}
1
{
2
  "data": {
3
    "vouchers": [
4
      {
5
        "voucher_id": "8bb7345976bbc9ed20e5083dd6",
6
        "customer_id": "81ceb8582e2d8dbb7e71b7273b",
7
        "store_id": "86e05affc7a7abefcd513ab400",
8
        "code": "w7TU7KfeE",
9
        "value": 3.49,
10
        "applied_date": "2013-07-24 21:33:13",
11
        "valid_from": "2013-07-10 21:33:13",
12
        "valid_to": "2013-07-30 21:33:13",
13
        "reward_group": "83cfee22eabfbbb15a14815e30",
14
        "note": "Contact before use",
15
        "reward": {
16
          "reward_id": "83cfee22eabfbbb15a14815e30",
17
          "code": null,
18
          "name": "Dessert+Caffe",
19
          "note": "",
20
          "subtitle": null,
21
          "points_cost": 200,
22
          "valid_time_from": null,
23
          "valid_time_to": null,
24
          "reward_group": 0,
25
          "reward_type_id": "8fdd651ff3f615bcebebad87ce",

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.