Core resources


Administration


Booking flow

Products

Units that can be booked individually

The product object

Attributes

iduuid

Unique identifier

ac_idtext | null

Identifier for products imported from AvailabilityCalendar.com

organization_iduuid

Identifier of the organization this product is defined in

parent_iduuid | null
products.id

Identifier of the parent unit

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

deleted_attimestamp with time zone | null

Timestamp at which the unit was deleted

approximate_addresstext | null

Approximate address of the unit

approximate_coordinatesjsonb | null

Coordinates of the approximate address

cancel_after_initial_payment_errorboolean
confirm_after_initial_paymentboolean

Whether to automatically confirm the booking after the initial payment. Only applies when interaction is request

confirmation_messagejsonb

Message to show to the customer after submitting a booking from a widget or website

cooldown_timeinteger

Minimum number of days between bookings. Only applies when rent_pricing_definition is services

ctajsonb

Call to action shown at the bottom of the booking form

currencytext

Currency bookings are made in

descriptionjsonb

Localized description

exact_addresstext | null

Exact address of the unit

exact_coordinatesjsonb | null

Coordinates of the exact address

ftstsvector

Full text search index

hide_exact_addressboolean

Whether to hide the exact address from customers before bookings are confirmed

ical_export_secrettext

Secret used to generate iCal feed URLs

ical_export_secret_no_detailstext

Secret used to generate iCal feed URLs without booking details

imagesjson

List of images

interactiontext

Interaction type, either request or book

latest_arrival_timetime without time zone | null
namejsonb

Localized name

price_breakdown_specificitytext
rent_period"daily" | "nightly"

Rent period of the unit

rent_pricing_definitiontext

Pricing definition of the unit. Either configuration or services

request_status"CANCELLED" | "TENTATIVE" | "CONFIRMED"

Status of new bookings. Only applies when interaction is request

timezonetext

Timezone of the unit

The product object
{
"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-04-17T13:35:27.394Z",
"updated_at": "2024-04-17T13:35:27.394Z",
"deleted_at": "2024-04-17T13:35:27.394Z",
"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"
}

List products

Filters

idFilter<uuid>

Unique identifier

ac_idFilter<text>

Identifier for products imported from AvailabilityCalendar.com

organization_idFilter<uuid>

Identifier of the organization this product is defined in

parent_idFilter<uuid>

Identifier of the parent unit

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

deleted_atFilter<timestamp with time zone>

Timestamp at which the unit was deleted

approximate_addressFilter<text>

Approximate address of the unit

approximate_coordinatesFilter<jsonb>

Coordinates of the approximate address

cancel_after_initial_payment_errorFilter<boolean>
confirm_after_initial_paymentFilter<boolean>

Whether to automatically confirm the booking after the initial payment. Only applies when interaction is request

confirmation_messageFilter<jsonb>

Message to show to the customer after submitting a booking from a widget or website

cooldown_timeFilter<integer>

Minimum number of days between bookings. Only applies when rent_pricing_definition is services

ctaFilter<jsonb>

Call to action shown at the bottom of the booking form

currencyFilter<text>

Currency bookings are made in

descriptionFilter<jsonb>

Localized description

exact_addressFilter<text>

Exact address of the unit

exact_coordinatesFilter<jsonb>

Coordinates of the exact address

ftsFilter<tsvector>

Full text search index

hide_exact_addressFilter<boolean>

Whether to hide the exact address from customers before bookings are confirmed

ical_export_secretFilter<text>

Secret used to generate iCal feed URLs

ical_export_secret_no_detailsFilter<text>

Secret used to generate iCal feed URLs without booking details

imagesFilter<json>

List of images

interactionFilter<text>

Interaction type, either request or book

latest_arrival_timeFilter<time without time zone>
nameFilter<jsonb>

Localized name

price_breakdown_specificityFilter<text>
rent_periodFilter<"daily" | "nightly">

Rent period of the unit

rent_pricing_definitionFilter<text>

Pricing definition of the unit. Either configuration or services

request_statusFilter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">

Status of new bookings. Only applies when interaction is request

timezoneFilter<text>

Timezone of the unit

Responses

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"

Update products

Filters

idFilter<uuid>

Unique identifier

ac_idFilter<text>

Identifier for products imported from AvailabilityCalendar.com

organization_idFilter<uuid>

Identifier of the organization this product is defined in

parent_idFilter<uuid>

Identifier of the parent unit

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

deleted_atFilter<timestamp with time zone>

Timestamp at which the unit was deleted

approximate_addressFilter<text>

Approximate address of the unit

approximate_coordinatesFilter<jsonb>

Coordinates of the approximate address

cancel_after_initial_payment_errorFilter<boolean>
confirm_after_initial_paymentFilter<boolean>

Whether to automatically confirm the booking after the initial payment. Only applies when interaction is request

confirmation_messageFilter<jsonb>

Message to show to the customer after submitting a booking from a widget or website

cooldown_timeFilter<integer>

Minimum number of days between bookings. Only applies when rent_pricing_definition is services

ctaFilter<jsonb>

Call to action shown at the bottom of the booking form

currencyFilter<text>

Currency bookings are made in

descriptionFilter<jsonb>

Localized description

exact_addressFilter<text>

Exact address of the unit

exact_coordinatesFilter<jsonb>

Coordinates of the exact address

ftsFilter<tsvector>

Full text search index

hide_exact_addressFilter<boolean>

Whether to hide the exact address from customers before bookings are confirmed

ical_export_secretFilter<text>

Secret used to generate iCal feed URLs

ical_export_secret_no_detailsFilter<text>

Secret used to generate iCal feed URLs without booking details

imagesFilter<json>

List of images

interactionFilter<text>

Interaction type, either request or book

latest_arrival_timeFilter<time without time zone>
nameFilter<jsonb>

Localized name

price_breakdown_specificityFilter<text>
rent_periodFilter<"daily" | "nightly">

Rent period of the unit

rent_pricing_definitionFilter<text>

Pricing definition of the unit. Either configuration or services

request_statusFilter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">

Status of new bookings. Only applies when interaction is request

timezoneFilter<text>

Timezone of the unit

Body

Partial<Product>

Responses

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 '{}'