Guest types

Scope

Property Get / Property Set

Get Guest types

Endpoint

GET https://yourdomain.com/bookyflow/api/guesttypes/{{property_id}}

Path Parameters

Response Example

Status: OK (200)

{
  "data": {
    "guesttypes": [
      {
        "id": 18,
        "type": "adult",
        "notes": "",
        "maximum": 10,
        "is_percentage": 0,
        "posneg": 0,
        "variance": 0,
        "published": 1,
        "property_uid": 1,
        "order": 0,
        "is_child": 0
      },
      {
        "id": 19,
        "type": "child",
        "notes": "",
        "maximum": 10,
        "is_percentage": 1,
        "posneg": 0,
        "variance": 100,
        "published": 1,
        "property_uid": 1,
        "order": 0,
        "is_child": 1
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Create guest type

Endpoint

POST https://yourdomain.com/bookyflow/api/guesttypes/{{property_id}}/{{guest_type}}/{{guest_type_notes}}/{{guest_type_maximum}}/{{guest_type_is_percentage}}/{{guest_type_posneg}}/{{guest_type_variance}}/{{guest_type_published}}/{{guest_type_order}}/{{guest_type_is_child}}/

Type refers to the title as it would be shown in the booking form. Notes are just that, notes for internal use. Maximum reflects the maximum of that guest type that can be selected in the booking form. The variance refers to how selection of this guest type modifies it's cost to the booking, for example a variance of 10 and a is_percentage value of 1 would mean that these guest types would receive a 10% discount when booking. Posneg refers to whether the variance will add or subtract from the cost of the booking. Order reflects the order of the guest types as they appear in the booking form, it is mandatory, send 0 if you don't care what the order should be. Is child should be either 1 or 0, it's used by channel managers.

Path Parameters

Response Example

Status: OK (200)

{
  "data": {
    "addguesttype": [
      {
        "message": "Created customer type",
        "id": 23,
        "type": "Pensioner",
        "notes": "Blah dee blah",
        "maximum": "10",
        "is_percentage": "1",
        "posneg": "1",
        "variance": "0",
        "published": "1",
        "property_uid": "1",
        "order": "0",
        "is_child": "0"
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Modify Guest type

Endpoint

PUT https://yourdomain.com/bookyflow/api/guesttypes/{{property_id}}/{{guest_type_id}}/{{guest_type}}/{{guest_type_notes}}/{{guest_type_maximum}}/{{guest_type_is_percentage}}/{{guest_type_posneg}}/{{guest_type_variance}}/{{guest_type_published}}/{{guest_type_order}}/{{guest_type_is_child}}/

Path Parameters

Response Example

Status: OK (200)

{
  "data": {
    "updateguesttype": [
      {
        "message": "Updated customer type",
        "type": "Pensioner",
        "notes": "Blah dee blah",
        "maximum": 10,
        "is_percentage": 1,
        "posneg": 1,
        "variance": 0,
        "published": 1,
        "property_uid": "1",
        "guesttype_uid": 23,
        "order": 0,
        "is_child": 0
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Delete Guest type

Endpoint

DELETE https://yourdomain.com/bookyflow/api/guesttypes/{{property_id}}/{{guest_type_id}}/

Path Parameters

Response Example

Status: OK (200)

{
  "data": {
    "deleteguesttype": [
      {
        "message": "Deleted customer type",
        "property_uid": "1",
        "guesttype_uid": "23"
      }
    ]
  },
  "meta": {
    "code": 200
  }
}