Coupon

Coupon related functionality

Scope

Property Get / Property Set

Get coupons

Endpoint

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

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "coupons": [
      {
        "coupon_id": 15,
        "coupon_code": "discount10",
        "valid_from": "2019-01-25",
        "valid_to": "2021-01-31",
        "amount": 10,
        "ispercentage": "Yes",
        "roomonly": "No",
        "booking_valid_from": "2019-01-25",
        "booking_valid_to": "2021-01-31",
        "guest_name": ""
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Add coupon

Endpoint

POST https://yourdomain.com/bookyflow/api/coupon/{{property_id}}/{{coupon_valid_from}}/{{coupon_valid_to}}/{{coupon_amount}}/{{coupon_is_percentage}}/{{coupon_booking_valid_from}}/{{coupon_booking_valid_to}}/{{coupon_guest_id}}

@guest_id is optional, if ommitted then the coupon is available to any guest that knows it.

Path Parameters

Parameter Description
{{property_id}} (Required parameter)
{{coupon_valid_from}} (Required parameter)
{{coupon_valid_to}} (Required parameter)
{{coupon_amount}} (Required parameter)
{{coupon_is_percentage}} (Required parameter)
{{coupon_booking_valid_from}} (Required parameter)
{{coupon_booking_valid_to}} (Required parameter)
{{coupon_guest_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "addcoupon": {
      "property_uid": "1",
      "coupon_code": "lXcDWbtSWWAmrJA",
      "valid_from": "2019-10-23",
      "valid_to": "2020-01-01",
      "amount": "20",
      "is_percentage": 1,
      "booking_valid_from": "2019-12-01",
      "booking_valid_to": "2019-12-12",
      "guest_uid": 0
    }
  },
  "meta": {
    "code": 200
  }
}

Modify coupon

Endpoint

PUT https://yourdomain.com/bookyflow/api/coupon/{{property_id}}/{{coupon_id}}/{{coupon_code}}/{{coupon_valid_from}}/{{coupon_valid_to}}/{{coupon_amount}}/{{coupon_is_percentage}}/{{coupon_booking_valid_from}}/{{coupon_booking_valid_to}}

Path Parameters

Parameter Description
{{property_id}} (Required parameter)
{{coupon_id}} (Required parameter)
{{coupon_code}} (Required parameter)
{{coupon_valid_from}} (Required parameter)
{{coupon_valid_to}} (Required parameter)
{{coupon_amount}} (Required parameter)
{{coupon_is_percentage}} (Required parameter)
{{coupon_booking_valid_from}} (Required parameter)
{{coupon_booking_valid_to}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "updatecoupon": [
      {
        "property_uid": "1",
        "coupon_id": "17",
        "coupon_code": "tCFMJzvaLhqiAID_XXXX",
        "valid_from": "2019-10-23",
        "valid_to": "2020-01-01",
        "amount": "20",
        "is_percentage": 1,
        "booking_valid_from": "2019-12-01",
        "booking_valid_to": "2019-12-12",
        "guest_uid": 0
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Delete Coupon

Endpoint

DELETE https://yourdomain.com/bookyflow/api/coupon/{{property_id}}/{{coupon_id}}

Path Parameters

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

Response Example

Status: OK (200)

{
  "data": {
    "coupondeleted": "17"
  },
  "meta": {
    "code": 200
  }
}