Introduction

The 5.10.0 version of the Booking & Appointment Plugin for WooCommerce ( BKAP ) has introduced the REST API feature which allows Booking data to be created, read, updated and deleted.

The Booking & Appointment REST API has been implemented as an extension of the WooCommerce API, which makes the API inherit and implement all the security and structural advantages that the WooCommerce API has to offer.

Requirements

1. WooCommerce 3.5+
2. WordPress 4.4+
3. Booking & Appointment Plugin 5.10.0+
4. WordPress Pretty Permalinks – must be enabled
5. WooCommerce Consumer and Secret Keys – must be generated
6. Legacy REST API – must be enabled

Please read this tutorial for further information on setting up the above requirements. Technical documentation for the WooCommerce REST API can also be found here. 

HTTP Methods

A number of HTTP methods or verbs have been used in the Booking & Appointment API.

1. POST: This method is used to create Booking data on an endpoint.
2. GET: This method is used to retrieve/read Booking data on an endpoint.
3. PUT: This method is used to update Booking data on an endpoint.
4. DELETE: This method is used to delete Booking data on an endpoint.

API Endpoints

There are three endpoints available in the Booking & Appointment API, with each endpoint providing the means through which external services can interact and carry out various functions.

1. Bookings endpoint: <store-url>/wc-api/v3/bkap/bookings, supports GET, POST, PUT and DELETE methods
2. Booking Resources endpoint: <store-url>/wc-api/v3/bkap/resources, supports GET and DELETE methods
3. Booking Products: <store-url>/wc-api/v3/bkap/products, supports GET, PUT and DELETE methods

API Authentication

The following data are required for proper authentication:

• Consumer Key
• Consumer Secret

The authorization can be done based on base64 basic authorization, where the Consumer Key and Consumer Secret Key are concatenated and subsequently encoded.

Here is a sample request:

Testing the API on Postman

Postman can be used to conduct some test runs on the API before production. Please install Postman via this download link: https://www.postman.com/downloads/

Make sure to confirm that the following have been done:

1. WooCommerce API is enabled. To do this, go to WooCommerce -> Settings -> Advanced -> Rest API.
2. Consumer keys and Consumer Secret keys have been created with Read/Write permissions.
3. Legacy API for WooCommerce has been enabled.

Launch Postman set the Authorization Type to Basic Auth. Key in your Consumer and Secret Key in the Authorization tab. Key them in the Username and Password text boxes respectively. Please see the image below.

Request parameters for any of the endpoints in the Booking & Appointment API are usually sent in JSON format on the Postman app. To do this, go to the Body tab ( before Headers tab and after Pre-request Script tab), set the request as raw and select JSON as the format. Please see the image below.

Bookings API Endpoint

List Bookings

Here, all the bookings in the database are returned. Filters can also be used to limit the data returned.

Parameters

Request

{
    "product_id": 68,
    "customer_id": 2,
    "limit": 10,
    "quantity": 1,
    "status": "paid"
}

List Booking Information for a Booking ID

Here, Booking information for a particular Booking ID can be requested. The Booking ID has to be passed in the URL as shown in the Request below. Replace <BOOKING_ID> with the ID of the Booking.

This creates a new booking.

Parameters

Request

Single Day/Dates Booking Type – Single Selection Resource Type 

{
    "product_id": 273,
    "quantity": 1,
    "start_date": "2021-09-24",
    "end_date": "2021-09-24",
    "price": 150,
    "customer_id": 1,
    "resource_id":10
}

{
    "product_id": 273,
    "quantity": 1,
    "start_date": "2021-09-24",
    "end_date": "2021-09-24",
    "price": 150,
    "customer_id": 1,
    "resource_id": [ 18, 22, 35 ]
}

{
    "product_id": 273,
    "quantity": 1,
    "start_date": "2021-09-24",
    "end_date": "2021-09-24",
    "price": 150,
    "customer_id": 1,
    "fixed_block": 4
}

{
    "product_id": 273,
    "quantity": 1,
    "start_date": "2021-09-24",
    "end_date": "2021-09-24",
    "start_time": "13:30",
    "end_time": "14:30",
    "price": 150,
    "customer_id": 1
}

{
    "product_id": 273,
    "quantity": 1,
    "start_date": "2021-09-24",
    "end_date": "2021-09-24",
    "price": 150,
    "customer_id": 1,
    "duration": 60
}

{
    "product_id": 273,
    "quantity": 1,
    "price": 150,
    "customer_id": 1,
    "dates": [
        "2021-09-24",
        "2021-09-25"
    ]
}

{
    "product_id": 273,
    "quantity": 1,
    "price": 150,
    "customer_id": 1,
    "dates": [
        {
            "start_time":"13:30",
            "end_time": "14:30",
            "date": "2021-09-23"
        },
        {
            "start_time":"07:00",
            "end_time": "10:00",
            "date": "2021-09-24"
        }
    ]
}

{
    "quantity":2,
    "status":"paid",
    "price":400,
    "start_date": "2021-09-29",
    "start_time": "10:00",
    "end_time": "11:00"
}

Delete Booking

This deletes an existing booking. The Booking ID has to be passed in the URL as shown in the Request below. Replace <BOOKING_ID> with the ID of the Booking.

{
    "product_id":48,
    "start_date":"paid",
    "start_date": "2021-09-25",
    "end_date": "2021-09-29",
}

{
    "product_id": 68,
    "start_date": "2024-09-29",
    "quantity": 1
}

{
    "product_id": 69,
    "start_date": "2024-09-29",
    "end_date": "2024-10-05",
    "quantity": 1
}

{
    "product_id": 70,
    "start_date": "2024-09-10",
    "start_time": "09:00",
    "end_time": "10:00",
    "quantity": 1
}

{
    "product_id": 71,
    "start_date": "2024-09-15",
    "start_time": "09:00",
    "duration": 2,
    "quantity": 1
}

{
    "total_price_calculated": "1000.00",
    "bkap_price_charged": "1000.00",
    "bkap_price": "Total: 1,000.00 $"
}

{
    "product_id": 68,
    "customer_id": 2,
    "limit": 10,
    "quantity": 1
}

{
    "booking_type": "only_day",
    "limit": 2,
    "price": 50,
}

{
    "booking": {
        "enable_booking": "on",
        "booking_type": "only_day",
        "enable_inline_calendar": "on",
        "booking_can_be_cancelled": "off"
    }
}