Price a booking before requesting it

Returns what a booking would cost and checks it against the resource’s rules, without booking anything. Send the resource, time and extras the request will carry. Whether the time is still free is checked only by the request, so it can still be refused after a preview succeeds.

POST/v1/booking/booking-requests/preview

Authorization

AuthorizationOAuth2 access token · headerrequired

An access token for an Application, from the client_credentials grant. An installed connector gets its token from the installation-token grant instead. Send it as Authorization: Bearer <token>.

Request body

requiredapplication/json

bookableResourceIdstring<uuid>required

The resource to book.

timeSpecobjectrequired

The time a booking is for. Its model must match the resource's bookingRules.model, and each model sends a different shape.

Show properties

One of:

object

modelstringrequired

For a resource booked by a start and an end time.

Allowed:time_interval

startsAtstring<date-time>required

When the booking starts, as an ISO 8601 timestamp in UTC.

endsAtstring<date-time>required

When the booking ends, as an ISO 8601 timestamp in UTC.

object

modelstringrequired

For a resource booked as a stay between two dates.

Allowed:date_interval

fromDatestring<date>required

The arrival date, as YYYY-MM-DD in the resource's time zone.

toDatestring<date>required

The departure date, as YYYY-MM-DD in the resource's time zone. After fromDate.

object

modelstringrequired

For a resource booked one slot at a time.

Allowed:time_slots

datestring<date>required

The date of the slot, as YYYY-MM-DD in the resource's time zone.

startMinuteOfDayintegerrequired

The slot's start, in minutes after local midnight, as the schedule lists it.

min 0 · max 1439

object

modelstringrequired

For a resource booked by the date a fixed window starts on.

Allowed:date_span

datestring<date>required

The date the window starts on, as YYYY-MM-DD in the resource's time zone.

roomLayoutstring

A furniture layout for a room: conference chairs facing the front, u_shape tables in a U, islands round tables with chairs around them.

Allowed:conferenceu_shapeislands

addOnLinesobject[]

The extras to order with the booking.

Show properties

Array of object

addOnProductIdstring<uuid>required

The product to order, one of the resource's add-on products.

quantityintegerrequired

How many units to order: people for a per-person product, orders otherwise.

min 1 · max 10000

deliveryAtstring<date-time>required

When to deliver it, as an ISO 8601 timestamp in UTC. It must fall within the booking.

specialPortionsobject[]

Parts of the quantity with dietary needs. Only catering takes them.

max items 20

Show properties

Array of object

countintegerrequired

How many of the ordered units need these options.

min 1 · max 10000

dietaryOptionsstring[]required

The dietary options these units must meet. Each must be one the product lists.

min items 1

notestring

A note for whoever prepares the order.

max length 500

Responses

200

What the booking would cost.

startsAtstring<date-time>required

When the booking would start, as an ISO 8601 timestamp in UTC.

endsAtstring<date-time>required

When the booking would end, as an ISO 8601 timestamp in UTC.

quoteobjectrequired

What the booked time costs. unitPrice is the price of one pricing unit and amount the resource's price. totalAmount adds the ordered extras.

Show properties

priceRuleIdstring<uuid>

The price rule that set the price. Absent when the resource's default price applied.

tenantGroupIdstring<uuid>

The tenant group whose price applied, when a single group explains it.

pricingUnitstringrequired

How the price is counted. hour is charged per hour, pro rata. session is one flat price per booking. night is charged per night of a stay.

Allowed:hoursessionnight

quantitynumberrequired

How many pricing units the booking lasts: hours, sessions or nights. Hours can be fractional.

unitPriceobjectrequired

An amount of money in one currency, never negative.

Show properties

minorUnitsintegerrequired

The amount in minor units of the currency, such as öre for SEK. 0 means free.

min 0 · max 9007199254740991

currencystringrequired

An ISO 4217 currency code, for example SEK.

Allowed:SEKNOKDKKEURUSDGBP

amountobjectrequired

An amount of money in one currency, never negative.

Show properties

minorUnitsintegerrequired

The amount in minor units of the currency, such as öre for SEK. 0 means free.

min 0 · max 9007199254740991

currencystringrequired

An ISO 4217 currency code, for example SEK.

Allowed:SEKNOKDKKEURUSDGBP

vatRateBasisPointsintegerrequired

The VAT rate in basis points. 2500 is 25%.

min 0 · max 9007199254740991

vatTreatmentstring

Why a line is taxed at 0%: exempt when the supply is exempt from VAT, reverseCharge when the buyer accounts for the VAT.

Allowed:exemptreverseCharge

totalAmountobject

An amount of money in one currency, never negative.

Show properties

minorUnitsintegerrequired

The amount in minor units of the currency, such as öre for SEK. 0 means free.

min 0 · max 9007199254740991

currencystringrequired

An ISO 4217 currency code, for example SEK.

Allowed:SEKNOKDKKEURUSDGBP

vatBreakdownobject[]

The total split by VAT rate and treatment, the resource included.

Show properties

Array of object

vatRateBasisPointsintegerrequired

The VAT rate in basis points. 2500 is 25%.

min 0 · max 9007199254740991

vatTreatmentstring

Why a line is taxed at 0%: exempt when the supply is exempt from VAT, reverseCharge when the buyer accounts for the VAT.

Allowed:exemptreverseCharge

amountobjectrequired

An amount of money in one currency, never negative.

Show properties

minorUnitsintegerrequired

The amount in minor units of the currency, such as öre for SEK. 0 means free.

min 0 · max 9007199254740991

currencystringrequired

An ISO 4217 currency code, for example SEK.

Allowed:SEKNOKDKKEURUSDGBP

cancellationDeadlinestring<date-time>

The last moment the booking could be cancelled, as an ISO 8601 timestamp in UTC. The earliest of the resource's notice and every extra's cutoff.

addOnLinesobject[]required

The extras as they would be ordered, each with its price.

Show properties

Array of object

idstring<uuid>required

The order line id.

addOnProductIdstring<uuid>required

The product ordered.

productNamestringrequired

The product's name when it was ordered.

kindstringrequired

What kind of product it is.

Allowed:cateringequipmentservice

pricingUnitstringrequired

How the price multiplies. per_person is charged per person, per_order once per order.

Allowed:per_personper_order

quantityintegerrequired

How many units were ordered.

max 9007199254740991

deliveryAtstring<date-time>required

When it is delivered, as an ISO 8601 timestamp in UTC.

specialPortionsobject[]required

Parts of the quantity with dietary needs. Empty when there are none.

Show properties

Array of object

countintegerrequired

How many of the ordered units need these options.

min 1 · max 10000

dietaryOptionsstring[]required

The dietary options these units must meet. Each must be one the product lists.

min items 1

notestringrequired

A note for whoever prepares the order. An empty string when there is none.

unitPriceobjectrequired

An amount of money in one currency, never negative.

Show properties

minorUnitsintegerrequired

The amount in minor units of the currency, such as öre for SEK. 0 means free.

min 0 · max 9007199254740991

currencystringrequired

An ISO 4217 currency code, for example SEK.

Allowed:SEKNOKDKKEURUSDGBP

amountobjectrequired

An amount of money in one currency, never negative.

Show properties

minorUnitsintegerrequired

The amount in minor units of the currency, such as öre for SEK. 0 means free.

min 0 · max 9007199254740991

currencystringrequired

An ISO 4217 currency code, for example SEK.

Allowed:SEKNOKDKKEURUSDGBP

vatRateBasisPointsintegerrequired

The VAT rate in basis points. 2500 is 25%.

min 0 · max 9007199254740991

vatTreatmentstring

Why a line is taxed at 0%: exempt when the supply is exempt from VAT, reverseCharge when the buyer accounts for the VAT.

Allowed:exemptreverseCharge

cancellationCutoffMinutesintegerrequired

How many minutes before delivery the line can still be changed or cancelled.

min 0 · max 9007199254740991

cancellationDeadlinestring<date-time>required

The last moment the line can be changed or cancelled, as an ISO 8601 timestamp in UTC.

createdAtstring<date-time>required

When the line was ordered, as an ISO 8601 timestamp in UTC.

chargeEmittedbooleanrequired

Whether the line has been sent for invoicing.

orderedByGuestboolean

True when the guest ordered it through the link in their booking email.

addOnAmountobject

An amount of money in one currency, never negative.

Show properties

minorUnitsintegerrequired

The amount in minor units of the currency, such as öre for SEK. 0 means free.

min 0 · max 9007199254740991

currencystringrequired

An ISO 4217 currency code, for example SEK.

Allowed:SEKNOKDKKEURUSDGBP

400

The request is not valid, or a business rule refused it. code names the rule.

typestringrequired

Always about:blank.

titlestringrequired

The HTTP status phrase, for example Not Found.

statusintegerrequired

The HTTP status code.

min -9007199254740991 · max 9007199254740991

detailstring

What went wrong, for a person to read. Do not parse it.

codestring

Names the rule that refused the request. Match on this, not on detail.

Allowed:TWIN_NODE_NOT_FOUNDTWIN_OPERATIONAL_CONTEXT_NOT_DELETABLETWIN_NODE_SUBTREE_IN_USETWIN_OPENING_HOURS_SCHEDULE_LIMIT_REACHEDTWIN_OPENING_HOURS_SCHEDULE_NAME_ALREADY_EXISTSTWIN_OPENING_HOURS_SCHEDULE_NOT_FOUNDOPERATIONS_ISSUE_TRANSITION_INVALIDOPERATIONS_ISSUE_CLOSE_REASON_REQUIREDOPERATIONS_ISSUE_CONCURRENT_MODIFICATIONOPERATIONS_ISSUE_KEY_ALREADY_USEDOPERATIONS_PRIORITY_ARCHIVEDOPERATIONS_PRIORITY_KEY_ALREADY_EXISTSOPERATIONS_ISSUE_STATUS_ARCHIVEDOPERATIONS_ISSUE_STATUS_CATEGORY_WOULD_BE_EMPTYOPERATIONS_ISSUE_STATUS_REORDER_INCOMPLETEOPERATIONS_VOCABULARY_OWNER_INVALIDOPERATIONS_ISSUE_RULE_KIND_CONFLICTOPERATIONS_ISSUE_RULE_STATUS_NOT_IN_SETOPERATIONS_COMMENT_NOT_AUTHOROPERATIONS_COMMENT_NEEDS_CONTENTOPERATIONS_ATTACHMENT_REJECTEDOPERATIONS_ATTACHMENT_NOT_UPLOADEROPERATIONS_WORK_ORDER_DELEGATION_ACTIVEOPERATIONS_WORK_ORDER_NOT_DELETABLEOPERATIONS_WORK_ORDER_DEPENDENCY_CYCLEOPERATIONS_DELEGATION_STATUS_INVALIDOPERATIONS_DELEGATION_NOT_ENGAGED_PARTYOPERATIONS_DELEGATION_ROLE_CANNOT_ACTOPERATIONS_DISCIPLINE_LABEL_ALREADY_EXISTSOPERATIONS_DISCIPLINE_UNKNOWNOPERATIONS_DISCIPLINE_ARCHIVEDOPERATIONS_SUPPLIER_ROSTER_EMAIL_EXISTSTENANT_BILLING_ACCOUNT_PRIVATE_AGENT_HAS_ONETENANT_BILLING_ACCOUNT_DEFAULT_NOT_REMOVABLETENANT_BILLING_ACCOUNT_INCOMPLETETENANT_CONTRACT_BILLING_ACCOUNT_REQUIREDTENANT_UNIT_ALREADY_LEASEDTENANT_CONTRACT_TERMINATION_RETROACTIVETENANT_CONTRACT_TERMINATION_NOT_EARLIERTENANT_CONTRACT_TERMINATION_LOCKEDTENANT_CONTRACT_BILLING_TERMS_LOCKEDTENANT_CONTRACT_OWNER_NOT_BUSINESSTENANT_CONTRACT_LINE_OUTSIDE_OWNER_CONETENANT_CONTRACT_LINE_IN_USETENANT_CONTRACT_LINE_TERMINATEDTENANT_CONTRACT_LINE_NOT_SEATABLETENANT_CONTRACT_LINE_NO_ENABLEMENTTENANT_CONTRACT_LINE_SEAT_LIMIT_REACHEDTENANT_CONTRACT_LINE_AT_MINIMUM_SEATSTENANT_CONTRACT_SEAT_EMPTYTENANT_LEASABLE_UNIT_ALREADY_EXISTSTENANT_LEASABLE_UNIT_CONTEXT_INVALIDTENANT_PRODUCT_SKU_ALREADY_EXISTSTENANT_PRODUCT_RETIREDTENANT_PRODUCT_CONTEXT_INVALIDTENANT_PRODUCT_GRANT_DUPLICATETENANT_PRODUCT_GRANT_ENABLEMENT_MISMATCHTENANT_PRODUCT_GRANT_IS_HOMETENANT_PRODUCT_GRANT_SHADOWEDTENANT_PRODUCT_CATEGORY_NAME_ALREADY_EXISTSTENANT_PRODUCT_CATEGORY_RETIREDTENANT_PRODUCT_CATEGORY_VALUE_LOCKEDTENANT_AGENT_NOT_READYTENANT_USER_ALREADY_ON_ROSTERTENANT_AGENT_IDENTIFIER_ALREADY_USEDTENANT_AGENT_TYPE_MISMATCHTENANT_CUSTOMER_NUMBER_TAKENTENANT_CUSTOMER_NUMBER_INVALIDTENANT_SCHEME_DEFAULT_TIER_REQUIREDTENANT_SCHEME_TIER_ROLE_INVALIDTENANT_SCHEME_CONTEXT_TYPE_MISMATCHTENANT_SCHEME_NOT_ENABLED_HERETENANT_SCHEME_DEFAULT_TIER_NOT_PLACEABLETENANT_COMPANY_REGISTRY_NOT_SUPPORTEDTENANT_COMPANY_REGISTRY_UNAVAILABLEBILLING_INTEGRATION_NOT_CONFIGUREDBILLING_INTEGRATION_GATE_NOT_DECLAREDBILLING_EXTERNAL_REFERENCE_ALREADY_USEDBILLING_INVOICE_STATUS_INVALIDBILLING_PAYMENT_REPLAY_MISMATCHBILLING_PAYMENT_REVERSEDBILLING_PAYMENT_NOT_FOUNDBILLING_PAYMENT_AMOUNT_INVALIDBILLING_WRITE_OFF_REPLAY_MISMATCHBILLING_WRITE_OFF_AMOUNT_INVALIDBILLING_PROPOSAL_STATUS_INVALIDBILLING_PROPOSAL_MATERIAL_ALREADY_INVOICEDBILLING_CREDIT_NOTE_INVOICE_NOT_CREDITABLEBILLING_CREDIT_NOTE_NO_PENDING_CORRECTIONSBILLING_INVOICE_RUN_NOT_CONTINUABLEBILLING_CREDIT_EXCEEDS_LINEBILLING_CREDIT_EXCEEDS_INVOICEBILLING_CREDIT_WITHHELDBILLING_CREDIT_ACT_REPLAY_MISMATCHBILLING_MANUAL_CREDIT_VAT_RATE_UNKNOWNBILLING_CORRECTION_NOT_WITHDRAWABLECOMMUNITY_POST_COVER_REJECTEDCOMMUNITY_POST_ATTACHMENT_REJECTEDCOMMUNITY_POST_COVER_LIMIT_REACHEDCOMMUNITY_POST_ATTACHMENT_LIMIT_REACHEDCOMMUNITY_PROMOTION_IMAGE_LIMIT_REACHEDCOMMUNITY_VOUCHER_CODE_TAKENCOMMUNITY_PUBLISH_AT_NOT_FUTURECOMMUNITY_PINNED_UNTIL_NOT_FUTURECOMMUNITY_POST_NOT_SCHEDULEDCOMMUNITY_POST_NOT_PUBLISHEDCOMMUNITY_POST_NOT_UNPUBLISHEDCOMMUNITY_DRAFT_INCOMPLETECOMMUNITY_PROMOTION_INCOMPLETECOMMUNITY_PROMOTION_NOT_DRAFTCOMMUNITY_PROMOTION_NOT_SCHEDULEDCOMMUNITY_PROMOTION_NOT_ACTIVECOMMUNITY_PROMOTION_NOT_INACTIVECOMMUNICATIONS_ATTACHMENT_PENDING_LIMIT_EXCEEDEDCOMMUNICATIONS_ATTACHMENT_REJECTEDCOMMUNICATIONS_ATTACHMENT_NOT_CLAIMABLECOMMUNICATIONS_BROADCAST_SCHEDULED_AT_NOT_FUTURECOMMUNICATIONS_BROADCAST_NOT_SCHEDULEDCOMMUNITY_EVENT_FULLCOMMUNITY_EVENT_ATTENDEE_EXISTSCOMMUNITY_EVENT_CAPACITY_BELOW_ATTENDEESCOMMUNITY_POLL_CLOSEDCOMMUNITY_POLL_ALREADY_ANSWEREDBOOKING_SLOT_TAKENBOOKING_NO_COVERING_CONTRACTBOOKING_CONTRACT_ATTRIBUTION_AMBIGUOUSBOOKING_CONTRACT_NOT_A_CANDIDATEBOOKING_NO_SHARED_CONTRACTBOOKING_EXTERNAL_CONTRACT_NOT_BILLABLEBOOKING_EXTERNAL_CUSTOMER_NOT_FOUNDBOOKING_EXTERNAL_CUSTOMER_BILLING_ACCOUNT_REQUIREDBOOKING_EXTERNAL_BILLING_ACCOUNT_INCOMPLETEBOOKING_EXTERNAL_INVOICING_DETAILS_REQUIREDBOOKING_EXTERNAL_REQUIRES_APPROVALBOOKING_REQUEST_ID_ALREADY_USEDBOOKING_GUEST_LINK_INVALIDBOOKING_GUEST_LINK_NOT_RESENDABLEBOOKING_NOT_EXTERNALBOOKING_PRICE_RULE_AMBIGUOUSBOOKING_PRICE_RULE_NOT_APPLICABLEBOOKING_NOT_PENDING_APPROVALBOOKING_APPROVAL_WINDOW_PASSEDBOOKING_RESOURCE_IMAGE_REJECTEDBOOKING_RESOURCE_PURCHASE_TERMS_REJECTEDBOOKING_OUTSIDE_OPEN_HOURSBOOKING_DURATION_TOO_SHORTBOOKING_DURATION_TOO_LONGBOOKING_DURATION_NOT_ON_INCREMENTBOOKING_START_NOT_ON_INCREMENTBOOKING_WEEKLY_QUOTA_EXCEEDEDBOOKING_BUFFER_CONFLICTBOOKING_NOTICE_TOO_SHORTBOOKING_CANCELLATION_NOTICE_EXPIREDBOOKING_ALREADY_DELIVEREDBOOKING_NOT_CHARGEDBOOKING_ALREADY_STARTEDBOOKING_ACCESS_ALREADY_OPENBOOKING_NOT_RESCHEDULABLEBOOKING_TIME_SPEC_MODEL_MISMATCHBOOKING_SLOT_NOT_IN_SCHEDULEBOOKING_DATE_INTERVAL_EMPTYBOOKING_DATE_SPAN_EMPTYBOOKING_DATE_SPAN_REQUIRES_SESSION_PRICINGBOOKING_DATE_INTERVAL_REQUIRES_NIGHT_PRICINGBOOKING_NIGHT_PRICING_REQUIRES_DATE_INTERVALBOOKING_RESOURCE_BUFFER_NOT_ON_INCREMENTBOOKING_STAY_TOO_SHORTBOOKING_STAY_TOO_LONGBOOKING_UPLOAD_PENDING_LIMIT_EXCEEDEDBOOKING_IN_THE_PASTBOOKING_HORIZON_EXCEEDEDBOOKING_DURATION_CEILING_EXCEEDEDBOOKING_PARTICIPANTS_NOT_SUPPORTEDBOOKING_PARTICIPANT_NOT_SEATEDBOOKING_RESOURCE_PARTICIPANTS_GROUP_CONFLICTBOOKING_RESOURCE_CURRENCY_MISMATCHBOOKING_OPENING_HOURS_SCHEDULE_NOT_FOUNDBOOKING_RESOURCE_GROUP_OUTSIDE_CONTEXTBOOKING_ADD_ON_PRODUCT_IMAGE_REJECTEDBOOKING_ADD_ON_PRODUCT_RETIREDBOOKING_ADD_ON_PRODUCT_RESOURCE_OUTSIDE_CONTEXTBOOKING_ADD_ON_NOT_OFFEREDBOOKING_ADD_ON_DELIVERY_OUTSIDE_BOOKINGBOOKING_ADD_ON_DELIVERY_OUTSIDE_AVAILABILITYBOOKING_ADD_ON_ORDER_LEAD_TOO_SHORTBOOKING_ADD_ON_CUTOFF_PASSEDBOOKING_ADD_ON_SPECIAL_PORTIONS_INVALIDBOOKING_ADD_ON_LINE_LIMIT_EXCEEDEDBOOKING_ADD_ON_ON_INTERNAL_BOOKINGBOOKING_ADD_ON_LINE_NOT_FOUNDBOOKING_ADD_ON_LINE_DELIVEREDBOOKING_ADD_ON_LINE_NO_LONGER_FITSBOOKING_ROOM_LAYOUT_NOT_OFFEREDBOOKING_ROOM_LAYOUT_CUTOFF_PASSEDBOOKING_ROOM_LAYOUT_NOT_CHANGEABLEBOOKING_ROOM_SETUP_NOT_FOUNDACCESS_ACCESSY_CREDENTIALS_REJECTEDACCESS_ACCESSY_API_CLIENT_ALREADY_REGISTEREDACCESS_ACCESSY_API_CLIENT_MISSINGACCESS_GROUP_UNKNOWNACCESS_ACCESSY_UNAVAILABLEACCESS_SUBSCRIPTION_ALREADY_REGISTEREDACCESS_PHONE_MISSINGACCESS_ENROLLMENT_NOT_BEGUNACCESS_ENROLLMENT_EXPIREDACCESS_ENROLLMENT_REFUSEDACCESS_RECOVERY_KEY_REQUIREDACCESS_RECOVERY_KEY_INVALIDACCESS_ENROLLMENT_REQUIREDORGANIZATION_NOT_ENTEREDAUTH_PHONE_VERIFICATION_REQUIREDAUTH_PHONE_VERIFICATION_INVALIDAUTH_PHONE_VERIFICATION_THROTTLEDACCESS_GROUP_ALREADY_CONFIGUREDACCESS_GROUP_NOT_READYACCESS_DOOR_ALREADY_LINKEDACCESS_ASSET_NOT_PUBLISHEDACCESS_ACCESSY_REQUEST_REFUSEDCRM_CONTRACT_TEMPLATE_RETIREDCRM_PACKAGE_RETIREDCRM_PRODUCT_RETIREDCRM_PRODUCT_UNKNOWNCRM_AGENT_UNKNOWNCRM_CUSTOMER_CHOICE_INVALIDCRM_PROSPECT_MATCHES_AGENTCRM_CUSTOMER_IS_AGENTCRM_AGREEMENT_BILLING_DETAILS_REQUIREDCRM_AGREEMENT_BILLING_ACCOUNT_EXISTSCRM_AGREEMENT_BILLING_DETAILS_TYPE_MISMATCHCRM_AGREEMENT_BILLING_DETAILS_INCOMPLETECRM_ROW_ACCESS_TERMS_INVALIDCRM_DEAL_LOSTCRM_DEAL_ACCEPTEDCRM_DEAL_TRANSITION_INVALIDCRM_DEAL_BUSINESS_CONTEXT_INVALIDCRM_PACKAGE_BUSINESS_CONTEXT_INVALIDCRM_PACKAGE_BUSINESS_CONTEXT_MISMATCHCRM_PACKAGE_PRODUCT_DUPLICATECRM_PRODUCT_OUTSIDE_BUSINESS_CONTEXTCRM_ROWS_EMPTYCRM_ROWS_LIMITCRM_ROW_QUANTITY_INVALIDCRM_CURRENCY_MISMATCHCRM_OFFER_TOKEN_INVALIDCRM_OFFER_EXPIREDCRM_OFFER_ALREADY_ANSWEREDCRM_OFFER_INVALIDATEDCRM_AGREEMENT_TRANSITION_INVALIDCRM_AGREEMENT_LOCKEDCRM_AGREEMENT_CANCELLEDCRM_AGREEMENT_START_DATE_MISSINGCRM_LEASABLE_UNIT_OCCUPIEDCRM_SIGNED_DOCUMENT_REJECTEDCRM_SIGNING_NOT_AVAILABLECRM_CONTRACT_BODY_MISSINGCRM_CONTRACT_VALUES_MISSINGCRM_CONTRACT_VARIABLE_UNKNOWNCRM_CONTRACT_PLACEHOLDERS_OPENCRM_CONTRACT_RENDER_FAILEDCRM_SIGNING_ATTEMPT_LIVECRM_SIGNING_ATTEMPT_ENDEDCRM_SIGNER_BUSINESS_CONTEXT_INVALIDCRM_SIGNER_NOT_ELIGIBLECRM_SIGNER_ALREADY_ADDEDCRM_SIGNER_UNAVAILABLECRM_SIGNING_PARTY_REPEATEDAPPLICATION_SECRET_LIMIT_REACHEDAPPLICATION_SECRET_NOT_FOUNDVALIDATION_FAILEDINTEGRATIONS_APP_INVALIDINTEGRATIONS_APP_ALREADY_EXISTSINTEGRATIONS_APP_INSTALLEDINTEGRATIONS_APP_ALREADY_INSTALLEDINTEGRATIONS_CONSENT_MISMATCHINTEGRATIONS_ROLE_NOT_GRANTABLEINTEGRATIONS_CONTEXT_LEVEL_MISMATCHINTEGRATIONS_CONFIGURATION_INVALIDINTEGRATIONS_POINT_ALREADY_FILLEDINTEGRATIONS_CONFIGURATION_NOT_FOUNDINTEGRATIONS_CONNECTION_NOT_SUPPORTEDINTEGRATIONS_CONNECTION_REFERENCE_INVALIDASSISTANT_CONVERSATION_NOT_FOUNDASSISTANT_CONFIRMATION_NOT_PENDINGASSISTANT_TURN_LIMIT_REACHEDASSISTANT_RATE_LIMITEDASSISTANT_MODEL_FAILEDASSISTANT_TURN_INTERRUPTED

issuesobject[]

With VALIDATION_FAILED: one entry per field that failed validation, each with its path and message.

401

The access token is missing, expired or not valid.

typestringrequired

Always about:blank.

titlestringrequired

The HTTP status phrase, for example Not Found.

statusintegerrequired

The HTTP status code.

min -9007199254740991 · max 9007199254740991

detailstring

What went wrong, for a person to read. Do not parse it.

codestring

Names the rule that refused the request. Match on this, not on detail.

issuesobject[]

With VALIDATION_FAILED: one entry per field that failed validation, each with its path and message.

403

The token does not allow this request.

typestringrequired

Always about:blank.

titlestringrequired

The HTTP status phrase, for example Not Found.

statusintegerrequired

The HTTP status code.

min -9007199254740991 · max 9007199254740991

detailstring

What went wrong, for a person to read. Do not parse it.

codestring

Names the rule that refused the request. Match on this, not on detail.

issuesobject[]

With VALIDATION_FAILED: one entry per field that failed validation, each with its path and message.

404

The resource does not exist, or the token cannot see it.

typestringrequired

Always about:blank.

titlestringrequired

The HTTP status phrase, for example Not Found.

statusintegerrequired

The HTTP status code.

min -9007199254740991 · max 9007199254740991

detailstring

What went wrong, for a person to read. Do not parse it.

codestring

Names the rule that refused the request. Match on this, not on detail.

issuesobject[]

With VALIDATION_FAILED: one entry per field that failed validation, each with its path and message.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.hydda.one/v1/booking/booking-requests/preview' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "bookableResourceId": "a7680a56-e013-43cc-a54c-cfce58b19ae9",
  "timeSpec": {
    "model": "time_interval",
    "startsAt": "2019-08-24T14:15:22Z",
    "endsAt": "2019-08-24T14:15:22Z"
  },
  "roomLayout": "conference",
  "addOnLines": [
    {
      "addOnProductId": "fab40674-db81-47db-9e19-d14c2fc0ec37",
      "quantity": 1,
      "deliveryAt": "2019-08-24T14:15:22Z",
      "specialPortions": [
        {
          "count": 1,
          "dietaryOptions": [
            "vegetarian"
          ]
        }
      ],
      "note": "string"
    }
  ]
}'

const response = await fetch("https://api.hydda.one/v1/booking/booking-requests/preview", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"bookableResourceId\": \"a7680a56-e013-43cc-a54c-cfce58b19ae9\",\n  \"timeSpec\": {\n    \"model\": \"time_interval\",\n    \"startsAt\": \"2019-08-24T14:15:22Z\",\n    \"endsAt\": \"2019-08-24T14:15:22Z\"\n  },\n  \"roomLayout\": \"conference\",\n  \"addOnLines\": [\n    {\n      \"addOnProductId\": \"fab40674-db81-47db-9e19-d14c2fc0ec37\",\n      \"quantity\": 1,\n      \"deliveryAt\": \"2019-08-24T14:15:22Z\",\n      \"specialPortions\": [\n        {\n          \"count\": 1,\n          \"dietaryOptions\": [\n            \"vegetarian\"\n          ]\n        }\n      ],\n      \"note\": \"string\"\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://api.hydda.one/v1/booking/booking-requests/preview",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"bookableResourceId\": \"a7680a56-e013-43cc-a54c-cfce58b19ae9\",\n  \"timeSpec\": {\n    \"model\": \"time_interval\",\n    \"startsAt\": \"2019-08-24T14:15:22Z\",\n    \"endsAt\": \"2019-08-24T14:15:22Z\"\n  },\n  \"roomLayout\": \"conference\",\n  \"addOnLines\": [\n    {\n      \"addOnProductId\": \"fab40674-db81-47db-9e19-d14c2fc0ec37\",\n      \"quantity\": 1,\n      \"deliveryAt\": \"2019-08-24T14:15:22Z\",\n      \"specialPortions\": [\n        {\n          \"count\": 1,\n          \"dietaryOptions\": [\n            \"vegetarian\"\n          ]\n        }\n      ],\n      \"note\": \"string\"\n    }\n  ]\n}",
)

Response

{
  "startsAt": "2019-08-24T14:15:22Z",
  "endsAt": "2019-08-24T14:15:22Z",
  "quote": {
    "priceRuleId": "d46a626c-f2f2-4dea-a792-32cbc3f4487f",
    "tenantGroupId": "a2391159-2e80-43b1-951a-3e9ccb268947",
    "pricingUnit": "hour",
    "quantity": 1,
    "unitPrice": {
      "minorUnits": 0,
      "currency": "SEK"
    },
    "amount": {
      "minorUnits": 0,
      "currency": "SEK"
    },
    "vatRateBasisPoints": 0,
    "vatTreatment": "exempt",
    "totalAmount": {
      "minorUnits": 0,
      "currency": "SEK"
    },
    "vatBreakdown": [
      {
        "vatRateBasisPoints": 0,
        "vatTreatment": "exempt",
        "amount": {
          "minorUnits": 0,
          "currency": "SEK"
        }
      }
    ],
    "cancellationDeadline": "2019-08-24T14:15:22Z"
  },
  "addOnLines": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "addOnProductId": "fab40674-db81-47db-9e19-d14c2fc0ec37",
      "productName": "string",
      "kind": "catering",
      "pricingUnit": "per_person",
      "quantity": 1,
      "deliveryAt": "2019-08-24T14:15:22Z",
      "specialPortions": [
        {
          "count": 1,
          "dietaryOptions": [
            "vegetarian"
          ]
        }
      ],
      "note": "string",
      "unitPrice": {
        "minorUnits": 0,
        "currency": "SEK"
      },
      "amount": {
        "minorUnits": 0,
        "currency": "SEK"
      },
      "vatRateBasisPoints": 0,
      "vatTreatment": "exempt",
      "cancellationCutoffMinutes": 0,
      "cancellationDeadline": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "chargeEmitted": true,
      "orderedByGuest": true
    }
  ],
  "addOnAmount": {
    "minorUnits": 0,
    "currency": "SEK"
  }
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "TWIN_NODE_NOT_FOUND",
  "issues": [
    {
      "property1": null,
      "property2": null
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "TWIN_NODE_NOT_FOUND",
  "issues": [
    {
      "property1": null,
      "property2": null
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "TWIN_NODE_NOT_FOUND",
  "issues": [
    {
      "property1": null,
      "property2": null
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "TWIN_NODE_NOT_FOUND",
  "issues": [
    {
      "property1": null,
      "property2": null
    }
  ]
}