Book Guests in and out


Scope

Property Get / Property Set

Get check-in status

Endpoint

GET https://yourdomain.com/bookyflow/api/bookguestinout/{{property_id}}/{{contract_id}}/
{{url}}{{subdir}}bookyflow/api/bookguestinout/@id/@contractid/(@language)

Path Parameters

Parameter Description
{{property_id}} (Required parameter)
{{contract_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "booking_status": {
      "booked_in": 0,
      "booked_in_date": "",
      "booked_out": 0,
      "booked_out_date": ""
    }
  },
  "meta": {
    "code": 200
  }
}

Checkin guest

Endpoint

PUT https://yourdomain.com/bookyflow/api/bookguestinout/{{property_id}}/{{contract_id}}/checkin/

Put check-in by property uid and contract id

/bookguestinout/@id/@contractid/checkin/

Path Parameters

Parameter Description
{{property_id}} (Required parameter)
{{contract_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "checkin_booked_in": [
      {
        "contract_uid": "34",
        "property_uid": "1",
        "note": "Guest checked in",
        "booked_in": 1
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Undo checkin

Endpoint

PUT https://yourdomain.com/bookyflow/api/bookguestinout/{{property_id}}/{{contract_id}}/undo_checkin/

Path Parameters

Parameter Description
{{property_id}} (Required parameter)
{{contract_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "undo_checkin_booked_in": [
      {
        "contract_uid": "34",
        "property_uid": "1",
        "note": "Undone guest checkin",
        "booked_in": 0
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Check out

Endpoint

PUT https://yourdomain.com/bookyflow/api/bookguestinout/{{property_id}}/{{contract_id}}/checkout/

Path Parameters

Parameter Description
{{property_id}} (Required parameter)
{{contract_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "checkout_bookedout": [
      {
        "contract_uid": "34",
        "property_uid": "1",
        "note": "Guest checked out",
        "bookedout": 1
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Undo checkout

Endpoint

PUT https://yourdomain.com/bookyflow/api/bookguestinout/{{property_id}}/{{contract_id}}/undo_checkout/

Path Parameters

Parameter Description
{{property_id}} (Required parameter)
{{contract_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "undo_checkout_bookedout": [
      {
        "contract_uid": "34",
        "property_uid": "1",
        "note": "Undone guest checkout",
        "bookedout": 0
      }
    ]
  },
  "meta": {
    "code": 200
  }
}