Get all customer vouchers

get

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

Get information about all customer vouchers.

Vouchers are redeemable discount or reward certificates stored on a customer's account. They are typically issued as part of a reward redemption or marketing campaign. Each voucher has a value, validity period, and redemption status.

Related: GET /vouchers

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

enum

Direction of sorting the response list.

Allowed:

code

string

Unique code of the voucher.

store_id

string

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

is_valid

boolean

enum

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

Allowed:

is_applied

boolean

enum

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

Allowed:

without_stores

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:

reward_id

string

The unique ID of the reward in CareCloud. GET /rewards 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

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

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access an unauthorized property or resource.

404The request path does not match any API route, or the addressed resource does not exist.

405The request path matches a valid route, but the endpoint does not support the HTTP method used in the request.

500Server is not working as expected.