Core resources


Administration


Booking flow

Product configurations

Rate and availability configurations. Applied per unit on multiple intervals

The product configuration object

Attributes

iduuid

Unique identifier

product_iduuid
products.id

Identifier of the related unit

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

check_in_daysboolean[]

List of days of the week on which check-in is possible

checkout_daysboolean[]

List of days of the week on which check-out is possible

colortext

Color to distinguish the configuration from others

cooldown_timeinteger

Minimum number of days between bookings

early_bird_adjustmentsjsonb

Rate adjustments for early bookings

ftstsvector

Full text search index

intervalsdatemultirange
last_minute_adjustmentsjsonb

Rate adjustments for last minute bookings

long_rent_adjustmentsjsonb

Rate adjustments for long bookings

max_advanceinteger

Maximum number of days between booking and arrival

max_durationinteger

Maximum duration of a booking in days

min_advanceinteger

Minimum number of days between booking and arrival

min_durationinteger

Minimum duration of a booking in days

namejsonb

Localized name

orderinteger
ratesjsonb

Base rates

The product configuration object
{
"id": "00000000-0000-0000-0000-000000000000",
"product_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-04-17T12:00:48.562Z",
"updated_at": "2024-04-17T12:00:48.562Z",
"check_in_days": [
false
],
"checkout_days": [
false
],
"color": "#FACC15",
"cooldown_time": 0,
"early_bird_adjustments": {},
"intervals": null,
"last_minute_adjustments": {},
"long_rent_adjustments": {},
"max_advance": 365,
"max_duration": 30,
"min_advance": 0,
"min_duration": 1,
"name": {},
"order": 0,
"rates": {}
}

List product configurations

Filters

idFilter<uuid>

Unique identifier

product_idFilter<uuid>

Identifier of the related unit

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

check_in_daysFilter<boolean[]>

List of days of the week on which check-in is possible

checkout_daysFilter<boolean[]>

List of days of the week on which check-out is possible

colorFilter<text>

Color to distinguish the configuration from others

cooldown_timeFilter<integer>

Minimum number of days between bookings

early_bird_adjustmentsFilter<jsonb>

Rate adjustments for early bookings

ftsFilter<tsvector>

Full text search index

intervalsFilter<datemultirange>
last_minute_adjustmentsFilter<jsonb>

Rate adjustments for last minute bookings

long_rent_adjustmentsFilter<jsonb>

Rate adjustments for long bookings

max_advanceFilter<integer>

Maximum number of days between booking and arrival

max_durationFilter<integer>

Maximum duration of a booking in days

min_advanceFilter<integer>

Minimum number of days between booking and arrival

min_durationFilter<integer>

Minimum duration of a booking in days

nameFilter<jsonb>

Localized name

orderFilter<integer>
ratesFilter<jsonb>

Base rates

Responses

200

A list of product configurations with the selected columns

206

Partial Content

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

Create product configurations

Body

Partial<ProductConfiguration>
| Array<Partial<ProductConfiguration>>

Responses

201

The newly created product configurations with the selected columns

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

Delete product configurations

Filters

idFilter<uuid>

Unique identifier

product_idFilter<uuid>

Identifier of the related unit

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

check_in_daysFilter<boolean[]>

List of days of the week on which check-in is possible

checkout_daysFilter<boolean[]>

List of days of the week on which check-out is possible

colorFilter<text>

Color to distinguish the configuration from others

cooldown_timeFilter<integer>

Minimum number of days between bookings

early_bird_adjustmentsFilter<jsonb>

Rate adjustments for early bookings

ftsFilter<tsvector>

Full text search index

intervalsFilter<datemultirange>
last_minute_adjustmentsFilter<jsonb>

Rate adjustments for last minute bookings

long_rent_adjustmentsFilter<jsonb>

Rate adjustments for long bookings

max_advanceFilter<integer>

Maximum number of days between booking and arrival

max_durationFilter<integer>

Maximum duration of a booking in days

min_advanceFilter<integer>

Minimum number of days between booking and arrival

min_durationFilter<integer>

Minimum duration of a booking in days

nameFilter<jsonb>

Localized name

orderFilter<integer>
ratesFilter<jsonb>

Base rates

Responses

204

The deleted product configurations with the selected columns

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

Update product configurations

Filters

idFilter<uuid>

Unique identifier

product_idFilter<uuid>

Identifier of the related unit

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

check_in_daysFilter<boolean[]>

List of days of the week on which check-in is possible

checkout_daysFilter<boolean[]>

List of days of the week on which check-out is possible

colorFilter<text>

Color to distinguish the configuration from others

cooldown_timeFilter<integer>

Minimum number of days between bookings

early_bird_adjustmentsFilter<jsonb>

Rate adjustments for early bookings

ftsFilter<tsvector>

Full text search index

intervalsFilter<datemultirange>
last_minute_adjustmentsFilter<jsonb>

Rate adjustments for last minute bookings

long_rent_adjustmentsFilter<jsonb>

Rate adjustments for long bookings

max_advanceFilter<integer>

Maximum number of days between booking and arrival

max_durationFilter<integer>

Maximum duration of a booking in days

min_advanceFilter<integer>

Minimum number of days between booking and arrival

min_durationFilter<integer>

Minimum duration of a booking in days

nameFilter<jsonb>

Localized name

orderFilter<integer>
ratesFilter<jsonb>

Base rates

Body

Partial<ProductConfiguration>

Responses

204

The updated product configurations with the selected columns

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