Descripción general
Esta API te permite especificar posibles descuentos. De las promociones especificadas, Google aplica la promoción apta o el conjunto de promociones que genera el precio más bajo. Si buscas una API que admita ajustes de frecuencia arbitrarios que puedan aumentar o disminuir el precio cuando se cumplan las condiciones, considera nuestra API de Rate Modifications. Ten en cuenta que, si ambas APIs están presentes, las modificaciones de tarifa se aplican antes de las promociones.
Solicitudes
Sintaxis
El mensaje Promotions
usa la siguiente sintaxis:
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner= "partner_key"
id="message_ID"
timestamp="timestamp">
<HotelPromotions hotel_id="HotelID" action="[overlay]">
<Promotion id="PromotionID" action="[delete]">
<BookingDates>
<DateRange start="YYYY-MM-DD[THH:mm:ss]" end="YYYY-MM-DD[THH:mm:ss]"
days_of_week="MTWHFSU_or_subset"/>
<DateRange start="YYYY-MM-DD[THH:mm:ss]" end="YYYY-MM-DD[THH:mm:ss]"
days_of_week="MTWHFSU_or_subset"/>
</BookingDates>
<BookingWindow min="integer_or_duration" max="integer_or_duration"/>
<Ceiling amount_per_night="float"/>
<Floor amount_per_night="float"/>
<CheckinDates>
<DateRange start="[YYYY-]MM-DD" end="[YYYY-]MM-DD" days_of_week="MTWHFSU_or_subset"/>
</CheckinDates>
<CheckoutDates>
<DateRange start="[YYYY-]MM-DD" end="[YYYY-]MM-DD" days_of_week="MTWHFSU_or_subset"/>
</CheckoutDates>
<!-- Specify only one of percentage, fixed_amount, fixed_amount_per_night,
fixed_price, or fixed_price_per_night; applied_nights is only used
with percentage, fixed_amount_per_night, and fixed_price_per_night. -->
<Discount percentage="float" fixed_amount="float" fixed_amount_per_night="float"
fixed_price="float" fixed_price_per_night="float"
applied_nights="integer_1_to_99" rank="integer_1_to_99">
<!-- FreeNights may not be used in conjunction with attributes on Discount -->
<FreeNights stay_nights="integer" discount_nights="integer"
discount_percentage="float" night_selection="[cheapest|last]"
repeats="boolean"/>
</Discount>
<!-- Exactly one of Discount or BestDailyDiscount must be specified.
Specify only one of percentage, fixed_amount, or fixed_price. -->
<BestDailyDiscount percentage="float" fixed_amount="float" fixed_price="float"/>
<Devices>
<Device type="[desktop|tablet|mobile]"/>
</Devices>
<InventoryCount min="integer" max="integer"/>
<LengthOfStay min="integer" max="integer"/>
<MembershipRateRule id="RateRuleID"/>
<MinimumAmount before_discount="integer"/>
<Occupancy min="integer" max="integer"/>
<RatePlans>
<RatePlan id="PackageID_1"/>
<RatePlan id="PackageID_2"/>
</RatePlans>
<RoomTypes>
<RoomType id="RoomID_1"/>
<RoomType id="RoomID_2"/>
</RoomTypes>
<Stacking type="[any|base|none|second]"/>
<StayDates application="[all|any|overlap]">
<DateRange start="[YYYY-]MM-DD" end="[YYYY-]MM-DD" days_of_week="MTWHFSU_or_subset"/>
</StayDates>
<UserCountries type="[include|exclude]">
<Country code="country_code"/>
</UserCountries>
</Promotion>
</HotelPromotions>
</Promotions>
Elementos y atributos
El mensaje de promociones tiene los siguientes elementos y atributos:
Elemento / @Attribute | Occurrences | Tipo | Descripción |
---|---|---|---|
Promotions | 1 | Complex element | Es el elemento raíz de un mensaje de promoción. |
Promotions / @partner | 1 | string | La cuenta de socio de este mensaje. Este valor de cadena es el valor de “Clave de socio” que aparece en la
página Configuración de la cuenta de Hotel Center.
Si tienes un backend que proporciona feeds para varias cuentas, este valor debe coincidir con el valor del atributo |
Promotions / @id | 1 | string | Un identificador único para este mensaje de solicitud. Este valor se muestra en el mensaje de respuesta. Los caracteres permitidos son a-z, A-Z, 0-9, _ (guion bajo) y - (guion). |
Promotions / @timestamp | 1 | DateTime | La fecha y hora de creación de este mensaje. |
Promotions / HotelPromotions | 0..n | HotelPromotions | Promociones de una propiedad. Cada promoción se aplica a una sola propiedad. A menos que se use |
Promotions / HotelPromotions / @hotel_id | 1 | string | Es el identificador único de la propiedad. Este valor debe coincidir con el ID de hotel especificado usando
<id> en el elemento <listing> del feed de lista de hoteles. El ID de hotel también aparece en Hotel Center. |
Promotions / HotelPromotions / @action | 0..1 | enum | Si se especifica, el valor debe ser Si no se especifica, cada promoción especificada en el mensaje actual tendrá una de las siguientes opciones:
|
Promotions / HotelPromotions / Promotion | 0..99 | Promotion | Es una promoción única para una propiedad. Ten en cuenta que, si no se especifica Si necesitas usar más de 99 promociones, comunícate con tu administrador técnico de cuentas (TAM). |
Promotions / HotelPromotions / Promotion / @id | 1 | string | Es un identificador único para la promoción. La cantidad máxima de caracteres permitida es 40. Los caracteres permitidos son a-z, A-Z, 0-9, _ (guion bajo), - (guion) y . (punto). |
Promotions /HotelPromotions / Promotion / @action | 0..1 | enum | Si se especifica, el valor debe ser Si se especifica |
Promotions / HotelPromotions / Promotion / BookingDates | 0..1 | BookingDates | Un contenedor para uno o más rangos que definen cuándo debe ocurrir la reserva para que se aplique la promoción. |
Promotions / HotelPromotions / Promotion / BookingDates / DateRange | 1..99 | DateRange | Es un rango que especifica cuándo debe ocurrir la reserva para que se aplique la promoción. |
Promotions / HotelPromotions / Promotion / BookingDates / DateRange / @start | 0..1 | Date o DateTime | Es la fecha y hora de inicio (según la zona horaria de la propiedad), inclusive, del período.
|
Promotions / HotelPromotions / Promotion / BookingDates / DateRange / @end | 0..1 | Date o DateTime | Es la fecha o hora de finalización (según la zona horaria de la propiedad), inclusive, del rango.
|
Promotions / HotelPromotions / Promotion / BookingDates / DateRange / @days_of_week | 0..1 | string | Indica los días de la semana que se permiten en el período. Si no se especifica, se permiten todos los días en el período. Cada carácter de la cadena especifica un día. Por ejemplo, “MTWHF” especifica que se permiten días de la semana en el período. Los caracteres válidos son los siguientes:
Cualquier combinación de caracteres es válida. |
Promotions / HotelPromotions / Promotion / BookingWindow | 0..1 | BookingWindow | Especifica el período en el que la reserva debe ocurrir en relación con la fecha de entrada (según la zona horaria de la propiedad). Por ejemplo, el período de reserva se puede establecer en un mínimo de 7 días, pero no más de 180 días, antes del registro de entrada. |
Promotions / HotelPromotions / Promotion / BookingWindow / @min | 0..1 | integer or duration | El tiempo mínimo antes del registro de entrada, cuando se realiza la reserva,
para que se aplique la promoción. Si no se especifica o su valor es 0 , no hay un mínimo.
Los tipos de valor válidos son los siguientes:
|
Promotions / HotelPromotions / Promotion / BookingWindow / @max | 0..1 | integer or duration | La cantidad máxima de días antes del registro de entrada en el momento de la reserva
para que se aplique la promoción. Si no se especifica o su valor es 0 , no hay un máximo.
Los tipos de valor válidos son los siguientes:
|
Promotions / HotelPromotions / Promotion / Ceiling | 0..1 | Ceiling |
Define las restricciones sobre el valor máximo que se puede establecer en una tarifa después de que se aplican las promociones. Las promociones siempre deben especificar un Si se configura el apilamiento, podrían aplicarse varias promociones con Ejemplo: El precio de una estadía de 1 noche en la que
Este es el orden de cálculo:
El hecho de que 60 sea un límite general más estricto es irrelevante, ya que es válido solo para su propia promoción, y no puede haber un límite único que abarque toda la pila de promociones. |
Promotions / HotelPromotions / Promotion / Ceiling / @amount_per_night | 1 | float |
El importe máximo que se puede establecer una tarifa por noche después de que se aplica el descuento. Si también se especifica un elemento
|
Promotions / HotelPromotions / Promotion / Floor | 0..1 | Floor |
Define las restricciones sobre el valor mínimo en el que se puede establecer una tarifa después de que se aplican las promociones. Las promociones siempre deben especificar un La lógica de Si se configura el apilamiento, podrían aplicarse varias promociones con Ejemplo: El precio de una estadía de 1 noche en la que
Este es el orden de cálculo:
El hecho de que 90 sea un precio mínimo general más estricto es irrelevante, ya que es válido solo para su propia promoción, y no puede haber un solo precio mínimo que abarque toda la pila de promociones. |
Promotions / HotelPromotions / Promotion / Floor / @amount_per_night | 1 | float |
El importe mínimo en el que se puede establecer una tarifa por noche después de que se aplica el descuento. Si también se especifica un elemento
|
Promotions / HotelPromotions / Promotion / CheckinDates | 0..1 | CheckinDates | Para que se aplique la promoción, debe ocurrir un contenedor de uno o más períodos que definan cuándo se debe registrar. |
Promotions / HotelPromotions / Promotion / CheckinDates / DateRange | 1..20 | DateRange | Un período que especifica cuándo debe ocurrir el registro para que se aplique la promoción. Este elemento no es obligatorio si quieres borrar una o más promociones. También se admite el formato YearlessDate.
|
Promotions / HotelPromotions / Promotion / CheckinDates / DateRange / @start | 0..1 | Date or YearlessDate | Es la fecha de inicio (según la zona horaria de la propiedad), inclusive, del período. Esta fecha debe ser anterior o igual a la de end . Si no se especifica start , el período es efectivamente ilimitado en términos de una fecha de inicio. |
Promotions / HotelPromotions / Promotion / CheckinDates / DateRange / @end | 0..1 | Date or YearlessDate | Es la fecha de finalización (según la zona horaria de la propiedad), inclusive, del período. Esta fecha debe ser igual o posterior a la fecha de start . Si no se especifica end , el período es efectivamente ilimitado en términos de una fecha de finalización. |
Promotions / HotelPromotions / Promotion / CheckinDates / DateRange / @days_of_week | 0..1 | string | Indica los días de la semana que se permiten en el período. Si no se especifica, se permiten todos los días en el período. Cada carácter de la cadena especifica un día. Por ejemplo, “MTWHF” especifica que se permiten días de la semana en el período. Los caracteres válidos son los siguientes:
Cualquier combinación de caracteres es válida. |
Promotions / HotelPromotions / Promotion / CheckoutDates | 0..1 | CheckoutDates | Para que se aplique la promoción, debe ocurrir un contenedor de uno o más períodos que definan cuándo se debe confirmar la compra. |
Promotions / HotelPromotions / Promotion / CheckoutDates / DateRange | 1..20 | DateRange | Un período que especifica cuándo debe ocurrir la confirmación de la compra para que se aplique la promoción. Este elemento no es obligatorio si quieres borrar una o más promociones. También se admite el formato YearlessDate.
|
Promotions / HotelPromotions / Promotion / CheckoutDates / DateRange / @start | 0..1 | Date or YearlessDate | Es la fecha de inicio (según la zona horaria de la propiedad), inclusive, del período. Esta fecha debe ser anterior o igual a la de end . Si no se especifica start , el período es efectivamente ilimitado en términos de una fecha de inicio. |
Promotions / HotelPromotions / Promotion / CheckoutDates / DateRange / @end | 0..1 | Date or YearlessDate | Es la fecha de finalización (según la zona horaria de la propiedad), inclusive, del período. Esta fecha debe ser igual o posterior a la fecha de start . Si no se especifica end , el período es efectivamente ilimitado en términos de una fecha de finalización. |
Promotions / HotelPromotions / Promotion / CheckoutDates / DateRange / @days_of_week | 0..1 | string | Indica los días de la semana que se permiten en el período. Si no se especifica, se permiten todos los días en el período. Cada carácter de la cadena especifica un día. Por ejemplo, “MTWHF” especifica que se permiten días de la semana en el período. Los caracteres válidos son los siguientes:
Cualquier combinación de caracteres es válida. |
Promotions / HotelPromotions / Promotion / Devices | 0..1 | Devices | Contenedor para mostrar una lista de los dispositivos de los usuarios que son aptos para la promoción. Si se especifica, solo se ofrece la tarifa con descuento a los usuarios aptos de los dispositivos de la lista. Si no se especifica, se ofrece la tarifa con descuento a los usuarios aptos de cualquier dispositivo. |
Promotions / HotelPromotions / Promotion / Devices / Device | 1..3 | Device | Define un tipo de dispositivo de usuario que es apto para la promoción. |
Promotions / HotelPromotions / Promotion / Devices / Device / @type | 1 | enum | Es un tipo de dispositivo. El valor debe ser desktop , tablet o mobile . |
Promotions / HotelPromotions / Promotion / Discount | 1 | Discount | Se debe especificar exactamente uno de Especifica el descuento que se aplicará para esta promoción. |
Promotions / HotelPromotions / Promotion / Discount / @percentage | 0..1 | float | Se requiere exactamente uno de los siguientes valores: Un valor decimal de 0 a 100 que especifica el porcentaje de descuento.
Se aplica a Ejemplos:
|
Promotions / HotelPromotions / Promotion / Discount / @fixed_amount | 0..1 | float | Se requiere exactamente uno de los siguientes valores: Una cantidad fija que se restará de la suma de las tarifas por noche de Ejemplos:
|
Promotions / HotelPromotions / Promotion / Discount / @fixed_amount_per_night | 0..1 | float | Se requiere exactamente uno de los siguientes valores: Es un descuento fijo que se aplica a cada una de las tarifas por noche de Ejemplos:
|
Promotions / HotelPromotions / Promotion / Discount / @fixed_price | 0..1 | float | Se requiere exactamente uno de los siguientes valores: Si se especifican tarifas por noche de Si el propósito de Ejemplos:
|
Promotions / HotelPromotions / Promotion / Discount / @fixed_price_per_night | 0..1 | float | Se requiere exactamente uno de los siguientes valores: Si se especifican tarifas por noche de Si el propósito de Si se especifica Ejemplos:
|
Promotions / HotelPromotions / Promotion / Discount / @applied_nights | 0..1 | integer | Solo debe usarse con Es la cantidad de noches a las que se aplica el descuento, comenzando por la menos costosa. Debe ser un número entero entre 1 y 99. Si no se especifica, el descuento se aplica a todas las noches. |
Promotions / HotelPromotions / Promotion / Discount / FreeNights | 0..1 | FreeNights | Especifica un descuento para ciertas noches de una estadía cuando se cumple una duración mínima de la estadía. No se permiten atributos en el elemento Discount superior si se usa este elemento. |
Promotions / HotelPromotions / Promotion / Discount / FreeNights / @stay_nights | 1 | integer | Es la cantidad de noches requeridas para que se aplique el descuento. Cada descuento se aplica a un segmento independiente de noches de estadía. Por ejemplo, para una estadía de 10 noches en la que |
Promotions / HotelPromotions / Promotion / Discount / FreeNights / @discount_nights | 1 | integer | Indica la cantidad de noches con descuento en cada segmento de noches de estadía. |
Promotions / HotelPromotions / Promotion / Discount / FreeNights / @discount_percentage | 1 | float | Es el descuento que se aplica a las noches con descuento. Si este valor es 50 , entonces cada noche seleccionada tiene un 50% de descuento. |
Promotions / HotelPromotions / Promotion / Discount / FreeNights / @night_selection | 1 | string | Debe ser cheapest o last . Si es last , se descontarán las noches al final del segmento de la estadía. Si es cheapest , se descontarán las noches más baratas dentro del segmento de noches de estadía. |
Promotions / HotelPromotions / Promotion / Discount / FreeNights / @repeats | 1 | boolean | Indica si el descuento se puede aplicar a varios segmentos de estadía nocturna. Si es Por ejemplo, si |
Promotions / HotelPromotions / Promotion / Discount / @rank | 0..1 | integer | Asigna una clasificación a esta promoción y la habilita en la selección clasificada, en la que solo se selecciona la promoción con la clasificación más baja. Los valores deben estar entre 1 y 99, ambos incluidos. Si varias promociones comparten la misma clasificación, se selecciona y aplica una de forma arbitraria. |
Promotions / HotelPromotions / Promotion / BestDailyDiscount | 1 | Discount | Se debe especificar exactamente uno de Especifica un descuento diario que se puede aplicar a una noche de estadía. Esto contrasta con Cada propiedad puede tener un solo grupo de promociones que se consideran "mejores todos los días". Esto significa que, por cada noche de estadía, se selecciona la única promoción “mejor diaria” que es apta y genera el descuento más alto para esa noche, que se puede aplicar. No se puede especificar
|
Promotions / HotelPromotions / Promotion / BestDailyDiscount / @percentage | 0..1 | float | Se requiere exactamente uno de los siguientes valores: Un valor decimal de 0 a 100 que especifica el porcentaje de descuento.
Se aplica a Ejemplos:
|
Promotions / HotelPromotions / Promotion/ BestDailyDiscount / @fixed_amount | 0..1 | float | Se requiere exactamente uno de los siguientes valores: Una cantidad fija que se restará de una sola tarifa por noche de Ejemplos:
|
Promotions / HotelPromotions / Promotion/ BestDailyDiscount / @fixed_price | 0..1 | float | Se requiere exactamente uno de los siguientes valores: Si se especifican tarifas por noche de Ejemplos:
|
Promotions / HotelPromotions / Promotion / InventoryCount | 0..1 | InventoryCount | Define las restricciones sobre la cantidad de salas de reuniones que deben estar disponibles para
que se aplique esta promoción. El descuento se aplica solo a las noches que cumplen con la restricción. No se permite con el descuento de
fixed_amount . Ten en cuenta que la cantidad de habitaciones disponibles se especifica con OTA_HotelInvCountNotifRQ (InvCount ) o bien OTA_HotelAvailNotifRQ (BookingLimit ). |
Promotions / HotelPromotions / Promotion / InventoryCount / @min | 0..1 | integer | Es la cantidad mínima de habitaciones que deben estar disponibles para que se aplique la promoción a la tarifa por noche. Si no se especifica, no hay un mínimo. |
Promotions / HotelPromotions / Promotion / InventoryCount / @max | 0..1 | integer | La cantidad máxima de habitaciones que deben estar disponibles para que la promoción se aplique a la tarifa por noche. Si no se especifica, no hay un máximo. |
Promotions / HotelPromotions / Promotion / LengthOfStay | 0..1 | LengthOfStay | Define los límites de duración de la estadía dentro de los que se puede aplicar esta promoción. La promoción no se aplica cuando la duración de la estadía está fuera de los límites mínimo y máximo. |
Promotions / HotelPromotions / Promotion / LengthOfStay / @min | 0..1 | integer | Es la cantidad mínima de noches permitidas en la estadía para que se aplique la promoción. Si no se especifica, no hay un mínimo. |
Promotions / HotelPromotions / Promotion / LengthOfStay / @max | 0..1 | integer | Es la cantidad máxima de noches permitidas en la estadía para que se aplique la promoción. Si no se especifica, no hay un máximo. |
Promotions / HotelPromotions / Promotion / MembershipRateRule | 0..1 | MembershipRateRule |
Contenedor de una regla de tarifas de membresía que activa un tratamiento de IU específico para el descuento asociado. Este elemento no debe especificarse, a menos que también se especifique |
Promotions / HotelPromotions / Promotion / MembershipRateRule / @id | 1 | string |
Es el ID de la regla de tarifas asociada con un programa de membresía. |
Promotions / HotelPromotions / Promotion / MinimumAmount | 0..1 | MinimumAmount | Especifica la suma mínima de las tarifas diarias de las habitaciones (con el valor más alto de AmountBeforeTax o AmountAfterTax ) que deben superarse para que se aplique la promoción. |
Promotions / HotelPromotions / Promotion / MinimumAmount / @before_discount | 1 | integer | Es el valor que se debe superar para que se aplique la promoción. |
Promotions / HotelPromotions / Promotion / Occupancy | 0..1 | Occupancy | Define las restricciones de las ocupaciones en las que se aplica esta promoción. La promoción no se aplica cuando la ocupación está fuera de los límites mínimos y máximos. |
Promotions / HotelPromotions / Promotion / Occupancy / @min | 0..1 | integer | La ocupación especificada por el usuario debe ser de al menos este valor para que se aplique el descuento. |
Promotions / HotelPromotions / Promotion / Occupancy / @max | 0..1 | integer | La ocupación especificada por el usuario debe ser, como máximo, este valor para que se aplique el descuento. |
Promotions / HotelPromotions / Promotion / RatePlans | 0..1 | RatePlans | Contenedor de una lista de los planes de tarifas a los que se aplica la promoción.
Si no se especifica <RatePlans> , la promoción se aplica a todos los planes de tarifas. |
Promotions / HotelPromotions / Promotion / RatePlans / RatePlan | 1..n | RatePlan | Especifica un plan de tarifas. Un plan de tarifas se define mediante una combinación de paquetes, tarifas y disponibilidad, tal como se define en los mensajes de transacción (datos de propiedad), OTA_HotelRateAmountNotifRQ y OTA_HotelAvailNotifRQ, y como lo identifica el PackageID. |
Promotions / HotelPromotions / Promotion / RatePlans / RatePlan / @id | 1 | string | El identificador único del plan de tarifas. Este valor se asigna al valor PackageID en <PackageData> en un mensaje Transaction (Property Data) y en el atributo RatePlanCode en <StatusApplicationControl> en los mensajes <OTA_HotelRateAmountNotifRQ> y <OTA_HotelAvailNotifRQ> .
La cantidad máxima de caracteres permitida es 50. |
Promotions / HotelPromotions / Promotion / RoomTypes | 0..1 | RoomTypes | Contenedor de una lista de los tipos de habitaciones a los que se aplica la promoción.
La promoción se aplica a cada <RoomType>
especificado. Si no se especifica <RoomTypes> , la promoción se aplicará a todas las salas. |
Promotions / HotelPromotions / Promotion / RoomTypes / RoomType | 1..n | RoomType | Especifica un tipo de habitación. Un tipo de habitación se define en un elemento <RoomData> en un mensaje Transacción (datos de propiedad) y se hace referencia a él mediante su valor <RoomID> . (El atributo InvTypeCode también hace referencia a su valor <RoomID> en los mensajes OTA_HotelRateAmountNotifRQ). |
Promotions / HotelPromotions / Promotion / RoomTypes / RoomType / @id | 1 | string | Es el identificador único del inventario (tipo de habitación). Este valor se asigna a <RoomID> en un mensaje de transacción (datos de propiedad).
La cantidad máxima de caracteres permitida es 50. |
Promotions / HotelPromotions / Promotion / Stacking | 0..1 | Stacking | Especifica cómo se pueden combinar las promociones. Si no se especifica, se supone que el "tipo" es base . |
Promotions / HotelPromotions / Promotion / Stacking / @type | 1 | enum | Se pueden aplicar varias promociones a una sola tarifa según este parámetro de configuración:
De las combinaciones permitidas, se aplica a la tarifa el conjunto de promociones que produce el mayor descuento. |
Promotions / HotelPromotions / Promotion / StayDates | 0..1 | StayDates | Un contenedor para uno o más períodos que determinan cómo se aplica la promoción, por ejemplo, para adaptarse a descuentos de temporada. |
Promotions / HotelPromotions / Promotion / StayDates / @application | 1 | enum | Describe cómo se debe aplicar la promoción. Estos son los valores válidos:
Siempre se debe especificar este atributo.
|
Promotions / HotelPromotions / Promotion / StayDates / DateRange | 1..99 | DateRange | Es un período que especifica las fechas en las que se aplicará la promoción. También se admite el formato YearlessDate.
|
Promotions / HotelPromotions / Promotion / StayDates / DateRange / @start | 0..1 | Date or YearlessDate | Es la fecha de inicio (según la zona horaria de la propiedad), inclusive, del período. Esta fecha debe ser anterior o igual a la de end . Si no se especifica start , el período es efectivamente ilimitado en términos de una fecha de inicio. |
Promotions / HotelPromotions / Promotion / StayDates / DateRange / @end | 0..1 | Date or YearlessDate | Es la fecha de finalización (según la zona horaria de la propiedad), inclusive, del período. Esta fecha debe ser igual o posterior a la fecha de start . Si no se especifica end , el período es efectivamente ilimitado en términos de una fecha de finalización. |
Promotions / HotelPromotions / Promotion / StayDates / DateRange / @days_of_week | 0..1 | string | Indica los días de la semana que se permiten en el período. Si no se especifica, se permiten todos los días en el período. Cada carácter de la cadena especifica un día. Por ejemplo, “MTWHF” especifica que se permiten días de la semana en el período. Los caracteres válidos son los siguientes:
Cualquier combinación de caracteres es válida. |
Promotions / HotelPromotions / Promotion / UserCountries | 0..1 | UserCountries | Contenedor para mostrar una lista de las ubicaciones de los usuarios (países) que son aptas para la promoción. Si se especifica, solo se ofrece la tarifa con descuento a los usuarios aptos de los países enumerados. Si no se especifica, se ofrece la tarifa con descuento a los usuarios aptos de cualquier país. |
Promotions / HotelPromotions / Promotion / UserCountries / @type | 0..1 | enum | Es el tipo de especificación de UserCountry.
Los valores válidos son Si el campo UserCountry Si el campo UserCountry Si no estableces el objeto |
Promotions / HotelPromotions / Promotion / UserCountries / Country | 1..300 | Country | Define un país en el que los usuarios son aptos para la promoción. |
Promotions / HotelPromotions / Promotion / UserCountries / Country / @code | 1 | string | Un código de país de CLDR, como DE o FR Ten en cuenta que, en algunos países, el código de país de CLDR no es el mismo que el código de país ISO de 2 letras. Además, los códigos regionales CLDR no son compatibles. |
Ejemplos
Mensaje básico
En el siguiente ejemplo, se muestra un mensaje Promotions
básico:
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1">
<Promotion id="1">
<BookingDates>
<DateRange start="2020-07-01" end="2020-07-31" days_of_week="MTWHF"/>
<DateRange start="2020-09-01" end="2020-09-30"/>
</BookingDates>
<BookingWindow min="7" max="330"/>
<CheckinDates>
<DateRange start="2020-10-01" end="2020-10-31" days_of_week="FSU"/>
</CheckinDates>
<CheckoutDates>
<DateRange start="2020-10-08" end="2020-11-07" days_of_week="FSU"/>
</CheckoutDates>
<Devices>
<Device type="mobile"/>
<Device type="tablet"/>
</Devices>
<Discount percentage="20" applied_nights="2"/>
<LengthOfStay min="2" max="14"/>
<RatePlans>
<RatePlan id="234"/>
<RatePlan id="567"/>
</RatePlans>
<RoomTypes>
<RoomType id="123"/>
<RoomType id="456"/>
</RoomTypes>
<Stacking type="base"/>
<UserCountries>
<Country code="US"/>
<Country code="GB"/>
</UserCountries>
</Promotion>
</HotelPromotions>
</Promotions>
Condición de inventario
En el siguiente ejemplo, se muestra cómo crear un descuento si hay exceso de inventario cerca de la fecha de llegada:
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1">
<Promotion id="1">
<BookingWindow max="7"/>
<Discount percentage="10"/>
<InventoryCount min="3"/>
</Promotion>
</HotelPromotions>
</Promotions>
Borrar una promoción
En el siguiente ejemplo, se muestra cómo borrar una promoción de una propiedad:
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1">
<Promotion id="1" action="delete"/>
</HotelPromotions>
</Promotions>
Borrar todas las promociones
En el siguiente ejemplo, se muestra cómo borrar todas las promociones de una propiedad:
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1" action="overlay"/>
</Promotions>
Superposición de todas las promociones
En el siguiente ejemplo, se muestra cómo superponer <HotelPromotions>
para una propiedad con una o más promociones nuevas. Cuando es action="overlay"
, todas las promociones almacenadas se borran antes de almacenar las promociones especificadas en el mensaje actual:
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1" action="overlay">
<Promotion id="1">
<BookingDates>
<DateRange start="2020-09-01" end="2020-09-30"/>
</BookingDates>
<Discount percentage="10"/>
<RoomTypes>
<RoomType id="123"/>
<RoomType id="456"/>
</RoomTypes>
<RatePlans>
<RatePlan id="234"/>
<RatePlan id="567"/>
</RatePlans>
<Stacking type="base"/>
</Promotion>
</HotelPromotions>
</Promotions>
3 tipos diferentes de apilamiento
En el siguiente ejemplo, se muestra un caso en el que se aplicarían tres promociones diferentes (base
, second
, any
). Ten en cuenta que la promoción none
no se aplicaría, ya que las otras promociones ofrecen un mejor descuento. Si el precio original fuera de USD 100, el precio con descuento sería de USD 72.90.
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1">
<Promotion id="1">
<Discount percentage="10"/>
<Stacking type="base"/>
</Promotion>
<Promotion id="2">
<Discount percentage="10"/>
<Stacking type="second"/>
</Promotion>
<Promotion id="3">
<Discount percentage="10"/>
<Stacking type="any"/>
</Promotion>
<Promotion id="4">
<Discount percentage="25"/>
<Stacking type="none"/>
</Promotion>
</HotelPromotions>
</Promotions>
Tipo de apilamiento inexistente
En el siguiente ejemplo, se muestra un caso en el que se usa la promoción none
porque la combinación de otras promociones proporciona un descuento más pequeño. Si el precio original fuera de USD 100, el precio con descuento sería de USD 75.
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1">
<Promotion id="1">
<Discount percentage="10"/>
<Stacking type="base"/>
</Promotion>
<Promotion id="2">
<Discount percentage="10"/>
<Stacking type="any"/>
</Promotion>
<Promotion id="3">
<Discount percentage="25"/>
<Stacking type="none"/>
</Promotion>
</HotelPromotions>
</Promotions>
Límites de duración del período de reserva
En el siguiente ejemplo, se muestra un caso en el que se usa el elemento BookingWindow
con sus límites de inicio y finalización definidos como un tipo de duración ISO 8601. Esta restricción del período de reserva requiere reservar a las 18:00 p.m. del día anterior a la llegada y a las 12:00 p.m. del segundo día antes de la llegada (o después de esa fecha).
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1">
<Promotion id="1">
<BookingWindow min="P1DT6H" max="P2DT12H"/>
<Discount percentage="20"/>
</Promotion>
</HotelPromotions>
</Promotions>
Límites de fecha y hora de las fechas de reserva
En el siguiente ejemplo, se muestra un caso en el que se usa el elemento BookingDates
con los atributos start
y end
como de tipo DateTime. Esta restricción de fechas requiere que la reserva ocurra
entre las 06:30 del 1/7/2020 y las 18:45 del 2/07/2020.
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1">
<Promotion id="1">
<BookingDates>
<DateRange start="2020-07-01T06:30:00" end="2020-07-02T18:45:00"/>
</BookingDates>
<Discount percentage="20"/>
</Promotion>
</HotelPromotions>
</Promotions>
Períodos sin años
En el siguiente ejemplo, se muestra un caso en el que el elemento CheckInDates
contiene DateRanges
que tienen campos start
y end
sin años. En este ejemplo, la promoción se aplica a las fechas de entrada entre el 29/12 y el 2/1, sin importar el año. Los períodos sin años que cruzan el límite de año nuevo no son válidos, por lo que el período se expresa como dos períodos adyacentes.
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1">
<Promotion id="1">
<CheckInDates>
<DateRange start="12-29" end="12-31"/>
<DateRange start="01-01" end="01-02"/>
</CheckInDates>
<Discount percentage="20"/>
</Promotion>
</HotelPromotions>
</Promotions>
Descuento de FreeNights
En el siguiente ejemplo, se descuenta un 50% de dos noches por cada cuatro noches que se hospedó durante el período especificado de fechas de reserva. Para un itinerario de diez noches, un total de cuatro noches tendría un descuento del 50%.
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1">
<Promotion id="1">
<BookingDates>
<DateRange start="2022-01-01" end="2022-05-31"/>
</BookingDates>
<Discount>
<FreeNights stay_nights="4" discount_nights="2" discount_percentage="50" night_selection="cheapest" repeats="true"/>
</Discount>
</Promotion>
</HotelPromotions>
</Promotions>
En el siguiente ejemplo, se aplica un descuento del 50% para una noche por cada tres noches que se alojen en los períodos especificados de fechas de estadía. Solo se tienen en cuenta las noches de estadía superpuestas para cumplir con los requisitos del descuento. Para el siguiente itinerario con entrada el 1/1/2022 y salida el 7/1/2022, las noches calificadas de estadía y los descuentos se aplican de la siguiente manera.
- 1-1-2022 (estadía)
- 2-1-2022 (estadía)
- 2022-01-03
- 4-1-2022 (con descuento)
- 05-01-2022 (estadía)
- 6-1-2022 (estadía)
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1">
<Promotion id="1">
<StayDates application="overlap">
<DateRange start="2022-01-01" end="2022-01-02"/>
<DateRange start="2022-01-04" end="2022-01-06"/>
</StayDates>
<Discount>
<FreeNights stay_nights="3" discount_nights="1" discount_percentage="50" night_selection="last" repeats="true"/>
</Discount>
</Promotion>
</HotelPromotions>
</Promotions>
Selección clasificada
En el siguiente ejemplo, se ofrecen dos descuentos: uno del 20% y otro del 15%. Durante la evaluación, solo se aplica el descuento del 15% porque tiene una clasificación más baja.
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="Property_1">
<Promotion id="1">
<Discount percentage="15" rank="25"/>
</Promotion>
<Promotion id="2">
<Discount percentage="20" rank="50"/>
</Promotion>
</HotelPromotions>
</Promotions>
BestDailyDiscount
En el siguiente ejemplo, se descuenta una estadía de dos noches mediante la aplicación de BestDailyDiscount
apilados con un Discount
.
<?xml version="1.0" encoding="UTF-8"?>
<Promotions partner="account_xyz"
id="123_abc"
timestamp="2020-05-18T16:20:00-04:00">
<HotelPromotions hotel_id="HotelID" action="overlay">
<Promotion id="general">
<BestDailyDiscount fixed_amount="20"/>
</Promotion>
<Promotion id="may">
<BestDailyDiscount fixed_amount="50"/>
<StayDates application="overlap">
<DateRange start="2023-05-01" end="2023-05-31"/>
</StayDates>
</Promotion>
<Promotion id="fiesta">
<Discount fixed_amount_per_night="5"/>
<Stacking type="any"/>
</Promotion>
</HotelPromotions>
</Promotions>
Considera una estadía de dos noches desde el 30 de abril de 2023 hasta el 2 de mayo de 2023. Para el cálculo, se encuentra primero la combinación de los mejores descuentos diarios que generan el descuento más alto.
Durante la primera noche, la promoción “general” es el único importe apto con un descuento fijo de 20.
Para la segunda noche, la promoción del “mayo” ofrece un descuento mayor que el descuento “general”. Cuando seleccionas “puede”, el importe de descuento fijo es 50.
Luego, para la estadía, la promoción de la "fiesta" ofrece descuentos a 5 por noche o a 10 en total. Se puede acumular con la combinación de los mejores descuentos diarios, ya que “fiesta” tiene el tipo de apilamiento establecido en any
. Si se configuró en base
, solo se aplica la combinación de los mejores descuentos diarios o el descuento de “fiesta”. Consulta la descripción de Stacking
para obtener más información.
En general, el precio de la estadía incluye un descuento de importe fijo de 20 + 50 + 10 = 80.
Respuestas
Sintaxis
El mensaje PromotionsResponse
usa la siguiente sintaxis:
<?xml version="1.0" encoding="UTF-8"?>
<PromotionsResponse timestamp="timestamp"
id="message_ID"
partner="partner_key">
<!-- Either Success or Issues are populated. -->
<Success/>
<Issues>
<Issue code="issue_code"
status="issue_type">
issue_description
</Issue>
</Issues>
</PromotionsResponse>
Elementos y atributos
El mensaje PromotionsResponse
tiene los siguientes elementos y atributos:
Elemento / @Attribute | Occurrences | Tipo | Descripción |
---|---|---|---|
PromotionsResponse | 1 | Complex element | El elemento raíz que indica el éxito o los problemas de un mensaje de solicitud de promociones recibido. |
PromotionsResponse / @timestamp | 1 | DateTime | La fecha y hora de creación de este mensaje. |
PromotionsResponse / @id | 1 | string | Es el identificador único del mensaje de promociones asociado. |
PromotionsResponse / @partner | 1 | string | La cuenta de socio de este mensaje. |
PromotionsResponse / Success | 0..1 | Success | Indica que el mensaje de promociones se procesó correctamente sin advertencias, errores ni fallas.
|
PromotionsResponse / Issues | 0..1 | Issues | Un contenedor para uno o más problemas que se encontraron durante el procesamiento del mensaje de promociones.
|
PromotionsResponse / Issues / Issue | 1..n | Issue | Es la descripción de una advertencia, un error o una falla que se encontró mientras se procesaba el mensaje de promociones. Puedes encontrar detalles sobre estos problemas en la sección Mensajes de error de estado del feed. |
PromotionsResponse / Issues / Issue / @code | 1 | integer | Es el identificador del problema. |
PromotionsResponse / Issues / Issue / @status | 1 | enum | El tipo de problema encontrado. Los valores válidos son |
Ejemplos
Se completó correctamente
La siguiente es una respuesta a un mensaje de Promociones procesado correctamente.
<?xml version="1.0" encoding="UTF-8"?>
<PromotionsResponse timestamp="2020-05-18T16:20:00-04:00"
id="12345678"
partner="partner_key">
<Success/>
</PromotionsResponse>
Con problemas
La siguiente es una respuesta a un mensaje de promociones que no se procesó debido a errores.
<?xml version="1.0" encoding="UTF-8"?>
<PromotionsResponse timestamp="2020-05-18T16:20:00-04:00"
id="12345678"
partner="partner_key">
<Issues>
<Issue code="1001" status="error">Example</Issue>
</Issues>
</PromotionsResponse>