Product Meta

This endpoint retrieves detailed metadata for various value-added services and meal plan types available for a product.


Endpoint

GET


Sample Response

Sample Success Response - 1

Success Response Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.


Messagestring

Message detailing the status or result of the request.


Ruid string

A unique identifier associated with the request.


Data object

Contains detailed information related to value adds and meal plan types.

value_adds array

An array containing the value add items for the hotel (for example, services, credits).

id integer

Unique identifier for the value add item.

categorystring

Category of the value add (for example, "Transportation", "Food and Beverage").

typestring

The type of the value add (for example, "Parking", "Credit or discount").

name string

Name of the value add (for example, "Self: 1 car Per room - per stay").


attributes array

An array of attribute objects, which can provide additional details like amount or currency.

namestring

Name of the attribute (for example, "CurrencyCode", "Amount").

dataTypestring

Data type of the attribute (for example, "string", "double", "int").

descriptionstring

Detailed description of what the attribute represents (for example, currency code, amount).

required boolean

Whether the attribute is required (true/false).


meal_plan_types array

Array containing different meal plan types and their mappings. The meal plan types in the provided code include various options for accommodation packages, each offering a combination of meals and services.

meal_plan_type object

Represents a meal plan type with description and mapping.

Here's the table summarizing the meal plan types, their mappings, and descriptions:

Meal Plan Code
Meal Plan Description
Mapping
Description

0

None

0

No meals are included in the plan.

1

All inclusive

1

This plan includes all meals, drinks, and sometimes additional services or amenities.

19

Breakfast

19

Only breakfast is included in the plan.

21

Lunch

21

Only lunch is included in the plan.

22

Dinner

22

Only dinner is included in the plan.

2

American

19, 21, 22

Includes all three main meals: breakfast, lunch, and dinner.

3

Bed & breakfast

19

This plan includes breakfast along with the accommodation, but no other meals.

4

Buffet breakfast

19

A buffet-style breakfast is included, typically with a variety of food choices.

5

Caribbean breakfast

19

A breakfast option featuring dishes typically found in the Caribbean.

6

Continental breakfast

19

A light breakfast, usually including bread, pastries, and beverages such as coffee and juice.

7

English breakfast

19

A hearty breakfast commonly consisting of eggs, sausages, bacon, beans, and other cooked items.

8

European plan

0

No meals are included in the accommodation rate, similar to the "None" plan.

9

Family plan

0

A plan where no meals are included, often designed for families, but specific details are not provided.

10

Full board

19, 21, 22

Includes breakfast, lunch, and dinner, similar to the "American" plan.

11

Full breakfast

19

A full breakfast is provided, typically offering a wider variety than a continental breakfast.

12

Half board/Modified American plan

19, 22

Includes breakfast and dinner, but lunch is not provided.

14

Room only

0

No meals are included, just accommodation.

15

Self catering

0

No meals are included, and guests are expected to prepare their own food.

16

Bermuda

19

This refers to a type of breakfast, typically in the style of those found in Bermuda.

17

Dinner bed and breakfast plan

19, 22

Includes both breakfast and dinner, but no lunch.

18

Family American

0

Similar to the "Family plan," it does not include meals.

20

Modified

19, 22

This plan includes breakfast and dinner, but lunch is not included, akin to the "Half board" plan.

23

Breakfast & lunch

19, 21

This plan includes breakfast and lunch but does not include dinner.

24

Lunch & Dinner

21, 22

Includes lunch and dinner but no breakfast.

This table lists each meal plan, its associated mapping(s), and provides a description of what each plan includes.

In the meal_plan_type object, the keys such as "0", "1", "19", etc., represent the specificmeal_plan_code. See the description of the parameters in the each meal_plan_type object below.

descriptionstring

Description of the meal plan type (for example, "None", "All inclusive").

mappingstring

Mapping of the meal plan type to a specific code or identifier.

Last updated

Was this helpful?