Introduction

In our continuous effort to enhance the functionality and compatibility of the Booking & Appointment Plugin for WooCommerce, we have implemented significant updates to align with the latest WooCommerce REST API standards. This document outlines the changes, ensuring you can seamlessly transition and leverage the new capabilities.

Background

Previously, the Booking & Appointment Plugin for WooCommerce depended on the WooCommerce Legacy API. With the release of WooCommerce v9.0, the Legacy API has been deprecated. To ensure the plugin remains functional and future-proof, we have updated it to be fully compatible with the WooCommerce REST API.

Key Enhancements

1. Compatibility with WooCommerce REST API

We have updated the plugin to ensure full compatibility with the current WooCommerce REST API standards. This enhancement improves the plugin’s robustness, scalability, and performance, ensuring that your booking and appointment management integrates seamlessly with WooCommerce.

2. New Endpoints

New endpoints have been added to the plugin’s API, allowing for more comprehensive interactions and data management. These endpoints offer more flexibility and control over booking operations, enhancing the user experience for administrators and customers.

3. Backward Compatibility

We have retained the old endpoints from the WooCommerce Legacy API to support existing integrations and workflows. This means your current integrations will continue functioning without interruption, providing a smooth transition to the new API.

What to Expect in this Post

In this post, we will learn about the new endpoints added, how they enhance the functionality of the plugin, and how they are designed to align with the latest WooCommerce REST API standards (wc/v3). We will also cover detailed information on managing resources, products, and bookings through these endpoints.

Requirements

1. WooCommerce 9.0+
2. WordPress 5.0+
3. Booking & Appointment Plugin 6.5.0+
4. WordPress Pretty Permalinks – must be enabled
5. WooCommerce Consumer and Secret Keys – must be generated

HTTP Methods

Several 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.

Namespace – `wc/v3`

The wc/v3 namespace is part of the WooCommerce REST API, which provides a more standardized and consistent interface for interacting with WooCommerce data. This namespace represents the third version of the API, reflecting the latest updates and improvements.

Base – `bkap`

The bkap base in the Booking & Appointment Plugin for WooCommerce API is designed to facilitate the management of booking-related operations. This base is built on top of the WooCommerce REST API framework, ensuring seamless integration and compatibility with WooCommerce’s existing infrastructure.

The bkap base provides endpoints for various operations related to bookings, resources, and products, allowing developers to programmatically manage these aspects of their WooCommerce store. Below are detailed descriptions of the key endpoints available under the bkap base.

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: supports GET, POST, PUT and DELETE methods
   Endpoint – <store-url>/wp-json/wc/v3/bkap/bookings
2. Resources: supports GET and DELETE methods
   Endpoint – <store-url>/wp-json/wc/v3/bkap/resources
3. Products: supports GET, PUT, and DELETE methods
   Endpoint – <store-url>/wp-json/wc/v3/bkap/products

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:

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"
    }
}