Core resources
Administration
Booking flow
Units that can be booked individually
id
uuid
Unique identifier
ac_id
text | null
Identifier for products imported from AvailabilityCalendar.com
organization_id
uuid
Identifier of the organization this product is defined in
created_at
timestamp with time zone
Creation timestamp
updated_at
timestamp with time zone
Last modification timestamp
deleted_at
timestamp with time zone | null
Timestamp at which the unit was deleted
approximate_address
text | null
Approximate address of the unit
approximate_coordinates
jsonb | null
Coordinates of the approximate address
cancel_after_initial_payment_error
boolean
confirm_after_initial_payment
boolean
Whether to automatically confirm the booking after the initial payment. Only applies when interaction is request
confirmation_message
jsonb
Message to show to the customer after submitting a booking from a widget or website
cooldown_time
integer
Minimum number of days between bookings. Only applies when rent_pricing_definition is services
cta
jsonb
Call to action shown at the bottom of the booking form
currency
text
Currency bookings are made in
description
jsonb
Localized description
exact_address
text | null
Exact address of the unit
exact_coordinates
jsonb | null
Coordinates of the exact address
fts
tsvector
Full text search index
hide_exact_address
boolean
Whether to hide the exact address from customers before bookings are confirmed
ical_export_secret
text
Secret used to generate iCal feed URLs
ical_export_secret_no_details
text
Secret used to generate iCal feed URLs without booking details
images
json
List of images
interaction
text
Interaction type, either request
or book
latest_arrival_time
time without time zone | null
name
jsonb
Localized name
price_breakdown_specificity
text
rent_period
"daily" | "nightly"
Rent period of the unit
rent_pricing_definition
text
Pricing definition of the unit. Either configuration
or services
request_status
"CANCELLED" | "TENTATIVE" | "CONFIRMED"
Status of new bookings. Only applies when interaction is request
timezone
text
Timezone of the unit
{"id": "00000000-0000-0000-0000-000000000000","ac_id": "","organization_id": "00000000-0000-0000-0000-000000000000","parent_id": "00000000-0000-0000-0000-000000000000","created_at": "2024-05-11T15:16:06.805Z","updated_at": "2024-05-11T15:16:06.805Z","deleted_at": "2024-05-11T15:16:06.805Z","approximate_address": "","approximate_coordinates": {},"cancel_after_initial_payment_error": false,"confirm_after_initial_payment": false,"confirmation_message": {},"cooldown_time": 0,"cta": {},"currency": "","description": {},"exact_address": "","exact_coordinates": {},"hide_exact_address": false,"ical_export_secret": "","ical_export_secret_no_details": "","images": null,"interaction": "request","latest_arrival_time": null,"name": {},"price_breakdown_specificity": "combined","rent_period": "nightly","rent_pricing_definition": "configurations","request_status": "TENTATIVE","timezone": "UTC"}
id
Filter<uuid>
Unique identifier
ac_id
Filter<text>
Identifier for products imported from AvailabilityCalendar.com
organization_id
Filter<uuid>
Identifier of the organization this product is defined in
parent_id
Filter<uuid>
Identifier of the parent unit
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
deleted_at
Filter<timestamp with time zone>
Timestamp at which the unit was deleted
approximate_address
Filter<text>
Approximate address of the unit
approximate_coordinates
Filter<jsonb>
Coordinates of the approximate address
cancel_after_initial_payment_error
Filter<boolean>
confirm_after_initial_payment
Filter<boolean>
Whether to automatically confirm the booking after the initial payment. Only applies when interaction is request
confirmation_message
Filter<jsonb>
Message to show to the customer after submitting a booking from a widget or website
cooldown_time
Filter<integer>
Minimum number of days between bookings. Only applies when rent_pricing_definition is services
cta
Filter<jsonb>
Call to action shown at the bottom of the booking form
currency
Filter<text>
Currency bookings are made in
description
Filter<jsonb>
Localized description
exact_address
Filter<text>
Exact address of the unit
exact_coordinates
Filter<jsonb>
Coordinates of the exact address
fts
Filter<tsvector>
Full text search index
hide_exact_address
Filter<boolean>
Whether to hide the exact address from customers before bookings are confirmed
ical_export_secret
Filter<text>
Secret used to generate iCal feed URLs
ical_export_secret_no_details
Filter<text>
Secret used to generate iCal feed URLs without booking details
images
Filter<json>
List of images
interaction
Filter<text>
Interaction type, either request
or book
latest_arrival_time
Filter<time without time zone>
name
Filter<jsonb>
Localized name
price_breakdown_specificity
Filter<text>
rent_period
Filter<"daily" | "nightly">
Rent period of the unit
rent_pricing_definition
Filter<text>
Pricing definition of the unit. Either configuration
or services
request_status
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
Status of new bookings. Only applies when interaction is request
timezone
Filter<text>
Timezone of the unit
200
A list of products with the selected columns
206
Partial Content
GET
/products
curl -X GET "https://api.bookingmood.com/v1/products?select=*" \ -H "Authorization: Bearer YOUR_API_KEY"
id
Filter<uuid>
Unique identifier
ac_id
Filter<text>
Identifier for products imported from AvailabilityCalendar.com
organization_id
Filter<uuid>
Identifier of the organization this product is defined in
parent_id
Filter<uuid>
Identifier of the parent unit
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
deleted_at
Filter<timestamp with time zone>
Timestamp at which the unit was deleted
approximate_address
Filter<text>
Approximate address of the unit
approximate_coordinates
Filter<jsonb>
Coordinates of the approximate address
cancel_after_initial_payment_error
Filter<boolean>
confirm_after_initial_payment
Filter<boolean>
Whether to automatically confirm the booking after the initial payment. Only applies when interaction is request
confirmation_message
Filter<jsonb>
Message to show to the customer after submitting a booking from a widget or website
cooldown_time
Filter<integer>
Minimum number of days between bookings. Only applies when rent_pricing_definition is services
cta
Filter<jsonb>
Call to action shown at the bottom of the booking form
currency
Filter<text>
Currency bookings are made in
description
Filter<jsonb>
Localized description
exact_address
Filter<text>
Exact address of the unit
exact_coordinates
Filter<jsonb>
Coordinates of the exact address
fts
Filter<tsvector>
Full text search index
hide_exact_address
Filter<boolean>
Whether to hide the exact address from customers before bookings are confirmed
ical_export_secret
Filter<text>
Secret used to generate iCal feed URLs
ical_export_secret_no_details
Filter<text>
Secret used to generate iCal feed URLs without booking details
images
Filter<json>
List of images
interaction
Filter<text>
Interaction type, either request
or book
latest_arrival_time
Filter<time without time zone>
name
Filter<jsonb>
Localized name
price_breakdown_specificity
Filter<text>
rent_period
Filter<"daily" | "nightly">
Rent period of the unit
rent_pricing_definition
Filter<text>
Pricing definition of the unit. Either configuration
or services
request_status
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
Status of new bookings. Only applies when interaction is request
timezone
Filter<text>
Timezone of the unit
Partial<Product>
204
The updated products with the selected columns
PATCH
/products
curl -X PATCH "https://api.bookingmood.com/v1/products" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '{}'