Engine Lodging Shopping Service API is one of 4 APIs that Engine publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include LodgingShoppingService. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, rate-limit docs, API documentation, an API reference, and a getting-started guide.
This API exposes
2 operations
across 2 paths,
and defines 57 schemas.
It is described by OpenAPI 3.2.0, at version 2.4.0.
Requests are made against a single base URL, https://partner-api.engine.com.
The identity and technical contract details declared by the specification.
v1RoomDescription
object
Generalized details of the room to which an Offer applies.
5 properties
v1FindBestOffersRequestCriteria
object
Defines the base criteria used in a "Best Offers" search.
9 properties
v1SalesChannel
string
- SALESCHANNELUNKNOWN: The sales channel cannot be determined. - SALESCHANNELMOBILENATIVE: The customer is shopping via a mobile application. - SALESCHANNELMOB…
v1Conditions
object
Conditions that describe the availability, penalty, and timing constraints on modification to a booked item.
2 properties
lodgingRoomAmenity
object
Room amenity containing name for room features and services.
1 property
v1BestOffer
object
The details of the Best Offer available for a property given the search criteria and aggregated data about other Offers that are available at the same property…
7 properties
lodgingProperty
object
An individual Lodging location identified by [Engine].
16 properties
v1Distance
object
The distance between two geographic points.
2 properties
v1Image
object
Represents an [Image] with optional metadata.
1 property
v1AnonymousAdult
object
An adult traveler whose personal details have not yet been collected.
v1PerUnitPrice
object
A price representing the cost of a single unit in a multi-unit breakdown. For example, price per night.
3 properties
lodgingLodgingAmenityCode
string
v1FindAvailabilityRequest
object
2 properties
v1FindAvailabilityResponse
object
A response to a [LodgingShoppingService.FindBestOffers] call.
1 property
v1PriceWithPerUnit
object
The total price, along with a breakdown by a given unit. For example, the total stay cost and the per-night cost.
2 properties
v1OfferSummary
object
A summary of the attributes available to a specific Offer.
9 properties
v1CommissionableModel
object
Details for a commissionable pricing model. Under this model, offers must be sold at the exact price quoted by Engine without markup. The seller receives a fix…
1 property
v1Bedding
object
A description of the quantity and type of beds in the room.
2 properties
v1MediaItem
object
A media item for visual or marketing context.
3 properties
v1AmenityAvailability
string
Describes the condition of an amenity's inclusion on a [Property], [RoomDescription], [OfferSummary], or [BookingDetails]. - AMENITYAVAILABILITYUNKNOWN: The av…
v1FindBestOffersRequest
object
3 properties
v1OfferAmenities
object
OfferAmenities represent the value added by the individual offer to be evaluated against other offers. OfferAmenities do not include amenities conferred by the…
3 properties
v1FindBestOffersError
object
Error details of a failed [LodgingShoppingService.FindBestOffers] call.
1 property
v1RoomGroup
object
A grouping of bookable Offers, collected by the [RoomDescription] to which they apply.
2 properties
v1InvalidSortError
object
An error indicating that the requested sorting option provided is not valid for the given search criteria.
v1SurchargeType
string
A programmatic classification of types of surcharges that could be levied. - SURCHARGETYPEPREPAIDFEE: A fee due at time of booking. - SURCHARGETYPEPOSTPAIDFEE:…
v1FixedModel
object
Details for a fixed pricing model. Under this model, offers must be sold at the exact price quoted by Engine without markup. The seller does not receive commis…
lodgingExternalCatalogIdentifiers
object
External catalog identifiers for property mapping.
2 properties
v1AnonymousChild
object
A child traveler whose personal details have not yet been collected. A child's age is necessary to retrieve the correct prices. Failure to provide an accurate…
2 properties
v1ContactEmail
object
Contact email information.
2 properties
v1GeoPoint
object
A single geographic point, defined by latitude and longitude.
2 properties
v1DistanceUnit
string
The unit type for a distance measurement. - DISTANCEUNITMILE: A mile in the imperial system of units. - DISTANCEUNITKILOMETER: A kilometer in the international…
v1AnonymousTraveler
object
A traveler whose personal details have not yet been collected.
2 properties
lodgingPropertyAmenity
object
[Property] amenity containing name for property features and services.
2 properties
shoplodgingservicev1ResponsiveProperty
object
A Property that is responsive to the current shopping search.
2 properties
v1FindBestOffersSortMode
string
Describes the various ways a [LodgingShoppingService.FindBestOffers] search maybe sorted. - FINDBESTOFFERSSORTMODEUNSPECIFIED: No specific sort criteria will b…
shoplodgingservicev1RadiusSearch
object
A search area in a perfect circle around a central point.
2 properties
v1CurrencyValue
object
A safe encoding of a monetary value and its paired currency code.
2 properties
v1RateData
object
RateData contains rate information if and only if an Offer corresponds to a rate negotiated and contracted with the calling credential.
1 property
v1EmailType
string
Describes the type of an email contact. - EMAILTYPEUNSPECIFIED: Unspecified email type. - EMAILTYPEGENERAL: General contact email. - EMAILTYPEBILLING: Billing-…
v1LoyaltyRewardsProgram
object
Represents a single loyalty rewards program.
1 property
v1NetModel
object
Details for a net pricing model. Under this model, offers are provided at a net price which the seller is expected to mark up. The seller's earnings consist of…
v1FindAvailabilityPropertyRequest
object
A request to find availability for a single [Property].
7 properties
v1PropertyIdSearch
object
A list of Engine Property IDs to shop for Best Offers.
1 property
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
v1FindBestOffersResponse
object
The results of a [LodgingShoppingService.FindBestOffers] search.
1 property
v1ConditionEventType
string
Events that affect the availability of an action when a specific timestamp is not available.
v1Condition
object
An individual condition to be applied to an interaction with a booked item. For example, to cancel, or extend a Lodging [BookingDetails].
5 properties
rpcStatus
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
v1Offer
object
A bookable Offer representing a set of amenities and a price for the booking.
2 properties
v1Surcharge
object
An additional charge, fee, or tax.
3 properties
v1PropertyBestOffer
object
A Property and the BestOffer available for that Property given the provided search criteria.
2 properties
v1SellType
object
The sell type of an offer. Defines seller compensation and pricing guidelines for this offer. The type determines whether the seller earns through commission,…
3 properties
v1PriceLineItem
object
A individual service or upgrade added to an item during the shopping experience.
3 properties
v1PostalAddress
object
Represents a Postal Address.
7 properties
lodgingExternalCatalogIdentifierList
object
A list of external catalog identifiers for a single catalog key.
1 property
v1Price
object
The details of the cost of an item or service.
11 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Engine publishes across the network.
