Protocol Documentation
Table of Contents
engine/shop/lodging/v1/offer.proto
OfferAmenities
OfferAmenities represent the value added by the individual offer to be evaluated against other offers. OfferAmenities do not include amenities conferred by the Property. For example, if a given Property provides free breakfast to all guests, none of the Offers for that property will have Free Breakfast as an amenity.
| Field | Type | Label | Description |
|---|---|---|---|
| free_breakfast | engine.common.v1.AmenityAvailability | Describes the availability of free breakfast for the offer or booking. | |
| free_parking | engine.common.v1.AmenityAvailability | Describes the availability of free parking for the offer or booking. | |
| other_amenities | string | repeated | Textual descriptions for display purposes of assorted amenities of the offer or booking that have not been explicitly hoisted to their own attribute. |
OfferSummary
A summary of the attributes available to a specific Offer.
| Field | Type | Label | Description |
|---|---|---|---|
| property_id | string | The Engine identifier for the Property to which this Offer belongs. | |
| description | string | A textual description of the Offer. | |
| price | engine.common.v1.PriceWithPerUnit | The pricing details for the Offer. This price indicates the amount owed to Engine at the time of booking. Refer to OfferSummary.sell_type for details on how the offer may be priced to the customer. | |
| offer_amenities | OfferAmenities | Amenities that may only apply to this Offer. For example, some Offers may include parking. | |
| conditions | engine.common.v1.Conditions | The conditions covering refundability and cancellation. | |
| is_loyalty_eligible | bool | If true, this Offer may earn loyalty points. | |
| is_loyalty_membership_id_required | bool | If true, this offer requires a loyalty membership id to book. | |
| rate_data | RateData | Optionally, if this offer represents a negotiated rate specifically configured for your credential, the details of that rate will be included here. | |
| sell_type | engine.common.v1.SellType | The sell type for this offer. Defines how the seller is compensated and the pricing guidelines for this offer. See SellType for details on available model types and their pricing rules. |
RateData
RateData contains rate information if and only if an Offer corresponds to a rate negotiated and contracted with the calling credential.
| Field | Type | Label | Description |
|---|---|---|---|
| rate_code | string | The rate code associated with the Offer. For example, if a Partner has negotiated a rate code of "123", and an Offer corresponds to that rate code, this field will be "123". Contact Engine to load any rates codes for your credential |
engine/shop/lodging/v1/room.proto
Bedding
A description of the quantity and type of beds in the room.
| Field | Type | Label | Description |
|---|---|---|---|
| count | int32 | The number of this bed type in the room. | |
| description | string | A textual description of the type of this bed in the room. For example, "KING", "QUEEN", or "SLEEPER". |
RoomDescription
Generalized details of the room to which an Offer applies.
| Field | Type | Label | Description |
|---|---|---|---|
| title | string | The title of a room. For example, "Standard 1 King Bed", or "Suite 1 King Bed", "The Canary Suite". | |
| description | string | A textual marketing description of the room. For example, "SKYLINE VIEW KING ROOM -CITY OR RIVER VIEW 1 KING -430 SQF" | |
| beds | Bedding | repeated | The available bedding for the room. |
| photos | string | repeated | URIs to photos of this room. |
| amenities | engine.content.v1.lodging.RoomAmenity | repeated | A list of amenities that are available in the room. |