Product reservations

CRM CareCloud allows to reserve Products or Product sets and manages the reservation process. There is the possibility to create a particular group of Products that can be reserved - Reservable products. This resource can make the Reservation of a Product.

Available methods

All available methods for resource product-reservations.

HTTP method Endpoint Description
[badge-green POST] /product-reservations Create a product reservation
[badge-blue GET] /product-reservations Get a list of product reservations
[badge-blue GET] /product-reservations/{product_reservation_id} Detail of a product reservation

Actions

Action methods for resource product reservations

HTTP method Endpoint Description
[badge-green POST] /product-reservations/{product_reservation_id}/actions/cancel-reservation Cancel an existing product reservation.

Create a reservation

Create a new product reservation in CRM CareCloud
[badge-green POST] /product-reservations

Request

Parameter name Type Description Mandatory (Yes/No)
product_reservation ProductReservation ProductReservation structure Yes

Response

Status code: 201 Created
Output structure : object

Parameter name Type Description
product_reservation_id string The unique id for the product reservation

Get all product reservations

Get a list of product reservations
[badge-blue GET] /product-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
reservation_code string Code of the reservation No
customer_id string The unique id for the customer No
store_id string Store, where customer can pick up the reservation No

Response

Status code: 200 OK
Output structure : object

Parameter name Type Description
product_reservations ProductReservation[] List of the product reservations
total_items integer Count of all found product reservations

Get a product-reservation

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

Path parameters

Parameter name Type Description
product_reservation_id string The unique id for a product reservation

Response

Status code: 200 OK
Output structure : ProductReservation


Cancel reservation

Cancel an existing reservation.
[badge-green POST] /product-reservations/{product_reservation_id}/actions/cancel-reservation

Path parameters

Parameter name Type Description Mandatory (Yes/No)
product_reservation_id string The unique id of the product reservation. Yes

Request

Parameter name Type Description Mandatory (Yes/No)
customer_id string The unique id for a logged in customer No

Response

Status code: 204 No Content