Booking page configuration: rules, categories, online services, payment mode, approval threshold, required fields, current texts, payability, theme, arrival info, units (Cache-Control public, max-age=60)

GET

/api/public/v1/{slug}/booking/config

Shell / cURL

curl --request GET \
  --url https://example.com/api/public/v1/example/booking/config

Parameters

Path Parameters

slug

required

string

<= 63 characters

Responses

200

application/json

object

enabled

required

Marinas.booking_enabled; when false every other field is a default

boolean

payable

required

An online provider with checkout is enabled (or allow_without_provider is set: bookings then go to approval) and the terms and privacy texts are published (without them details are refused with booking_rules consents texts_unpublished)

boolean

currency

required

string

>= 3 characters <= 3 characters

rules

required

object

min_nights

required

integer

>= 1

max_nights

required

integer

>= 1 <= 366

min_advance_hours

required

integer

max_advance_days

required

integer

>= 1 <= 1095

arrival_from

required

Local time HH:MM in the marina timezone

string

/^([01][0-9]|2[0-3]):[0-5][0-9]$/

arrival_to

required

Local time HH:MM in the marina timezone

string

/^([01][0-9]|2[0-3]):[0-5][0-9]$/

closed_weekdays

required

Weekdays without arrivals, 0 = Sunday

Array<integer>

categories

required

Array<object>

object

code

required

Price_class (M2 berth category), or standard

string

name

required

object

required

string

>= 1 characters <= 200 characters

string

<= 200 characters

max_loa_cm

Length in integer centimetres

integer format: int64

max_beam_cm

Length in integer centimetres

integer format: int64

services

required

Array<object>

object

item_id

required

string

name

required

object

required

string

>= 1 characters <= 200 characters

string

<= 200 characters

description

Optional translated text (both languages may be empty)

object

string

<= 2000 characters

string

<= 2000 characters

unit

required

string

Allowed values: night month season year m m2 kwh m3 hour piece lump

unit_price_cents

Indicative price per unit (the quote is binding)

integer format: int64

max_qty_milli

Quantity in thousandths (1.5 = 1500)

integer format: int64

default_selected

required

boolean

payment_mode

required

string

Allowed values: deposit full

deposit_bp

required

Percentage in integer basis points (1 % = 100)

integer format: int64

cancellation_tiers

required

Array<object>

Refund of the paid amount when cancelling at least min_days_before days before arrival

object

min_days_before

required

integer

<= 366

refund_bp

required

integer

<= 10000

approval_loa_over_cm

integer | null format: int64

approval_always

required

boolean

required_fields

required

object

documents

required

Array<string>

Allowed values: boating_licence navigation_licence insurance_policy registration_certificate identity_card

people_on_board

required

boolean

phone

required

boolean

documents_later

required

Required documents may be uploaded after payment

boolean

texts

required

Current published version of each text kind

Array<object>

object

kind

required

string

Allowed values: terms privacy marketing

version

required

integer

>= 1

text

required

Long localised text (booking texts, arrival information); it is the source language

object

required

string

>= 1 characters <= 50000 characters

string

<= 50000 characters

theme

required

object

preset

required

string

<= 32 characters

hide_header_in_embed

required

boolean

arrival_info

object

vhf_channel

string

<= 16 characters

phone

Berthing-master phone (marina contact

string

<= 40 characters

rules_url

string

<= 500 characters

text

Long localised text (booking texts, arrival information); it is the source language

object

required

string

>= 1 characters <= 50000 characters

string

<= 50000 characters

show_feet

required

boolean

Example

{
  "services": [
    {
      "unit": "night"
    }
  ],
  "payment_mode": "deposit",
  "required_fields": {
    "documents": [
      "boating_licence"
    ]
  },
  "texts": [
    {
      "kind": "terms"
    }
  ]
}

404

Not found (or not visible to the principal)

application/problem+json

object

type

required

string

Allowed values: bad_request validation_failed weak_password invalid_reset_token invalid_totp pairing_code_invalid invalid_scope invalid_webhook_url unknown_event_type unauthorized invalid_credentials totp_required forbidden csrf_failed totp_enrolment_required totp_required_by_policy not_found method_not_allowed conflict slug_taken already_member last_owner totp_already_enabled totp_not_enrolled endpoint_disabled idempotency_in_progress version_conflict unsupported_media_type idempotency_key_reused precondition_required rate_limited internal_error not_ready map_invalid map_not_empty map_not_georeferenced invalid_file file_too_large csv_invalid customer_anonymized customer_merged download_link_expired no_price promo_not_applicable price_list_invalid price_list_immutable price_list_overlap in_use resource_taken fit_blocked placement_invalid invalid_transition quote_expired hold_expired closure_active undo_unavailable release_invalid customer_required not_implemented renewal_exists proposal_closed signature_open invalid_signature otp_invalid otp_locked otp_rate_limited link_invalid template_invalid template_limits paper_scan_required insurance_required customer_email_missing shares_invalid table_incomplete table_active transfer_requirements mandate_overlap vessel_in_other_fleet vessel_not_in_fleet import_not_undoable provider_unknown code_taken charge_immutable charge_cancelled use_edit match_exceeds refund_exceeds already_reversed credit_insufficient not_deposit nothing_to_settle charge_exists no_termination_amount not_exported export_empty export_too_large charges_not_open release_not_resold cash_session_required cash_session_open cash_session_closed cash_insufficient register_in_use provider_disabled provider_refund_unsupported provider_error billing_item_missing first_run_token_invalid first_run_done lan_port_unavailable lan_no_address backup_in_progress restore_failed restore_backup_newer allocation_changed offline_not_allowed remote_unreachable remote_pin_mismatch peripheral_unavailable claim_expired app_pin_invalid invalid_period invalid_report_filter report_too_large unknown_indicator booking_unavailable booking_rules booking_busy consent_required text_outdated refund_changed price_changed cancellation_not_allowed nothing_due idempotency_mismatch storage_target_invalid storage_no_space area_exits_invalid pinned_invalid too_many_items scenario_window_invalid scenario_not_draft scenario_conflicts movement_not_pending element_invalid maintenance_conflicts task_already_done reading_charged consumption_frozen formula_invalid work_order_closed work_order_has_charges qualification_mismatch capacity_exceeded dependency_violation duration_too_long offline_time_out_of_range timer_already_running return_exceeds_issued nothing_to_bill equipment_slot_taken operator_busy equipment_out_of_service equipment_capacity_exceeded operator_not_enabled outside_lift_window ingest_unauthorized ingest_timestamp_out_of_range invalid_payload segment_overlap resource_has_sensor invalid_sensor_resource alert_stale alert_action_not_allowed profile_incomplete photo_invalid

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

errors

Array<object>

object

field

required

string

code

required

string

message

string

retry_after_seconds

integer

issues

Map validation issues (map_invalid)

Array<object>

object

code

required

ValidateMap rule (m1-plan §2.3), e.g. berth_overlap

string

severity

required

string

Allowed values: error warning

element_type

required

string

refs

required

Array<string>

field

string

params

Numbers only (cm, counts)

object

key

additional properties

integer format: int64

price_list_issues

Price list validation issues (price_list_invalid)

Array<object>

object

code

required

Pricing.Validate issue code (m2-plan §4.8), e.g. period_overlap

string

severity

required

string

Allowed values: error warning

ref

required

object

kind

required

string

Allowed values: list settings period band rule item

Id of the row, or the client key of an unsaved one

string

field

string

params

Codes and integers as strings; never personal data

object

key

additional properties

string

details

Machine-readable details: no_price {item_id, contract_type, night, unit, category, band, reason}; price_list_overlap {conflicts: [{id, code, valid_from, valid_to}]}; in_use {references}; resource_taken ConflictDetail; fit_blocked FitResult; placement_invalid {reason, allocation_id?}; invalid_transition {from, action}; closure_active {closure_id, from_date, to_date}; release_invalid {reason}; allocation_changed {current_resource_id, current_resource_code} (null when the allocation is gone); remote_pin_mismatch {expected_fingerprint, presented_fingerprint}; scenario_conflicts {conflicts: [StorageScenarioConflict]}; maintenance_conflicts {conflicts: [MaintenanceConflict]}; storage_no_space {area_id, from, to}. Ids, codes, dates and integers only.

object

key

additional properties

any

Example

{
  "type": "bad_request",
  "issues": [
    {
      "severity": "error"
    }
  ],
  "price_list_issues": [
    {
      "severity": "error",
      "ref": {
        "kind": "list"
      }
    }
  ]
}

429

Rate limited (see Retry-After)

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

errors

Array<object>

object

field

required

string

code

required

string

message

string

retry_after_seconds

integer

issues

Map validation issues (map_invalid)

Array<object>

object

code

required

ValidateMap rule (m1-plan §2.3), e.g. berth_overlap

string

severity

required

string

Allowed values: error warning

element_type

required

string

refs

required

Array<string>

field

string

params

Numbers only (cm, counts)

object

key

additional properties

integer format: int64

price_list_issues

Price list validation issues (price_list_invalid)

Array<object>

object

code

required

Pricing.Validate issue code (m2-plan §4.8), e.g. period_overlap

string

severity

required

string

Allowed values: error warning

ref

required

object

kind

required

string

Allowed values: list settings period band rule item

Id of the row, or the client key of an unsaved one

string

field

string

params

Codes and integers as strings; never personal data

object

key

additional properties

string

details

object

key

additional properties

any

Example

{
  "type": "bad_request",
  "issues": [
    {
      "severity": "error"
    }
  ],
  "price_list_issues": [
    {
      "severity": "error",
      "ref": {
        "kind": "list"
      }
    }
  ]
}

Headers

Retry-After

integer

Porto è sviluppato da Coste360 SRL. Codice sorgente disponibile con licenza BSL 1.1; il marchio Porto è escluso dalla licenza.