Point reservation

If there is a Loyalty program managed by CRM CareCloud based on points collection to a customer account, the point reservations can be managed by this resource.

Available methods

All available methods for resource point-reservations

HTTP method Endpoint Description
[badge-blue GET] /point-reservations Get information about all point-reservations
[badge-blue GET] /point-reservations/{point_reservation_id} Get information about a specific point reservation

Actions

Action methods for resource point-reservations

HTTP method Endpoint Description
[badge-green POST] /point-reservations/actions/reserve-points Create point reservation. This POST creates a new reservation.
[badge-green POST] /point-reservations/actions/free-points Method release all reserved points in the reservation.


Get all point reservations

Get a list of all point reservations
[badge-blue GET] /point-reservations

Query string

Parameter name Type Description Mandatory (Yes/No)
count integer The number of records to return.
Default value is 100.
No
offset integer The number of records from a collection to skip.
Default value is 0.
No
sort_field string One of the query string parameters for sorting.
Response is sorted by the specified field.
No
sort_direction string Direction of sorting the response list.
Possible values are: ASC / DESC
No
customer_id string The unique id of the customer No
external_id string The external id of the point reservation No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
point_reservations PointResrevation[] List of the point reservations
total_items integer Count of all found point reservations


Get a point reservation

Get information about a specific point reservation
[badge-blue GET] /point-reservations/{point_reservation_id}

Path parameters

Parameter name Type Description
point_reservation_id string The unique id of the point reservations

Response

Status code: 200 OK
Output structure : PointReservation


Create point reservation

New point reservation is created.
[badge-green POST] /point-reservations/actions/reserve-points

Request

Parameter name Type Description Mandatory (Yes/No)
external_id string The external id of the point reservation. Yes
amount float Number of redeemed points. Yes
customer_id string The unique id of the customer. Yes
expiration_time string Date and time of the point reservation expiration (YYYY-MM-DD HH:MM:SS) No

Response

Status code: 204 No Content


Free points from reserevation

Release reserved points.
[badge-green POST] /point-reservations/actions/free-points

Request

Parameter name Type Description Mandatory (Yes/No)
external_id string The external id of the point reservation. Yes

Response

Status code: 204 No Content