v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Product reservations

Create a reservation

Create a new product reservation in the CareCloud platform.

post/product-reservations

Headers

Accept-Languagestring

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

Request body

Example request

{
  "product_reservation": {
    "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
  }
}

Response

Created

Example response

{
  "data": {
    "product_reservation_id": "81d503b99cc748b3ca189383ad"
  }
}