Skip to main content

BookingDetails

providerApartmentIdstring
arrivalstring<date>
departurestring<date>
guests object[]
  • Array [
  • ageinteger<int32>

    Age of the guest, can be null if it is not required by capacity rules or provider config

  • ]
  • customer object

    Model of the Customer.

    firstNamestring
    lastNamestring
    emailstring
    genderstring

    Possible values: [MALE, FEMALE]

    zipstring
    citystring
    streetstring
    countrystring

    Country code represented in standard ISO 3166-1 ALPHA-2 format

    Example: DE
    phonestring
    languagestring
    specialCustomerRequeststring
    guestReceipt object
    costs object[]
  • Array [
  • idstring
    namestring
    basisOfCalculationstring
    paymentTimestring
    typestring
    pricePerUnit object
    amountnumber
    currencystring
    unitsSelectedinteger<int32>
    totalPrice object
    amountnumber
    currencystring
  • ]
  • discount object
    discountIdinteger<int64>
    providerDiscountIdstring
    namestring
    discountTypestring

    Possible values: [EARLY_BIRD, LAST_MINUTE, LONG_STAY, DEVICE_SPECIFIC, NEW_LISTING, LOYALTY, OFFER]

    percentagenumber
    conditions object
    daysBeforeCheckIninteger<int32>

    Number of days before checkin the booking has to be made

    Example: 60
    minStayinteger<int32>

    Minimum Stay (days) if required to get the discount

    Example: 5
    bookingSeason object[]

    Booking date must be in seasons for the discount to apply

  • Array [
  • onlyApplicableFromstring<date>

    Only applicable from date

    Example: 2020-08-01
    onlyApplicableUntilstring<date>

    Only applicable until date

    Example: 2021-04-30
  • ]
  • travelSeason object[]

    Stay must be within seasons for the discount to apply

  • Array [
  • onlyApplicableFromstring<date>

    Only applicable from date

    Example: 2020-08-01
    onlyApplicableUntilstring<date>

    Only applicable until date

    Example: 2021-04-30
  • ]
  • deviceTypestring

    If the discount is applicable only for specific device.

    Possible values: [MOBILE, DESKTOP]

    userTypestring

    If discount is applicable based on user type.

    Possible values: [USER_AUTHENTICATED]

    amount object
    amountnumber
    currencystring
    bareRentalPrice object
    amountnumber
    currencystring
    paymentProcessing object
    paymentWithBooking object
    paymentPlanUuidstring
    paymentHandlerstring
    paymentMethodstring
    paymentTotalWithBooking object
    amountnumber
    currencystring
    paymentRates object[]
  • Array [
  • dueDatestring<date-time>
    value object
    amountnumber
    currencystring
  • ]
  • paymentOnsite object[]
  • Array [
  • amountnumber
    currencystring
  • ]
  • cancellationFees object[]
  • Array [
  • validUntilstring<date-time>
    feeInPercentagenumber
  • ]
  • metaData object
    bookedAtstring<date-time>
    createdAtstring<date-time>
    updatedAtstring<date-time>
    statusstring

    Possible values: [PENDING, CONFIRMED, CANCELLED, DELETED]

    cancelledAtstring<date-time>
    holiduBookingIdinteger<int64>
    commission object
    percentagenumber

    Holidu percentage commission for this booking, if percentage deal

    commissionToHolidu object
    amountnumber
    currencystring
    rateIdstring
    BookingDetails
    {
    "providerApartmentId": "string",
    "arrival": "2024-07-29",
    "departure": "2024-07-29",
    "guests": [
    {
    "age": 0
    }
    ],
    "customer": {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "gender": "MALE",
    "zip": "string",
    "city": "string",
    "street": "string",
    "country": "DE",
    "phone": "string",
    "language": "string"
    },
    "specialCustomerRequest": "string",
    "guestReceipt": {
    "costs": [
    {
    "id": "string",
    "name": "string",
    "basisOfCalculation": "string",
    "paymentTime": "string",
    "type": "string",
    "pricePerUnit": {
    "amount": 0,
    "currency": "string"
    },
    "unitsSelected": 0,
    "totalPrice": {
    "amount": 0,
    "currency": "string"
    }
    }
    ],
    "discount": {
    "discountId": 0,
    "providerDiscountId": "string",
    "name": "string",
    "discountType": "EARLY_BIRD",
    "percentage": 0,
    "conditions": {
    "daysBeforeCheckIn": 60,
    "minStay": 5,
    "bookingSeason": [
    {
    "onlyApplicableFrom": "2020-08-01",
    "onlyApplicableUntil": "2021-04-30"
    }
    ],
    "travelSeason": [
    {
    "onlyApplicableFrom": "2020-08-01",
    "onlyApplicableUntil": "2021-04-30"
    }
    ],
    "deviceType": "MOBILE",
    "userType": "USER_AUTHENTICATED"
    },
    "amount": {
    "amount": 0,
    "currency": "string"
    }
    },
    "bareRentalPrice": {
    "amount": 0,
    "currency": "string"
    }
    },
    "paymentProcessing": {
    "paymentWithBooking": {
    "paymentPlanUuid": "string",
    "paymentHandler": "string",
    "paymentMethod": "string",
    "paymentTotalWithBooking": {
    "amount": 0,
    "currency": "string"
    },
    "paymentRates": [
    {
    "dueDate": "2024-07-29T15:51:28.071Z",
    "value": {
    "amount": 0,
    "currency": "string"
    }
    }
    ]
    },
    "paymentOnsite": [
    {
    "amount": 0,
    "currency": "string"
    }
    ]
    },
    "cancellationFees": [
    {
    "validUntil": "2024-07-29T15:51:28.071Z",
    "feeInPercentage": 0
    }
    ],
    "metaData": {
    "bookedAt": "2024-07-29T15:51:28.071Z",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z",
    "status": "PENDING",
    "cancelledAt": "2024-07-29T15:51:28.071Z",
    "holiduBookingId": 0,
    "commission": {
    "percentage": 0,
    "commissionToHolidu": {
    "amount": 0,
    "currency": "string"
    }
    }
    },
    "rateId": "string"
    }