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.
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 |
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 a list of all point reservations
[badge-blue GET] /point-reservations
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 |
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 information about a specific point reservation
[badge-blue GET] /point-reservations/{point_reservation_id}
Parameter name | Type | Description |
---|---|---|
point_reservation_id | string | The unique id of the point reservations |
Status code: 200 OK
Output structure : PointReservation
New point reservation is created.
[badge-green POST] /point-reservations/actions/reserve-points
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 |
Status code: 204 No Content
Release reserved points.
[badge-green POST] /point-reservations/actions/free-points
Parameter name | Type | Description | Mandatory (Yes/No) |
---|---|---|---|
external_id | string | The external id of the point reservation. | Yes |
Status code: 204 No Content