{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:hetras-certification-booking/addons-get":{"get":{"operationId":"open_data_hetras_certification_booking_addons_get","summary":"Get a list of offers for addon services for the specified guest stay details.","description":"GET /api/booking/v0/addons","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"Specifies the hotel id to request offers for.","schema":{"type":"integer","description":"Specifies the hotel id to request offers for."}},{"name":"arrivalDate","in":"query","required":true,"description":"Date from when the addon service will be booked to the reservation in the ISO-8601 format \"YYYY-MM-DD\".","schema":{"type":"string","description":"Date from when the addon service will be booked to the reservation in the ISO-8601 format \"YYYY-MM-DD\"."}},{"name":"departureDate","in":"query","required":true,"description":"Date until when the addon service will be booked to the reservation in the ISO-8601 format \"YYYY-MM-DD\". This is usually the departure…","schema":{"type":"string","description":"Date until when the addon service will be booked to the reservation in the ISO-8601 format \"YYYY-MM-DD\". This is usually the departure…"}},{"name":"channelCode","in":"query","required":true,"description":"Channel Code the rate plan needs to be configured for.","schema":{"type":"string","description":"Channel Code the rate plan needs to be configured for."}},{"name":"adults","in":"query","required":true,"description":"Number of adults per room.","schema":{"type":"string","description":"Number of adults per room."}},{"name":"rooms","in":"query","required":true,"description":"Number of rooms.","schema":{"type":"string","description":"Number of rooms."}},{"name":"roomType","in":"query","required":true,"description":"Only return offers for the specified room type code.","schema":{"type":"string","description":"Only return offers for the specified room type code."}},{"name":"ratePlanCode","in":"query","required":true,"description":"Only return offers for the specified rate plan code.","schema":{"type":"string","description":"Only return offers for the specified rate plan code."}},{"name":"expand","in":"query","required":false,"description":"Expand the rates breakdown if required.","schema":{"type":"string","enum":["None","Breakdown"],"description":"Expand the rates breakdown if required."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/availability-get":{"get":{"operationId":"open_data_hetras_certification_booking_availability_get","summary":"Gets the availability and occupancy for a specific hotel and timespan.","description":"GET /api/booking/v0/availability","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"Specifies the hotel id to request the availability for.","schema":{"type":"integer","description":"Specifies the hotel id to request the availability for."}},{"name":"from","in":"query","required":true,"description":"Defines the first business day you would like to get availability numbers for.","schema":{"type":"string","description":"Defines the first business day you would like to get availability numbers for."}},{"name":"to","in":"query","required":true,"description":"Defines the last business day you would like to get availability numbers for. The maximum time span between from ´and to is limited to 365…","schema":{"type":"string","description":"Defines the last business day you would like to get availability numbers for. The maximum time span between from ´and to is limited to 365…"}},{"name":"expand","in":"query","required":false,"description":"You can expand the room types breakdown per business day for the availibility numbers if need be.","schema":{"type":"string","enum":["RoomTypes"],"description":"You can expand the room types breakdown per business day for the availibility numbers if need be."}},{"name":"skip","in":"query","required":false,"description":"Amount of items to skip.","schema":{"type":"integer","description":"Amount of items to skip."}},{"name":"top","in":"query","required":false,"description":"Amount of items to select.","schema":{"type":"integer","description":"Amount of items to select."}},{"name":"inlinecount","in":"query","required":false,"description":"Return total number of items for a given filter criteria.","schema":{"type":"string","enum":["None","AllPages"],"description":"Return total number of items for a given filter criteria."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/blocks-get-blocks-async":{"get":{"operationId":"open_data_hetras_certification_booking_blocks_get_blocks_async","summary":"Gets a list of blocks.","description":"GET /api/booking/v0/blocks","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":false,"description":"Only return blocks for this specific hotel.","schema":{"type":"integer","description":"Only return blocks for this specific hotel."}},{"name":"groupCode","in":"query","required":false,"description":"Filter the blocks by the specified group code","schema":{"type":"string","description":"Filter the blocks by the specified group code"}},{"name":"from","in":"query","required":false,"description":"Return all blocks where the block's last_departure is greater than specified date.","schema":{"type":"string","description":"Return all blocks where the block's last_departure is greater than specified date."}},{"name":"to","in":"query","required":false,"description":"Return all blocks where the block's last_departure is less than specified date.","schema":{"type":"string","description":"Return all blocks where the block's last_departure is less than specified date."}},{"name":"status","in":"query","required":false,"description":"Return all blocks where the block status is one of the specified values.","schema":{"type":"string","enum":["Cancelled","Tentative","Definite"],"description":"Return all blocks where the block status is one of the specified values."}},{"name":"ratePlanCodes","in":"query","required":false,"description":"Return all blocks that have related the specified comma-separated rate plans.","schema":{"type":"array","description":"Return all blocks that have related the specified comma-separated rate plans."}},{"name":"countDetails","in":"query","required":false,"description":"If true it will include also details of block count per each room type.","schema":{"type":"boolean","description":"If true it will include also details of block count per each room type."}},{"name":"skip","in":"query","required":false,"description":"Amount of items to skip.","schema":{"type":"integer","description":"Amount of items to skip."}},{"name":"top","in":"query","required":false,"description":"Amount of items to select.","schema":{"type":"integer","description":"Amount of items to select."}},{"name":"inlinecount","in":"query","required":false,"description":"Return total number of items for a given filter criteria.","schema":{"type":"string","enum":["None","AllPages"],"description":"Return total number of items for a given filter criteria."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/blocks-get-blocks-count-async":{"get":{"operationId":"open_data_hetras_certification_booking_blocks_get_blocks_count_async","summary":"Get total blocks count that match the given filter criteria.","description":"GET /api/booking/v0/blocks/$count","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":false,"description":"Only return blocks for this specific hotel.","schema":{"type":"integer","description":"Only return blocks for this specific hotel."}},{"name":"groupCode","in":"query","required":false,"description":"Filter the blocks by the specified group code","schema":{"type":"string","description":"Filter the blocks by the specified group code"}},{"name":"from","in":"query","required":false,"description":"Return all blocks where the block's last_departure is greater than specified date.","schema":{"type":"string","description":"Return all blocks where the block's last_departure is greater than specified date."}},{"name":"to","in":"query","required":false,"description":"Return all blocks where the block's last_departure is less than specified date.","schema":{"type":"string","description":"Return all blocks where the block's last_departure is less than specified date."}},{"name":"status","in":"query","required":false,"description":"Return all blocks where the block status is one of the specified values.","schema":{"type":"string","enum":["Cancelled","Tentative","Definite"],"description":"Return all blocks where the block status is one of the specified values."}},{"name":"ratePlanCodes","in":"query","required":false,"description":"Return all blocks that have related the specified comma-separated rate plans.","schema":{"type":"array","description":"Return all blocks that have related the specified comma-separated rate plans."}},{"name":"countDetails","in":"query","required":false,"description":"If true it will include also details of block count per each room type.","schema":{"type":"boolean","description":"If true it will include also details of block count per each room type."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/blocks-get-single-block-async":{"get":{"operationId":"open_data_hetras_certification_booking_blocks_get_single_block_async","summary":"Gets the details for a specific block.","description":"GET /api/booking/v0/blocks/{blockCode}","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"blockCode","in":"query","required":true,"description":"Specifies the block code. The block code is composed of the hotel code, a dash and the block code as shown in the hetras UI.","schema":{"type":"string","description":"Specifies the block code. The block code is composed of the hotel code, a dash and the block code as shown in the hetras UI."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/bookings-get-bookings":{"get":{"operationId":"open_data_hetras_certification_booking_bookings_get_bookings","summary":"Find bookings matching the given filter criteria.","description":"GET /api/booking/v0/bookings","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":false,"description":"Only return bookings for this specific hotel.","schema":{"type":"integer","description":"Only return bookings for this specific hotel."}},{"name":"cancellationId","in":"query","required":false,"description":"Return bookings for this cancellation id.","schema":{"type":"string","description":"Return bookings for this cancellation id."}},{"name":"reservationNumber","in":"query","required":false,"description":"Return bookings matching this reservation number. Please note that reservation numbers are only unique within a hotel. If you don´t…","schema":{"type":"integer","description":"Return bookings matching this reservation number. Please note that reservation numbers are only unique within a hotel. If you don´t…"}},{"name":"customerName","in":"query","required":false,"description":"Return all bookings where the first or lastname of one of the guests or the contact contains the specified value. The search is executed…","schema":{"type":"string","description":"Return all bookings where the first or lastname of one of the guests or the contact contains the specified value. The search is executed…"}},{"name":"customerEmail","in":"query","required":false,"description":"Return all bookings where the primary email address of one of the guests or the contact contains the specified value. The search is…","schema":{"type":"string","description":"Return all bookings where the primary email address of one of the guests or the contact contains the specified value. The search is…"}},{"name":"customerId","in":"query","required":false,"description":"Return all bookings the id of one of the guests or the contact matches the specified value.","schema":{"type":"string","description":"Return all bookings the id of one of the guests or the contact matches the specified value."}},{"name":"roomNumber","in":"query","required":false,"description":"Return all bookings having the specified room number assigned.","schema":{"type":"string","description":"Return all bookings having the specified room number assigned."}},{"name":"externalId","in":"query","required":false,"description":"Return all bookings exactly matching the specified external id. This filter is case sensitive.","schema":{"type":"string","description":"Return all bookings exactly matching the specified external id. This filter is case sensitive."}},{"name":"companyName","in":"query","required":false,"description":"Return all bookings where the name of the linked company or travel agent profile contains the specified value. The search is executed case…","schema":{"type":"string","description":"Return all bookings where the name of the linked company or travel agent profile contains the specified value. The search is executed case…"}},{"name":"companyId","in":"query","required":false,"description":"Return all bookings the id of the company or travel agent profile matches the specified value.","schema":{"type":"string","description":"Return all bookings the id of the company or travel agent profile matches the specified value."}},{"name":"companyEmail","in":"query","required":false,"description":"Return all bookings where the primary email address of the company or the travel agent profile contains the specified value. The search is…","schema":{"type":"string","description":"Return all bookings where the primary email address of the company or the travel agent profile contains the specified value. The search is…"}},{"name":"blockCode","in":"query","required":false,"description":"Return all bookings where the block code matches the specified value.","schema":{"type":"string","description":"Return all bookings where the block code matches the specified value."}},{"name":"reservationStatuses","in":"query","required":false,"description":"Return all bookings where the reservation status is one of the specified values.","schema":{"type":"array","description":"Return all bookings where the reservation status is one of the specified values."}},{"name":"marketCodes","in":"query","required":false,"description":"Return all bookings where the market code is one of the specified values.","schema":{"type":"array","description":"Return all bookings where the market code is one of the specified values."}},{"name":"channelCodes","in":"query","required":false,"description":"Return all bookings where the channel code is one of the specified values.","schema":{"type":"array","description":"Return all bookings where the channel code is one of the specified values."}},{"name":"subChannelCodes","in":"query","required":false,"description":"Return all bookings where the subchannel code is one of the specified values.","schema":{"type":"array","description":"Return all bookings where the subchannel code is one of the specified values."}},{"name":"roomTypes","in":"query","required":false,"description":"Return all bookings where the room type is one of the specified values.","schema":{"type":"array","description":"Return all bookings where the room type is one of the specified values."}},{"name":"ratePlanCodes","in":"query","required":false,"description":"Return all bookings where the rate plan code is one of the specified values.","schema":{"type":"array","description":"Return all bookings where the rate plan code is one of the specified values."}},{"name":"labels","in":"query","required":false,"description":"Return all reservations with at least one of the specified labels.","schema":{"type":"array","description":"Return all reservations with at least one of the specified labels."}},{"name":"from","in":"query","required":false,"description":"Start date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one…","schema":{"type":"string","description":"Start date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one…"}},{"name":"to","in":"query","required":false,"description":"End date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one reservation…","schema":{"type":"string","description":"End date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one reservation…"}},{"name":"dateFilter","in":"query","required":false,"description":"Select a date field you want to filter bookings by. Only one filter at a time can be applied. The to and from dates will then define the…","schema":{"type":"string","enum":["ArrivalDate","DepartureDate","StayDate","CreationDate","ModificationDate"],"description":"Select a date field you want to filter bookings by. Only one filter at a time can be applied. The to and from dates will then define the…"}},{"name":"exclude","in":"query","required":false,"description":"To be able to request reservations without personal data based on GDPR.","schema":{"type":"string","enum":["Customers"],"description":"To be able to request reservations without personal data based on GDPR."}},{"name":"skip","in":"query","required":false,"description":"Amount of items to skip.","schema":{"type":"integer","description":"Amount of items to skip."}},{"name":"top","in":"query","required":false,"description":"Amount of items to select.","schema":{"type":"integer","description":"Amount of items to select."}},{"name":"inlinecount","in":"query","required":false,"description":"Return total number of items for a given filter criteria.","schema":{"type":"string","enum":["None","AllPages"],"description":"Return total number of items for a given filter criteria."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/bookings-create-booking":{"post":{"operationId":"open_data_hetras_certification_booking_bookings_create_booking","summary":"Create a new booking.","description":"POST /api/booking/v0/bookings","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","body"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"sendConfirmation":{"type":"boolean","description":"Whether to send a confirmation email to the primary guest"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/bookings-get-bookings-count":{"get":{"operationId":"open_data_hetras_certification_booking_bookings_get_bookings_count","summary":"Get total count of bookings matchung the given filter criteria.","description":"GET /api/booking/v0/bookings/$count","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":false,"description":"Only return bookings for this specific hotel.","schema":{"type":"integer","description":"Only return bookings for this specific hotel."}},{"name":"cancellationId","in":"query","required":false,"description":"Return bookings for this cancellation id.","schema":{"type":"string","description":"Return bookings for this cancellation id."}},{"name":"reservationNumber","in":"query","required":false,"description":"Return bookings matching this reservation number. Please note that reservation numbers are only unique within a hotel. If you don´t…","schema":{"type":"integer","description":"Return bookings matching this reservation number. Please note that reservation numbers are only unique within a hotel. If you don´t…"}},{"name":"customerName","in":"query","required":false,"description":"Return all bookings where the first or lastname of one of the guests or the contact contains the specified value. The search is executed…","schema":{"type":"string","description":"Return all bookings where the first or lastname of one of the guests or the contact contains the specified value. The search is executed…"}},{"name":"customerEmail","in":"query","required":false,"description":"Return all bookings where the primary email address of one of the guests or the contact contains the specified value. The search is…","schema":{"type":"string","description":"Return all bookings where the primary email address of one of the guests or the contact contains the specified value. The search is…"}},{"name":"customerId","in":"query","required":false,"description":"Return all bookings the id of one of the guests or the contact matches the specified value.","schema":{"type":"string","description":"Return all bookings the id of one of the guests or the contact matches the specified value."}},{"name":"roomNumber","in":"query","required":false,"description":"Return all bookings having the specified room number assigned.","schema":{"type":"string","description":"Return all bookings having the specified room number assigned."}},{"name":"externalId","in":"query","required":false,"description":"Return all bookings exactly matching the specified external id. This filter is case sensitive.","schema":{"type":"string","description":"Return all bookings exactly matching the specified external id. This filter is case sensitive."}},{"name":"companyName","in":"query","required":false,"description":"Return all bookings where the name of the linked company or travel agent profile contains the specified value. The search is executed case…","schema":{"type":"string","description":"Return all bookings where the name of the linked company or travel agent profile contains the specified value. The search is executed case…"}},{"name":"companyId","in":"query","required":false,"description":"Return all bookings the id of the company or travel agent profile matches the specified value.","schema":{"type":"string","description":"Return all bookings the id of the company or travel agent profile matches the specified value."}},{"name":"companyEmail","in":"query","required":false,"description":"Return all bookings where the primary email address of the company or the travel agent profile contains the specified value. The search is…","schema":{"type":"string","description":"Return all bookings where the primary email address of the company or the travel agent profile contains the specified value. The search is…"}},{"name":"blockCode","in":"query","required":false,"description":"Return all bookings where the block code matches the specified value.","schema":{"type":"string","description":"Return all bookings where the block code matches the specified value."}},{"name":"reservationStatuses","in":"query","required":false,"description":"Return all bookings where the reservation status is one of the specified values.","schema":{"type":"array","description":"Return all bookings where the reservation status is one of the specified values."}},{"name":"marketCodes","in":"query","required":false,"description":"Return all bookings where the market code is one of the specified values.","schema":{"type":"array","description":"Return all bookings where the market code is one of the specified values."}},{"name":"channelCodes","in":"query","required":false,"description":"Return all bookings where the channel code is one of the specified values.","schema":{"type":"array","description":"Return all bookings where the channel code is one of the specified values."}},{"name":"subChannelCodes","in":"query","required":false,"description":"Return all bookings where the subchannel code is one of the specified values.","schema":{"type":"array","description":"Return all bookings where the subchannel code is one of the specified values."}},{"name":"roomTypes","in":"query","required":false,"description":"Return all bookings where the room type is one of the specified values.","schema":{"type":"array","description":"Return all bookings where the room type is one of the specified values."}},{"name":"ratePlanCodes","in":"query","required":false,"description":"Return all bookings where the rate plan code is one of the specified values.","schema":{"type":"array","description":"Return all bookings where the rate plan code is one of the specified values."}},{"name":"labels","in":"query","required":false,"description":"Return all reservations with at least one of the specified labels.","schema":{"type":"array","description":"Return all reservations with at least one of the specified labels."}},{"name":"from","in":"query","required":false,"description":"Start date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one…","schema":{"type":"string","description":"Start date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one…"}},{"name":"to","in":"query","required":false,"description":"End date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one reservation…","schema":{"type":"string","description":"End date for the selected date filter. If you select arrival date as date filter the bookings returned will have at least one reservation…"}},{"name":"dateFilter","in":"query","required":false,"description":"Select a date field you want to filter bookings by. Only one filter at a time can be applied. The to and from dates will then define the…","schema":{"type":"string","enum":["ArrivalDate","DepartureDate","StayDate","CreationDate","ModificationDate"],"description":"Select a date field you want to filter bookings by. Only one filter at a time can be applied. The to and from dates will then define the…"}},{"name":"exclude","in":"query","required":false,"description":"To be able to request reservations without personal data based on GDPR.","schema":{"type":"string","enum":["Customers"],"description":"To be able to request reservations without personal data based on GDPR."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/bookings-get-booking":{"get":{"operationId":"open_data_hetras_certification_booking_bookings_get_booking","summary":"Load all reservations for one booking by confirmation id.","description":"GET /api/booking/v0/bookings/{confirmationId}","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"confirmationId","in":"query","required":true,"description":"The confirmation id for the booking to load.","schema":{"type":"string","description":"The confirmation id for the booking to load."}},{"name":"expand","in":"query","required":false,"description":"Specifies the expand type.","schema":{"type":"string","enum":["None","RoomRates"],"description":"Specifies the expand type."}},{"name":"exclude","in":"query","required":false,"description":"Specifies the exclude type.","schema":{"type":"string","enum":["None","Customers"],"description":"Specifies the exclude type."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/bookings-get-reservation":{"get":{"operationId":"open_data_hetras_certification_booking_bookings_get_reservation","summary":"Load a specific reservation from a booking.","description":"GET /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"confirmationId","in":"query","required":true,"description":"The confirmation id for the booking the reservation was made.","schema":{"type":"string","description":"The confirmation id for the booking the reservation was made."}},{"name":"reservationNumber","in":"query","required":true,"description":"Specifies the reservation number for the reservation to load.","schema":{"type":"integer","description":"Specifies the reservation number for the reservation to load."}},{"name":"expand","in":"query","required":false,"description":"Specifies the expand type.","schema":{"type":"string","enum":["None","RoomRates"],"description":"Specifies the expand type."}},{"name":"exclude","in":"query","required":false,"description":"Specifies the exclude type.","schema":{"type":"string","enum":["None","Customers"],"description":"Specifies the exclude type."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/bookings-patch":{"post":{"operationId":"open_data_hetras_certification_booking_bookings_patch","summary":"Partially updates a reservation.","description":"PATCH /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","confirmationId","reservationNumber","body"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"confirmationId":{"type":"string","description":"The confirmation id for the booking the reservation was made."},"reservationNumber":{"type":"integer","description":"Specifies the reservation number for the reservation that has to be updated."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/bookings-post-room-assignment":{"post":{"operationId":"open_data_hetras_certification_booking_bookings_post_room_assignment","summary":"Assign a room to a reservation.","description":"POST /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}/assign_room","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","confirmationId","reservationNumber"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"confirmationId":{"type":"string","description":"The confirmation id for the booking the reservation was made."},"reservationNumber":{"type":"integer","description":"Specifies the reservation number for the reservation the room should be assigned to."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/bookings-cancel-reservation":{"post":{"operationId":"open_data_hetras_certification_booking_bookings_cancel_reservation","summary":"Cancel one reservation.","description":"POST /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}/cancel","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","confirmationId","reservationNumber"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"confirmationId":{"type":"string","description":"The confirmation id for the booking the reservation was made."},"reservationNumber":{"type":"integer","description":"Specifies the reservation number for the reservation to cancel."},"sendConfirmation":{"type":"boolean","description":"Whether to send a confirmation email to the primary guest"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/bookings-check-in":{"post":{"operationId":"open_data_hetras_certification_booking_bookings_check_in","summary":"Performs a check in operation for a reservation.","description":"POST /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}/check_in","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","confirmationId","reservationNumber","body"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"confirmationId":{"type":"string","description":"The confirmation id for the booking the reservation was made."},"reservationNumber":{"type":"integer","description":"Specifies the reservation number for the reservation to be checked in."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/bookings-check-out":{"post":{"operationId":"open_data_hetras_certification_booking_bookings_check_out","summary":"Performs a check out operation for a reservation.","description":"POST /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}/check_out","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","confirmationId","reservationNumber"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"confirmationId":{"type":"string","description":"The confirmation id for the booking the reservation was made."},"reservationNumber":{"type":"integer","description":"Specifies the reservation number for the reservation to be checked out."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/bookings-payment-token":{"post":{"operationId":"open_data_hetras_certification_booking_bookings_payment_token","summary":"Post a payment token for a reservation.","description":"PUT /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}/payment_token","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","confirmationId","reservationNumber","body"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"confirmationId":{"type":"string","description":"The confirmation id for the booking the reservation was made."},"reservationNumber":{"type":"integer","description":"Specifies the reservation number for the reservation to be checked in."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/bookings-terminal-authorization":{"post":{"operationId":"open_data_hetras_certification_booking_bookings_terminal_authorization","summary":"Performs a chip and pin credit card authorization for a reservation.","description":"POST /api/booking/v0/bookings/{confirmationId}/reservations/{reservationNumber}/pre_authorize","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","confirmationId","reservationNumber","body"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"confirmationId":{"type":"string","description":"The confirmation id for the booking the reservation was made."},"reservationNumber":{"type":"integer","description":"Specifies the reservation number for the reservation to be checked in."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/daily-rates-get-daily-rates":{"get":{"operationId":"open_data_hetras_certification_booking_daily_rates_get_daily_rates","summary":"Get a list of daily rates given a hotel Id, a channel code and a date range.","description":"GET /api/booking/v0/daily_rates","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"Define the hotel id to request the availability for.","schema":{"type":"integer","description":"Define the hotel id to request the availability for."}},{"name":"from","in":"query","required":true,"description":"Define the first business day you would like to get availability numbers for. The day should not be in the past.","schema":{"type":"string","description":"Define the first business day you would like to get availability numbers for. The day should not be in the past."}},{"name":"to","in":"query","required":true,"description":"Define the last business day you would like to get rates for (inclusive). The maximum time span between 'From' and 'To' is limited to 365…","schema":{"type":"string","description":"Define the last business day you would like to get rates for (inclusive). The maximum time span between 'From' and 'To' is limited to 365…"}},{"name":"channelCode","in":"query","required":true,"description":"Define the channel code in order to look up the rates for.","schema":{"type":"string","description":"Define the channel code in order to look up the rates for."}},{"name":"expand","in":"query","required":false,"description":"Define the sections you want to expand and get informed about rates for.","schema":{"type":"array","description":"Define the sections you want to expand and get informed about rates for."}},{"name":"ratePlanCodes","in":"query","required":false,"description":"Define the codes of rate plans to show in the response. A list of comma ',' separated rate plan codes.","schema":{"type":"array","description":"Define the codes of rate plans to show in the response. A list of comma ',' separated rate plan codes."}},{"name":"skip","in":"query","required":false,"description":"Amount of items to skip.","schema":{"type":"integer","description":"Amount of items to skip."}},{"name":"top","in":"query","required":false,"description":"Amount of items to select.","schema":{"type":"integer","description":"Amount of items to select."}},{"name":"inlinecount","in":"query","required":false,"description":"Return total number of items for a given filter criteria.","schema":{"type":"string","enum":["None","AllPages"],"description":"Return total number of items for a given filter criteria."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-booking/rates-get":{"get":{"operationId":"open_data_hetras_certification_booking_rates_get","summary":"Get a list of room offers for the specified guest stay details.","description":"GET /api/booking/v0/rates","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"Specifies the hotel id to request offers for.","schema":{"type":"integer","description":"Specifies the hotel id to request offers for."}},{"name":"arrivalDate","in":"query","required":true,"description":"Date of arrival for the guest in the ISO-8601 format \"YYYY-MM-DD\".","schema":{"type":"string","description":"Date of arrival for the guest in the ISO-8601 format \"YYYY-MM-DD\"."}},{"name":"departureDate","in":"query","required":true,"description":"Date of departure for the guest in the ISO-8601 format \"YYYY-MM-DD\".","schema":{"type":"string","description":"Date of departure for the guest in the ISO-8601 format \"YYYY-MM-DD\"."}},{"name":"channelCode","in":"query","required":true,"description":"Channel Code the rate plan needs to be configured for.","schema":{"type":"string","description":"Channel Code the rate plan needs to be configured for."}},{"name":"adults","in":"query","required":true,"description":"Number of adults per room.","schema":{"type":"string","description":"Number of adults per room."}},{"name":"rooms","in":"query","required":false,"description":"Number of rooms (default is 1).","schema":{"type":"string","description":"Number of rooms (default is 1)."}},{"name":"roomType","in":"query","required":false,"description":"Only return offers with rates for the specified room type code.","schema":{"type":"string","description":"Only return offers with rates for the specified room type code."}},{"name":"ratePlanCode","in":"query","required":false,"description":"Only return offers for the specified room type code.","schema":{"type":"string","description":"Only return offers for the specified room type code."}},{"name":"groupCode","in":"query","required":false,"description":"Only return offers for the specified group code.","schema":{"type":"string","description":"Only return offers for the specified group code."}},{"name":"expand","in":"query","required":false,"description":"Expand the rates breakdown if required.","schema":{"type":"string","enum":["None","Breakdown"],"description":"Expand the rates breakdown if required."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}