skip to Main Content

Bookly CRED Rest API Operations

Here are the key features of Bookly CRED Rest API Operations Plugin

  • Appointment
    • Get Appointment details
    • Create New Appointment
    • Update Appointment
    • Delete Appointment
    • Filter Appointments based on date range, staff and customer email
  • Staff
    • Get Staff details
    • Create Staff
    • Update Staff
    • Delete Staff
  • Services
    • Get Services details
    • Create Services
    • Update Services
    • Delete Services
  • Customer
    • Get Customer Details
    • Get Customer
    • Update Customer
    • Delete Customer

Bookly Appointments Rest API URL :

https://SITEURL/wp-json/wp/v2/wpo_bookly_appointments

Bookly Get Single Appointment Details Rest API URL :
https://SITEURL/wp-json/wp/v2/wpo_bookly_appointments/appointmentid

Post Request Data Sample for Creating New Appointment

{
	"series_id": null,
	"location_id": null,
	"staff_id": "1",
	"staff_any": "0",
	"service_id": "2",
	"custom_service_name": null,
	"custom_service_price": null,
	"start_date": "2018-11-12 11:30:00",
	"end_date": "2018-11-12 12:30:00",
	"extras_duration": "0",
	"internal_note": "testing content goes here",
	"google_event_id": null,
	"google_event_etag": null,
	"created_from": "bookly",
	"customer_appointment": {
		"customer_id": "1",
		"number_of_persons": "1",
		"units": "1",
		"status": "approved",
		"notes": null
	},
	"payment_details":{
		"coupon_id": null, 
		"type": "local", 
		"total": "45", 
		"tax": "0", 
		"paid": "45", 
		"paid_type": "in_full", 
		"gateway_price_correction": null, 
		"status": "completed", 
		"details": {
	"items":
			[
				{
					"ca_id":3,
					"appointment_date":"2018-11-12 10:15:00",					
					"service_name":"WordPress",
					"service_price":23,
					"service_tax":0,
					"wait_listed":false,
					"deposit_format":null,
					"number_of_persons":"1",
					"units":"1",
					"duration":"900",
					"staff_name":"Gerald",
					"extras":[]
				}
			],
			"coupon":null,
			"subtotal":
						{
							"price":23,
							"deposit":0
						},
			"customer":"admin",
			"tax_in_price":"excluded",
			"adjustments":
							[
								{
									"reason":"testing reason",
									"amount":"23",
									"tax":"0"
								}
							],
			"tax_paid":"0.00"
		},
		"created":"2018-11-12 12:40:47"
	}
}

Post Request Data Sample for Updating Appointment

{
	"series_id": null,
	"location_id": null,
	"staff_id": "2",
	"staff_any": "0",
	"service_id": "2",
	"custom_service_name": null,
	"custom_service_price": null,
	"start_date": "2018-11-12 11:30:00",
	"end_date": "2018-11-12 12:30:00",
	"extras_duration": "0",
	"internal_note": "Lorem Ipsum",
	"google_event_id": null,
	"google_event_etag": null,
	"created_from": "rest api"
	
}

Bookly Appointments Rest API Filters :

  • Filter by Staff Email
    https://SITEURL/wp-json/wp/v2/wpo_bookly_appointments?filter[staff]=staffemailid
  • Filter by Customer Email
    https://SITEURL/wp-json/wp/v2/wpo_bookly_appointments?filter[customer]=customeremailid
  • Filter by Month
    https://SITEURL/wp-json/wp/v2/wpo_bookly_appointments?filter[month]=8
  • Filter by Today
    https://SITEURL/wp-json/wp/v2/wpo_bookly_appointments?filter[appointments]=today
  • Filter by Date Range
    https://SITEURL/wp-json/wp/v2/wpo_bookly_appointments?filter[startdate]=2018-08-01&filter[enddate]=2018-09-15

Bookly Staff Rest API URL :

https:/SITEURL/wp-json/wp/v2/wpo_bookly_staff

Bookly Single Staff Details Rest API URL :
https://SITEURL/wp-json/wp/v2/wpo_bookly_staff/staffid

Bookly Staff Post Request Sample Data for Update/Create :

{
    "wp_user_id": "1",
    "profile_image": "https://wpintegrate.com/wp-content/uploads/2016/07/logo-wpoffice.png",
    "full_name": "Christopher Hunt",
    "email": "[email protected]",
    "phone": "121212121",
    "info": "lorem ispum",
    "visibility": "public",
    "position": "9999",
    "google_data": null
}

Bookly Services Rest API URL :

https://SITEURL/wp-json/wp/v2/wpo_bookly_services

Bookly Get Single Service Details Rest API URL :
https://SITEURL/wp-json/wp/v2/wpo_bookly_services/serviceid

Bookly Service Post Request Sample Data for Update/Create

 {
	"id": "1",
	"category_id": "1", or use to create new category like this "category_name": "Development"
	"title": "WordPress",
	"duration": "900",
	"price": "13.00",
	"color": "#1D0CAB",
	"capacity_min": "1",
	"capacity_max": "1",
	"padding_left": "0",
	"padding_right": "0",
	"info": "Lorem ipsum WordPress development",
	"start_time_info": "",
	"end_time_info": "",
	"units_min": "1",
	"units_max": "1",
	"type": "simple",
	"package_life_time": null,
	"package_size": null,
	"package_unassigned": "0",
	"appointments_limit": null,
	"limit_period": "off",
	"staff_preference": "most_expensive",
	"recurrence_enabled": "1",
	"recurrence_frequencies": "daily,weekly,biweekly,monthly",
	"visibility": "public",
	"position": "9999"
   } 

Bookly Customers Rest API URL :

https://SITEURL/wp-json/wp/v2/wpo_bookly_customers

Bookly Get Single Customers Details Rest API URL :
https://SITEURL/wp-json/wp/v2/wpo_bookly_customers/customerid

Bookly Customers Post Request Sample Data for Update/Create

{
	"wp_user_id": "1",
	"facebook_id": null,
	"group_id": null,
	"full_name": "kevin jones",
	"first_name": "kevin",
	"last_name": "jones",
	"phone": "918-459-4582",
	"email": "[email protected]",
	"birthday": "2001-11-17",
	"country": "USA",
	"state": "OK",
	"postcode": "74133",
	"city": "Tulsa",
	"street": "7633 E 63rd Pl",
	"street_number": "",
	"additional_address": "",
	"notes": "Lorem Ipsum",
	"info_fields": "null",
	"created": "2018-11-17 12:25:35"
    }



Back To Top