Engine Lodging Booking 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 LodgingBookingService. 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
6 operations
across 5 paths,
and defines 81 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.
v1PreviewCancellationError
object
Error details of a failed [LodgingBookingService.PreviewCancellation] call.
1 property
v1ConfirmOfferRequest
object
A request to confirm final pricing and availability of an [OfferSummary].
2 properties
v1BookResponse
object
The result of an attempt to purchase and reserve an [OfferSummary].
1 property
v1SubmitCancellationError
object
Error information returned in the error details of failed SubmitCancellation calls.
3 properties
v1ReservationDetails
object
Details of the Reservation made with the [Property].
5 properties
v1OfferSummary
object
A summary of the attributes available to a specific Offer.
9 properties
v1OfferNoLongerAvailableError
object
An error indicating that the [OfferSummary] is no longer available. This is likely due to the [OfferSummary] being sold out.
v1EngineDirectBill
object
Indicates payment via Engine Direct Bill. If an Engine Direct Bill account has not been established, an [InvalidPaymentError] error will be returned.
v1GeoPoint
object
A single geographic point, defined by latitude and longitude.
2 properties
v1LodgingLoyaltyProgramIdentifier
object
An identifier signifying a traveler's membership in a Loyalty Program. Loyalty Program Identifiers are provided by the administrator of that program. Not all […
1 property
v1GetBookingsError
object
Error details of a failed [LodgingBookingService.GetBookings] call.
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…
v1ActionAvailability
string
Describes the means by which an action may be taken on a [BookingDetails]. - ACTIONAVAILABILITYUNKNOWN: It is unknown if the action is available. It might be a…
v1ConfirmOfferResponse
object
The result of a price and availability check.
2 properties
v1AppliedPaymentInfo
object
Information about the form of payment used in a request.
2 properties
v1RoomGuests
object
Details of the guests staying within a single room during the stay.
2 properties
v1Surcharge
object
An additional charge, fee, or tax.
3 properties
v1BookingMetadata
object
Custom Metadata attached to a [BookingDetails]. Metadata values allow an Omni customer to carry a small amount of context on a [BookingDetails] for their own u…
3 properties
v1SubmitCancellationResponse
object
Returns the result of a requested cancellation.
1 property
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
v1LodgingBookingStatusCode
string
A value representing the state of a [BookingDetails]. - LODGINGBOOKINGSTATUSPENDING: The Booking has been submitted, but has not yet been confirmed. - LODGINGB…
v1RoomDescription
object
Generalized details of the room to which an Offer applies.
5 properties
v1Quote
object
The full details of the item to be Booked.
6 properties
v1Conditions
object
Conditions that describe the availability, penalty, and timing constraints on modification to a booked item.
2 properties
lodgingProperty
object
An individual Lodging location identified by [Engine].
16 properties
v1PerUnitPrice
object
A price representing the cost of a single unit in a multi-unit breakdown. For example, price per night.
3 properties
v1Guest
object
A traveler for the stay.
3 properties
v1CancellationDetails
object
Details of the cancellation of a [BookingDetails].
2 properties
v1AvailableActions
object
Describes the availability of actions on a [BookingDetails].
2 properties
v1BookingNeedsReviewError
object
An error that indicates a [BookingDetails] failed in an unknown state and needs to be manually reviewed to determine if it was completed successfully.
v1AppliedEngineDirectBill
object
Indicates that Engine Direct Bill was used.
v1InvalidStateError
object
An error indicating that the requested [BookingDetails] is not in a valid state to perform the operation.
v1InvalidPaymentError
object
An error indicating that a Booking payment failed due to invalid [PaymentInfo].
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
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
v1PaymentProcessingError
object
An error indicating that a Booking payment failed during processing. These errors are not safe to retry. Contact Member Support for assistance.
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
v1Price
object
The details of the cost of an item or service.
11 properties
v1GenerateFolioError
object
Error information returned in the error details of failed GenerateFolio calls.
1 property
v1Image
object
Represents an [Image] with optional metadata.
1 property
v1GetBookingsResponse
object
The details of a single [BookingDetails].
1 property
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
v1MediaItem
object
A media item for visual or marketing context.
3 properties
v1SubmitCancellationRequest
object
Requests cancellation of a Booking.
1 property
v1ContactEmail
object
Contact email information.
2 properties
lodgingPropertyAmenity
object
[Property] amenity containing name for property features and services.
2 properties
v1GetBookingError
object
Describes a failure to retrieve a single [BookingDetails].
2 properties
v1ConfirmOfferError
object
Error details of a failed [LodgingBookingService.ConfirmOffer] call.
3 properties
v1CurrencyValue
object
A safe encoding of a monetary value and its paired currency code.
2 properties
v1CannotCancelError
object
An error indicating that a [BookingDetails] cannot be canceled.
v1LoyaltyRewardsProgram
object
Represents a single loyalty rewards program.
1 property
v1GuestWithLoyalty
object
A traveler who may be awarded Loyalty Rewards for the stay.
2 properties
lodgingRoomAmenity
object
Room amenity containing name for room features and services.
1 property
v1ActionNotAvailableError
object
An error indicating that an action attempted by the client is unavailable for the given [BookingDetails].
1 property
v1PreviewCancellationRequest
object
Requests the expected result of a cancellation.
1 property
lodgingLodgingAmenityCode
string
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
v1BookRequest
object
A request to purchase and reserve an [OfferSummary].
4 properties
v1Bedding
object
A description of the quantity and type of beds in the room.
2 properties
v1PreviewCancellationResponse
object
Returns the expected result and availability of a cancellation.
2 properties
v1BookingDetails
object
An Engine Lodging [BookingDetails] and the Property [ReservationDetails] it describes.
6 properties
v1AmenityAvailability
string
Describes the condition of an amenity's inclusion on a [Property], [RoomDescription], [OfferSummary], or [BookingDetails]. - AMENITYAVAILABILITYUNKNOWN: The av…
apiHttpBody
object
Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML pag…
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
v1BookingStatus
object
Details describing the observed state of the [BookingDetails].
1 property
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…
v1GetBookingsRequest
object
A request to retrieve one or more [BookingDetails].
1 property
lodgingExternalCatalogIdentifiers
object
External catalog identifiers for property mapping.
2 properties
v1AppliedCardPayment
object
Indicates a card payment was used.
2 properties
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
v1EmailType
string
Describes the type of an email contact. - EMAILTYPEUNSPECIFIED: Unspecified email type. - EMAILTYPEGENERAL: General contact email. - EMAILTYPEBILLING: Billing-…
v1PaymentCard
object
The payment card that will be charged.
5 properties
v1Refund
object
Details that describe any refund due or granted related to a modification or cancellation of a [BookingDetails].
1 property
v1PaymentInfo
object
The payment method used in a request. If omitted, the default payment method configured for the caller will be used. If no default payment method is configured…
2 properties
v1BookError
object
Error details of a failed [LodgingBookingService.Book] call.
5 properties
v1ConditionEventType
string
Events that affect the availability of an action when a specific timestamp is not available.
v1GenerateFolioRequest
object
Generates a folio HTTP response for a Booking.
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Engine publishes across the network.