GetAllProducts

GetAllProducts

The GetAllProducts API retrieves room-level product details for a specific hotel property. It provides detailed rate plans, pricing, amenities, cancellation policies, and room selection keys required for booking.

This API is used after selecting a property from the GetBestProperty API to view all available rooms and pricing options.

---

Endpoint

POST [SD-Domain]/api/SmartDistribution/getproducts

---

Headers

Header Name	Value / Example	Required	Description
Content-Type	application/json	Yes	Indicates the request body is JSON
apiKey	RGKEY	Yes	API key provided by SmartDistribution
apiSecret	SECRETL	Yes	API secret for authentication

---

Request Payload

{

"propertyID": "ChIJW2JYUwMsTI8RKPvP_FiR2LE",

"numberOfRoom": 1,

"checkin": "2025-08-07",

"checkout": "2025-08-08",

"adults": 1,

"children": []

}

---

Request Fields Description

Field	Type	Required	Description
propertyID	string	Yes	Unique hotel ID (usually from GetBestProperty)
numberOfRoom	integer	Yes	Number of rooms requested
checkin	string	Yes	Check-in date in YYYY-MM-DD format
checkout	string	Yes	Check-out date in YYYY-MM-DD format
adults	integer	Yes	Total number of adult guests
children	array	Yes	Array of child ages (empty array if none)

---

Success Response Sample

{

"body": {

"products": {

"code": "HBR",

"commissionableStatus": "NonCommissionable",

"inDate": "2025-08-07",

"outDate": "2025-08-08",

"RateCode": "HBR",

"roomTypes": [

{

"bookableRate": "41.32",

"code": "SGL.ST",

"nativeCurrency": "EUR",

"numberOfRooms": "1",

"roomDescription": "SINGLE STANDARD",

"roomSelectionKey": "20250807|20250808|W|69|59159|SGL.ST|CGW-TODOS...",

"totalRate": "41.32",

"totalRateInclusive": "41.32",

"totalTaxes": null,

"numberOfPayingGuestsPerRoom": "1",

"numberOfChildren": "0",

"cancelPolicy": {

"intervalOffsetType": "BeforeArrival",

"penaltyAmount": "41.32"

},

"amenities": {

"code": "EP",

"description": "Room only"

},

"rateChanges": []

}

]

},

"propertyId": "ChIJW2JYUwMsTI8RKPvP_FiR2LE",

"propertyName": "Antillano",

"description": "This hotel is located on Cancun's main street",

"images": ["https://abc.png", "https://xyz.png"],

"currency": null,

"hotelCode": "59159",

"targetDate": "0001-01-01T00:00:00",

"roomCode": null,

"price": 0,

"numberOfRoom": 0,

"code": null,

"countryCode": null,

"countryName": null,

"stateCode": null,

"stateName": null,

"destinationnCode": null,

"destinationName": null,

"zoneCode": null,

"zoneName": null,

"longitude": null,

"latitude": null,

"categoryCode": null,

"categoryName": null,

"categoryGroupCode": null,

"categoryGroupDesc": null,

"chainCode": null,

"chainName": null,

"accomodationType": null,

"accMultiDesc": null,

"accTypeDesc": null,

"address": null,

"street": null,

"city": null,

"postalCode": null,

"s2C": null,

"ranking": null,

"hotelSegments": null,

"hotelBoard": null

},

"status": true,

"description": null,

"statusCode": 200

}

---

Top-Level Response Fields

Field	Type	Description
body	object	Contains product and hotel details
status	boolean	API call success status
description	string	Error/response details if applicable (usually null)
statusCode	integer	HTTP status code (200 on success)

---

Product Object Fields (products)

Field	Type	Description
code	string	Rate plan code (e.g., HBR)
commissionableStatus	string	Commission status (e.g., NonCommissionable)
inDate	string	Check-in date
outDate	string	Check-out date
RateCode	string	Internal rate plan identifier
roomTypes	array	List of available room types

---

Room Type Fields (roomTypes[])

Field	Type	Description
bookableRate	string	Base price per room
code	string	Room code (e.g., SGL.ST)
nativeCurrency	string	Currency of the rate (e.g., EUR)
numberOfRooms	string	Number of rooms
roomDescription	string	Description of room
roomSelectionKey	string	Unique selection key for booking
totalRate	string	Total rate (before taxes)
totalRateInclusive	string	Total rate including taxes
totalTaxes	string	Tax amount (nullable)
numberOfPayingGuestsPerRoom	string	Count of paying guests per room
numberOfChildren	string	Number of children in the room
cancelPolicy	object	Cancellation policy details
amenities	object	Board basis and plan (e.g., Room only)
rateChanges	array	Daily rate breakdown (if dynamic pricing)

---

Cancel Policy Fields

Field	Type	Description
intervalOffsetType	string	Condition (e.g., BeforeArrival)
penaltyAmount	string	Penalty amount applicable on cancellation

---

Amenities Fields

Field	Type	Description
code	string	Meal/plan code (e.g., EP)
description	string	Plan name (e.g., Room only)

---

Additional Hotel Fields

Field	Type	Description
propertyName	string	Hotel/property name
description	string	Description of the hotel
images	array	Image URLs
hotelCode	string	Supplier hotel code
targetDate	string	Reference date (placeholder if unused)

---

Notes

• Fields like categoryCode, address, ranking, zoneName, etc. may return null if unavailable.

• Use roomSelectionKey when proceeding to CreateReservation.

• roomTypes[] may contain multiple room configurations with different prices or board types.