v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Reservable products

Get all reservable products

Get the information as a list of reservable products.

get/reservable-products

Query parameters

countinteger

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.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

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'ASC' | 'DESC'

Direction of sorting the response list.

namestring

Search record by name or a part of the name.

codestring

Code of the product.

store_idstring

The unique ID of the store in CareCloud. GET /stores

tag_idsstring[]

Parameter filters values by a list of tag IDs. Logic OR is used between values.

In case you want to filter multiple options use array syntax : tag_ids[]=8bc8ca16f9c5039951021700a2&tag_ids[]=82c06812c0756528660784fef

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "reservable_products": [
      {
        "product_id": "85d6598db0bf3f62afd5db8507",
        "name": "Google phone 1",
        "code": "649",
        "external_id": "NKBD7TB",
        "plu_ids": [
          {
            "list_code": "GLOBAL",
            "code": "abc"
          }
        ],
        "product_group_id": "82de12eb8b138791e678fd11c3",
        "product_brand_id": "82db62087b0f79a6e14e5747e7",
        "partner_id": "86e05affc7a7abefcd513ab400",
        "prices": [
          {
            "currency_id": "86e05affc7a7abefcd513ab400",
            "value": 650
          }
        ],
        "additional_properties": [
          {
            "property_record_id": "docasna_blokace_darce_do:8ea2591121e636086a4a9c0992",
            "property_id": "docasna_blokace_darce_do",
            "property_name": "Property #6",
            "last_change": "2023-02-02 00:00:00"
          }
        ],
        "last_change": "2022-11-01 13:15:24",
        "state": 1,
        "tags": [
          {
            "tag_id": "838b73aacb5ac326cec4030c80",
            "name": "Recommended",
            "text_id": "recommended_tag",
            "state": 1,
            "last_change": "2019-01-04 10:31:56"
          }
        ]
      }
    ],
    "total_items": 1
  }
}