Implementing the Value Adds Catalog API
Use the Value Adds Catalog API to retrieve value adds and their details. We recommend using v2.0, the latest version. v1.0 is currently available for backward compatibility.
Retrieving value adds
GET https://supply-xml.booking.com/valueadds/properties/catalogThe GET /valueadds/properties/catalog request retrieves a list of value adds and their details.
Header parameter
The following table describes the elements you can add in the header:
| Header | Description | Type | Required/ Optional | Notes |
|---|---|---|---|---|
Content-Type: application/json | Specifies the expected content type. | string | required | |
Accept-Version | Specify the version number to get the API functionality specific to that version. | string | optional | Currently supports the values: - 2.0 (latest) - 1.0 |
Difference between version 1.0 and 2.0
Value adds Catalog API v2.0 introduces an improved structure to represent the supported value adds. Some of the value adds that were two different value adds in version 1.0 is now a single value add with an attribute to differentiate between the two in version 2.0. For example, the value add Self: 1 car Per room - per stay (ID:1001) and Valet: 1 car Per room - per stay (ID"1002)is now: Parking service Per stay Per room with an attribute parkingType with values "Self" and "Valet".
The following table provides the difference in detail between the v1.0 and v2.0 value adds.
| Service ID in v1.0 | Service ID in v2.0 | Category v1.0/v2.0 | Type v2.0 | Name in v1.0 | Notes |
|---|---|---|---|---|---|
| 1001 | 1 | Transportation/Parking | Parking service | Self: 1 car Per room - per stay | In version 2.0, you must specify the attribute parkingType = "Self" |
| 1002 | 1 | Transportation/Parking | Parking service | Valet: 1 car Per room - per stay | In version 2.0, you must specify the attribute parkingType = "Valet" |
| 6001 | 19 | Transportation/Airport Shuttle | Airport transfer | Roundtrip | In version 2.0, you must specify the attribute transferType = "Round trip" |
| 6002 | 19 | Transportation/Airport Shuttle | Airport transfer | One way | In version 2.0, you must specify the attribute transferType = "One way" |
| 2001 | 3 | Food and Beverage (F&B)/Food & drink | Food & drink service | Daily Credit Per adult - No Daily Accrual | In version 2.0, you must specify the attribute accruedDaily = "false" |
| 2002 | 3 | Food and Beverage (F&B)/Food & drink | Food & drink service | Daily Credit Per adult - Daily Accrual | In version 2.0, you must specify the attribute accruedDaily" = "true" |
| 2003 | 2 | Food and Beverage (F&B)/Food & drink | Food & drink service | Daily Credit Per room - No Daily Accrual | In version 2.0, you must specify the attribute accruedDaily = "false" |
| 2004 | 2 | Food and Beverage (F&B)/Food & drink | Food & drink service | Daily Credit Per room - Daily Accrual | In version 2.0, you must specify the attribute accruedDaily = "true" |
| 2009 | 10 | Food and Beverage (F&B)/Food & Beverage | Food & drink service | Services Discount | Version 2.0 uses decimal value (0-1) to represent a percentage |
| 2013 | 5 | Food and Beverage (F&B)/Food & drink | Food & drink service | Per stay credit - per adult | Version 2.0 has simplified attributes |
| 2014 | 6 | Food and Beverage (F&B)/Food & drink | Food & drink service | Per stay credit - per room | Version 2.0 has simplified attributes |
| 9001 | 23 | Food and Beverage (F&B)/Beverages | Bottle of wine | Bottle of wine | |
| 9002 | 24 | Food and Beverage (F&B)/Beverages | Bottle of champagne | Bottle of champagne | |
| 2005 | 7 | Property Services (PS) | Property services | Daily Credit Per adult - No Daily Accrual | In version 2.0, you must specify the attribute accruedDaily = "false" |
| 2006 | 7 | Property Services (PS) | Property services | Daily Credit Per adult - Daily Accrual | In version 2.0, you must specify the attribute accruedDaily = "true" |
| 2007 | 4 | Property Services (PS) | Property services | Daily Credit Per room - No Daily Accrual | In version 2.0, you must specify the attribute accruedDaily = "false" |
| 2008 | 4 | Property Services (PS) | Property services | Daily Credit Per room - Daily Accrual | In version 2.0, you must specify the attribute accruedDaily = "true" |
| 2010 | 11 | Property Services (PS) | Discount | Discount | Version 2.0 uses decimal value (0-1) to represent a percentage |
| 2011 | 8 | Property Services (PS) | Property services | Per stay credit - per adult | Version 2.0 has simplified attributes |
| 2012 | 9 | Property Services (PS) | Property services | Per stay credit - per room | Version 2.0 has simplified attributes |
| 5001 | 18 | Internet Services (PS)/Internet | HighSpeed Internet | Per stay - per room | New name: "High-speed internet Per stay Per room" |
| 3001 | 12 | Frontdesk services/Check-in/Check-out | Early Check-in | Early Check-in | Attribute renamed from Hour to minHour |
| 3002 | 13 | Frontdesk services/Check-in/Check-out | Late Check-out | Late Check-out | Attribute renamed from Hour to maxHour |
| 3003 | 14 | Frontdesk services/Check-in/Check-out | Late Check-in | Late Check-in | Attribute renamed from Hour to maxHour |
| 4001 | 15 | Wellness/Spa | Spa access | Unlimited access Per day - per adult | New name: "Spa access Unlimited access Per day Per adult" |
| 4002 | 16 | Wellness/Spa | Spa access | Hourly access Per day - per adult | Attribute renamed from Hour to numHours |
| 4003 | 17 | Wellness/Spa | Massage | N minutes Per stay - per adult | Attribute renamed from Minute to numMinutes |
| 7001 | 20 | Activities/Safari activities | Safari game drive | Per day - per room | New name: "Safari game drive Per day Per person" |
| 7002 | 21 | Activities/Safari activities | Safari walk | Per day - per room | New name: "Safari walk Per day Per person" |
| 8001 | 22 | Pets | Pets stay | Per day - per room | Attribute renamed from NumPets to numPets |
| N/A | 28 | Parking | Parking and fly service | Park and fly - N days - Per stay Per room | New in version 2. Attribute numDays is required. |
Response body example
Click to view the full list of Booking.com supported value adds and their details.
List of supported value adds is mostly static
The following response lists all the v2.0 Booking.com supported value adds and their details. Updates to this list are quite infrequent but they sometimes do happen. Use the v2.0 endpoint response to get up-to-date information and pick up any newly introduced value adds at Booking.com.
{
"meta": {
"ruid": "1b7deab2-7005-44e4-b2bd-03f16f7ad01a"
},
"data": [
{
"id": 1,
"category": "Parking",
"type": "Parking service",
"name": "Parking service Per stay Per room",
"attributes": [
{
"name": "parkingType",
"data_type": "String",
"description": "Parking type, Select one of the options, Self or Valet",
"required": true
}
]
},
{
"id": 2,
"category": "Food & drink",
"type": "Food & drink service",
"name": "Food & drink credit Per day Per room",
"attributes": [
{
"name": "creditAmount",
"data_type": "Integer",
"description": "Credit amount, should be >=1",
"required": true
},
{
"name": "accruedDaily",
"data_type": "Boolean",
"description": "Accrued daily, should be true or false",
"required": true
},
{
"name": "currencyCode",
"data_type": "String",
"description": "Currency code, must follow ISO 4217",
"required": false
}
]
},
{
"id": 3,
"category": "Food & drink",
"type": "Food & drink service",
"name": "Food & drink credit Per day Per adult",
"attributes": [
{
"name": "creditAmount",
"data_type": "Integer",
"description": "Credit amount, should be >=1",
"required": true
},
{
"name": "accruedDaily",
"data_type": "Boolean",
"description": "Accrued daily, should be true or false",
"required": true
},
{
"name": "currencyCode",
"data_type": "String",
"description": "Currency code, must follow ISO 4217",
"required": false
}
]
},
{
"id": 4,
"category": "Property services",
"type": "Property services",
"name": "Property services credit Per day Per room",
"attributes": [
{
"name": "creditAmount",
"data_type": "Integer",
"description": "Credit amount, should be >=1",
"required": true
},
{
"name": "accruedDaily",
"data_type": "Boolean",
"description": "Accrued daily, should be true or false",
"required": true
},
{
"name": "currencyCode",
"data_type": "String",
"description": "Currency code, must follow ISO 4217",
"required": false
}
]
},
{
"id": 5,
"category": "Food & drink",
"type": "Food & drink service",
"name": "Food & drink credit Per stay Per adult",
"attributes": [
{
"name": "creditAmount",
"data_type": "Integer",
"description": "Credit amount, should be >=1",
"required": true
},
{
"name": "currencyCode",
"data_type": "String",
"description": "Currency code, must follow ISO 4217",
"required": false
}
]
},
{
"id": 6,
"category": "Food & drink",
"type": "Food & drink service",
"name": "Food & drink credit Per stay Per room",
"attributes": [
{
"name": "creditAmount",
"data_type": "Integer",
"description": "Credit amount, should be >=1",
"required": true
},
{
"name": "currencyCode",
"data_type": "String",
"description": "Currency code, must follow ISO 4217",
"required": false
}
]
},
{
"id": 7,
"category": "Property services",
"type": "Property services",
"name": "Property services credit Per day Per adult",
"attributes": [
{
"name": "creditAmount",
"data_type": "Integer",
"description": "Credit amount, should be >=1",
"required": true
},
{
"name": "accruedDaily",
"data_type": "Boolean",
"description": "Accrued daily, should be true or false",
"required": true
},
{
"name": "currencyCode",
"data_type": "String",
"description": "Currency code, must follow ISO 4217",
"required": false
}
]
},
{
"id": 8,
"category": "Property services",
"type": "Property services",
"name": "Property services credit Per stay Per adult",
"attributes": [
{
"name": "creditAmount",
"data_type": "Integer",
"description": "Credit amount, should be >=1",
"required": true
},
{
"name": "currencyCode",
"data_type": "String",
"description": "Currency code, must follow ISO 4217",
"required": false
}
]
},
{
"id": 9,
"category": "Property services",
"type": "Property services",
"name": "Property services credit Per stay Per room",
"attributes": [
{
"name": "creditAmount",
"data_type": "Integer",
"description": "Credit amount, should be >=1",
"required": true
},
{
"name": "currencyCode",
"data_type": "String",
"description": "Currency code, must follow ISO 4217",
"required": false
}
]
},
{
"id": 10,
"category": "Food & Beverage",
"type": "Food & drink service",
"name": "Food & Beverage Services Discount",
"attributes": [
{
"name": "amount",
"data_type": "Float",
"description": "Amount, between 0 and 1",
"required": true
}
]
},
{
"id": 11,
"category": "Property services",
"type": "Property services",
"name": "Property Services Discount",
"attributes": [
{
"name": "amount",
"data_type": "Float",
"description": "Amount, between 0 and 1",
"required": true
}
]
},
{
"id": 12,
"category": "Check-in/Check-out",
"type": "Early check-in",
"name": "Early check-in",
"attributes": [
{
"name": "minHour",
"data_type": "Integer",
"description": "Minimum hours, integer between 0 and 23",
"required": false
}
]
},
{
"id": 13,
"category": "Check-in/Check-out",
"type": "Late check-out",
"name": "Late check-out",
"attributes": [
{
"name": "maxHour",
"data_type": "Integer",
"description": "Maximum hours, integer between 0 and 23",
"required": false
}
]
},
{
"id": 14,
"category": "Check-in/Check-out",
"type": "Late check-in",
"name": "Late check-in",
"attributes": [
{
"name": "maxHour",
"data_type": "Integer",
"description": "Maximum hours, integer between 0 and 23",
"required": false
}
]
},
{
"id": 15,
"category": "Spa",
"type": "Spa access",
"name": "Spa access Unlimited access Per day Per adult",
"attributes": []
},
{
"id": 16,
"category": "Spa",
"type": "Spa access",
"name": "Spa hourly access Per day Per adult",
"attributes": [
{
"name": "numHours",
"data_type": "Integer",
"description": "Number of hours, >= 1 && <= 24",
"required": true
}
]
},
{
"id": 17,
"category": "Spa",
"type": "Massage",
"name": "Massage N minutes Per stay Per adult",
"attributes": [
{
"name": "numMinutes",
"data_type": "Integer",
"description": "Number of minutes, >= 1",
"required": true
}
]
},
{
"id": 18,
"category": "Internet",
"type": "High-speed internet",
"name": "High-speed internet Per stay Per room",
"attributes": []
},
{
"id": 19,
"category": "Airport Shuttle",
"type": "Airport transfer",
"name": "Airport transfer Per stay Per person",
"attributes": [
{
"name": "transferType",
"data_type": "String",
"description": "Transfer type, either one of the options Round trip or One way",
"required": true
}
]
},
{
"id": 20,
"category": "Safari activities",
"type": "Safari game drive",
"name": "Safari game drive Per day Per person",
"attributes": []
},
{
"id": 21,
"category": "Safari activities",
"type": "Safari walk",
"name": "Safari walk Per day Per person",
"attributes": []
},
{
"id": 22,
"category": "Pets",
"type": "Pets stay",
"name": "Pets Per day Per room",
"attributes": [
{
"name": "numPets",
"data_type": "Integer",
"description": "Number of pets, >=1 and <=5",
"required": true
}
]
},
{
"id": 23,
"category": "Beverages",
"type": "Bottle of wine",
"name": "Bottle of wine Per stay Per room",
"attributes": []
},
{
"id": 24,
"category": "Beverages",
"type": "Bottle of champagne",
"name": "Bottle of champagne Per stay Per room",
"attributes": []
},
{
"id": 28,
"category": "Parking",
"type": "Parking and fly service",
"name": "Park and fly - N days - Per stay Per room",
"attributes": [
{
"name": "numDays",
"data_type": "Integer",
"description": "Number of days, >= 1 and <= 50",
"required": true
}
]
}
]
}Response body parameters
The following table describes the response elements:
| Element | Description | Type | Notes |
|---|---|---|---|
> id | Specifies the Booking.com ID for the value add. | integer | |
> category | Specifies the category that the value adds are grouped under. | string | For example, Spa is a value adds category. |
> type | Specifies the sub-category of the value adds item. | string | For example, Massage is a type of Spa category. Note that you cannot choose more than one value adds from within the same value adds type. For example, when adding a value adds service from the Food & drink service type, you can add one of the following: Food & drink credit Per day Per room (ID 2), Food & drink credit Per day Per adult (ID 3), Food & drink credit Per stay Per room (ID 6), Food & Beverage Services Discount (10). But not more than one. |
> name | Specifies the value adds name. | string | For example, Spa hourly access Per day Per adult is a value add. |
> attributes | Contains additional details for certain value adds. | object | Depending on the value adds any additional attribute, the data type, description and whether the attribute is required can change. For example, when selecting the Airport transfer Per stay Per person value adds, you must specify the attribute transferType with one of the following options: Round trip or One way. Note that the creditAmount or amount attributes are used only for display purposes and to show the perceived worth of the specific value-added service or product. For more information, see the things to remember section. |
>> name | Specifies the name of the attribute. | array | For example, numHours is the name of the value adds attribute. |
> data_type | Specifies the data type of the additional detail. | integer, decimal, string or boolean | For example, when adding the Spa access as a value adds service, you must specify the numHours attribute which takes an integer denoting the number of hours a person is allowed in the spa per day. |
> description | Specifies the description of the attribute. | string | Provides details of possible values and any restrictions applicable on the attribute. |
> required | Specifies whether the attribute is required. | boolean | Possible values are: - true - false |