Introduction

Core resources

Attribute options
Attributes
Booking details
Booking updates
Bookings
Calendar event notes
Calendar event tasks
Calendar event updates
Calendar events
Capacities
Capacity group dependencies
Capacity groups
Contact bookings
Contacts
Coupon products
Coupon services
Coupon uses
Coupons
Email events
Email templates
Emails
External calendars
Invoices
Line item taxes
Line items
Members
Payments
Permissions
Product attribute options
Product calendar logs
Product configurations
Product email templates
Product reply to addresses
Product services
Product tasks
Products
Reply to addresses
Seasons
Service deposit moments
Service deposit taxes
Service discounts
Service payment moments
Service taxes
Services
Site listings
Site nav items
Site pages
Site views
Sites
Taxes
User profiles
Webhook notifications
Webhooks
Widget listings
Widget views
Widgets

Administration

Invite member
Revoke member
Create product
Delete product

Booking flow

Query availability
Search availability
Book

Widget listings

Units listed in a widget

Endpoints
GET/widget_listingsPOST/widget_listingsDELETE/widget_listingsPATCH/widget_listings

The widget listing object

Attributes

iduuid

Unique identifier

product_iduuid
products.id

Identifier of the related unit

widget_iduuid
widgets.id

Identifier of the related widget

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

ordersmallint

Order of the listing as displayed in the widget

urljsonb

URL of the listing. Only applies when widget.interaction is forward

The widget listing object
{
"id": "00000000-0000-0000-0000-000000000000",
"product_id": "00000000-0000-0000-0000-000000000000",
"widget_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-11-21T09:06:54.216Z",
"updated_at": "2024-11-21T09:06:54.216Z",
"order": 0,
"url": {}
}

List widget listings

Filters

idFilter<>

Unique identifier

product_idFilter<>

Identifier of the related unit

widget_idFilter<>

Identifier of the related widget

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

orderFilter<>

Order of the listing as displayed in the widget

urlFilter<>

URL of the listing. Only applies when widget.interaction is forward

Responses

200

A list of widget listings with the selected columns

206

Partial Content

GET/widget_listings
curl -X GET "https://api.bookingmood.com/v1/widget_listings?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create widget listings

Body

Partial<WidgetListing>
| Array<Partial<WidgetListing>>

Responses

201

The newly created widget listings with the selected columns

POST/widget_listings
curl -X POST "https://api.bookingmood.com/v1/widget_listings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '[]'

Delete widget listings

Filters

idFilter<>

Unique identifier

product_idFilter<>

Identifier of the related unit

widget_idFilter<>

Identifier of the related widget

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

orderFilter<>

Order of the listing as displayed in the widget

urlFilter<>

URL of the listing. Only applies when widget.interaction is forward

Responses

204

The deleted widget listings with the selected columns

DELETE/widget_listings
curl -X DELETE "https://api.bookingmood.com/v1/widget_listings" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update widget listings

Filters

idFilter<>

Unique identifier

product_idFilter<>

Identifier of the related unit

widget_idFilter<>

Identifier of the related widget

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

orderFilter<>

Order of the listing as displayed in the widget

urlFilter<>

URL of the listing. Only applies when widget.interaction is forward

Body

Partial<WidgetListing>

Responses

204

The updated widget listings with the selected columns

PATCH/widget_listings
curl -X PATCH "https://api.bookingmood.com/v1/widget_listings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'