v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB

Product reservations

Get all product reservations

Get a list of product reservations.

get/product-reservations

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.

customer_idstring

The unique ID of the customer. GET /customers

store_idstring

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

reservation_state0 | 1 | 2 | 4 | 5 | 6 | 7 | 8

Current state of the product reservation. Possible values: 0 - Canceled / 1 - Entered / 2 - Accepted / 3 - Ready / 4 - Delivered / 5 - In progress / 6 - Not Picked up / 7 - Ordered / 8 - Being solved /

external_reservation_list_type_idstring

Example:8bc3btbb6f14765b3025cea06c

Every reservation can have more than one external code depends of the business requirements. This parameter allows to pick from witch list of external codes you want to choose. If set, external_reservation_code has to be present in request too. GET /product-reservation-external-list-types

external_reservation_codestring

Code of the reservation from external system (cash-desk, web-shop, production system, others). If set, external_reservation_list_type_id has to be present in request too.

include_reservation_progress_historytrue | false

If true, the response will contain information about the reservation progress history. If false, or not set the response will not return this structure.

Headers

Accept-Languagestring

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

Response

Example response

{
  "data": {
    "product_reservations": [
      {
        "product_reservation_id": "81eaeea13b8984a169c490a325",
        "customer_id": "8ea2591121e636086a4a9c0992",
        "store_id": "82db62087b0f79a6e14e5747e7",
        "reservation_codes": [
          "3DBKBHA"
        ],
        "external_reservation_codes": [
          {
            "external_code_type_id": "86e05affc7a7abefcd513ab400",
            "value": "2107225110"
          }
        ],
        "benefit_codes": [
          "PTV116",
          "PTV120"
        ],
        "product_reservation_source_id": "8bed991c68a470e7aaeffbf048",
        "pickup_date": "2020-04-20",
        "customers_note": "Please add a gift package",
        "total_price": 69,
        "currency_id": "8bed991c68a470e7aaeffbf048",
        "product_reservation_items": [
          {
            "reservable_product_id": "81eaeea13b8984a169c490a325",
            "amount": 1,
            "unit_price": 2300,
            "vat_rate": 5
          }
        ],
        "external_purchase_id": "20231412",
        "utm": {
          "utm_source": "google",
          "utm_medium": "cpc",
          "utm_campaign": "spring_sale"
        },
        "actual_state": 5,
        "reservation_progress_history": [
          {
            "reservation_progress_id": 4,
            "reservation_progress_text": "Delivered",
            "reservation_progress_time": "2012-11-22 20:57:04"
          }
        ],
        "comments": [
          {
            "comment_text": "The customer will pick up the reservation tonight.",
            "comment_time": "2012-11-22 20:57:04"
          }
        ],
        "last_change": "2020-04-20 11:23:35",
        "state": 1
      }
    ],
    "total_items": 1
  }
}