Get point transaction history

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

Get a list of point transactions 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.

customer_id

string

required

The unique ID of the customer.

store_id

string

The unique ID of the store in CareCloud.

partner_id

string

Unique ID of the partner from the resource GET /partners.

time_from

string

Filter results on the start of the time interval. (YYYY-MM-DD HH:MM:SS)

time_to

string

Filter results on the end of the time interval. (YYYY-MM-DD HH:MM:SS)

point_operation_type

string

Search record by the operation type name or a part of the operation type name.

point_operation_note

string

Search record by the operation note or a part of the operation note.

point_type_id

string

The unique ID of a point type.

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

point_history

array of objects

List of the point history records.

point_history

object

customer_id

string

The unique ID of the customer.

point_amount

float

The number of points used in the point operation record.

point_operation_type

string

Type of the point operation record.

point_operation_note

string

Note of the point operation record.

point_type_id

string

Type of the point record.

partner_id

string

The unique ID of the partner company.

store_id

string

The unique ID of the store in CareCloud.

point_history_record_time

string

Date and time of the point record from the point history. (YYYY-MM-DD HH:MM:SS)

extended_data

json

Extended data are related to the point history as details about the purchase, point expiration, and others. Several parameters depend on the type of point operation.

total_items

integer

The number of all found point history records.

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


xxxxxxxxxx
18
 
1
{
2
  "data": {
3
    "point_history": [
4
      {
5
        "customer_id": "87af991126405bf8e7dfb36045",
6
        "point_amount": 50,
7
        "point_operation_type": "Points addition",
8
        "point_operation_note": "Manual rewards points for the product purchase collection",
9
        "point_type_id": "81eaeea13b8984a169c490a325",
10
        "partner_id": "86e05affc7a7abefcd513ab400",
11
        "store_id": "86e05affc7a7abefcd513ab400",
12
        "point_history_record_time": "2021-09-16 15:33:11",
13
        "extended_data": "{\"date_of_points_expiration\": null, \"external_purchase_id\": \"97YDFFGIDF78T0Q3\", \"purchase_value\": 23.5}"
14
      }
15
    ],
16
    "total_items": 1
17
  }
18
}

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.