Su API Documentation
  • Su Overview
    • Su API Introduction
  • Su Channel Manager
    • Getting Started
      • Certification
      • Authentication
    • Content
      • Property
      • Room Type
      • Rate Plan
      • Listing
        • Property Listing
        • Room Type Listing
        • Rate Plan Listing
        • Delete Property Listing
      • Image API
        • Create Images
        • Retrieve Images
        • Associate Images
    • Booking.com Content API
      • Booking.com
        • Contract - Introduction
          • Create Contract
          • Link/Retrieve Contract
          • Update Contract
          • Resend Contract
        • Property Management
          • Property Statuses
          • Property Detail
            • Create Property
            • Retrieve Property
            • Update Property
          • Contact Details
            • Set Contact
            • Retrieve Contact
            • Contact Profile Types
          • Property Settings
            • Retrieve Property Settings
            • Retrieve Property Settings Damage Programme
            • Retrieve City Tax Category For Property Settings
            • Create / Update Property Settings
            • Create / Update Property Settings - Specific Setting
          • Property Profile
            • Set Profile
            • Retrieve Property Profile
            • Set Hotelier Message
            • Retrieve Hotelier Message
            • Remove Hotelier-Message
          • Booking.com Property Status
            • Property Status Check
            • Property Status Open
            • Property Status Closed
          • Property Key Collection
            • Set CheckIn Methods
            • Retrieve CheckIn Method
            • Retrieve All Stream Variation
        • Images
          • Create Image
          • Retrieve All Images
          • Update Image Tags
          • Delete Image
          • Retrieve Associate Images
          • Associate Image
          • Unassociate Image
          • Ordering Image
          • Smart Ordering Image
          • Show Image
          • Retrieve Property Pending Photos based on photo-batch-id
          • Retrieve Image Tags
        • Facilities
          • Create/Update Facility
          • Retrieve Set Facility of Property and Room
          • Retrieve Supported Facilities
        • Property/Room Charges
          • Retrieve Property Charge Meta
          • Retrieve Property Charges
          • Retrieve Room Charges
          • Create Property Charges
        • Rate Plan
          • Set Rateplan
          • Retrieve Rateplan
      • Room API
        • Room Meta API
        • Room Set (Create/Update) API
        • Room Retrieve API
        • Room Deactivate API
      • Policies API
        • Create/Update Policies
        • Retrieve Policies
      • Bathroom API
        • Set Bathroom (Create and Update)
        • Remove/Disable Bathroom
        • Retrieve Bathroom
      • Product API
        • Product Meta
        • Product List
        • Product Create
        • Product Modify
        • Product Remove
        • Product Map Create (Room Based)
        • Product Map Modify (Room Based)
        • Product Map Create (Occupancy Based)
        • Product Map Modify (Occupancy Based)
        • Product Unmap
      • Property and Room License
        • Property License Retrieve All Rule (Without property id)
        • Property License Retrieve Rule (With property id)
        • Sending License Information of Property
        • Retrieve License Information of Property
        • Sending License Information of Room
        • Retrieve License Information of Room
      • BCIO (Booking.com Check-In / Check-Out Times)
      • PCT (Property Class Type Codes)
      • BCJT (Booking.com Job Titles)
      • PTT (Phone Technology Type Codes)
      • BCL (Booking.com Language Codes)
      • Currency Codes/Names
      • Country Codes/Names
      • BCPT (Booking.com Payment Type Codes)
    • Rates and Availability
    • Inventory Control
    • Reservations
      • New/Modified/Requested/Cancelled Retrievals
        • Request for Reservation Information
        • Response of Reservation Information
      • Reservation Using Push API
        • Reservations Notification Push
        • PUSH API Method
      • Reservation Notification
      • Request Booking
        • Accept/Confirm Request Booking
        • Deny/Cancel Request Booking
      • Booking Repull
        • List of Bookings
        • Refetch Booking
    • Logs
      • Update Logs
      • Failed Channel Logs
      • Rates & Inventory Logs (Future Date)
      • Bulk Rates & Inventory Logs (Future Date)
      • Resync OTA Updates (Failed)
      • OTA Rateplan Pull API
    • Users
      • Global Users
      • Chain Users
    • Channel Mapping Widget API
      • Generate a Token
      • Mapping Script
    • Reviews
    • Messaging
    • Reporting
      • Reporting - No Show (Booking.com & Goibibo)
      • Reporting - Invalid CC (Booking.com)
      • Reporting - Cancellation Due to Invalid CC (Booking.com)
      • Bulk ARI Update
      • Marketing Insight API - Booking.com
    • AirBnB
      • Cancel Reservation
        • Retrieve AirBnB Cancel Reservation Details API
        • Final AirBnB Cancel Reservation API
      • Notification
      • Trip Issue
    • My Booking Site
      • Confirm Reservation
      • Cancel Reservation
  • Su Token
    • Su Token - Introduction
    • Su Token - Authentication
    • Partner
    • Card
      • Card API
      • Card View API
      • Charge API
      • Card Collection
        • Get CC Collection (Generate Link)
        • Check Status of CC Collection
      • WIDGET
        • CC Collection Using Widget
  • Codes
    • Room Type Codes
    • Language Codes
    • Country Codes
    • Phone Technology Type Codes
    • Meal Plan Codes
    • Currency Codes
    • Channel or OTA Codes
    • Credit Card Type Codes
    • Time Zones
    • Error Codes
  • Versioning
  • Glossary of Terms
Powered by GitBook

STAAH Limited. 2024 © All Rights Reserved.

On this page
  • Endpoint
  • Sample Request
  • Response

Was this helpful?

Export as PDF
  1. Su Channel Manager
  2. Booking.com Content API
  3. Product API

Product Map Create (Room Based)

PreviousProduct RemoveNextProduct Map Modify (Room Based)

Last updated 3 months ago

Was this helpful?

This endpoint creates a new room rate plan mapping for a specific hotel and room type, with pricing and availability details.


Endpoint

POST

https://connect-sandbox.su-api.com/SUAPI/jservice/bdc/product/map

Header

-app-id: YOUR_APP_ID
Authorization: YOUR_API_KEY
Content-Type:application/json
Header
Type
Required
Description

app-id

string

Yes

Your application ID. Required for authentication.

Authorization

string

Yes

Your API key. for authorization. Required for authentication.

Content-Type

string

Yes

Must be set to application/json.


Attributes

action string (Required)

The type of operation to be performed.

In this case, it is "create", indicating that the system is creating a new room rate plan for a hotel.


hotel_id string (Required)

The unique identifier for the hotel. It links the request to a specific hotel in the system, allowing the room rate to be associated with the correct hotel.


room_id string (Required)

The identifier for the specific room type being referenced in the request. This ties the rate plan to a specific room at the hotel.


rate_id string (Required)

The identifier for the rate plan associated with the room. This determines the pricing structure, discounts, or other conditions for booking the room.


channel_hotel_id string (Required)

The identifier for the hotel in the distribution channel’s system. It links the hotel product to the respective channel, enabling it to be managed and booked through that platform.


channel_room_id string (Required)

The identifier for the specific room type in the channel’s system. This associates the rate plan and availability with the correct room type within the channel.


channel_rate_id string (Required)

The identifier for the rate plan in the channel’s system. It defines the pricing and conditions for booking the room in the distribution channel.


channel_id integer (Required)

The identifier for the distribution channel. It links the room and rate plan to a specific external booking platform (for example, OTA, GDS).


pricing array (Required)

An array of pricing rules that apply to the room based on the number of guests.

In this case, it includes:

applicable_no_of_guest integer (Required)

The number of guests the pricing rule applies to.

For example, it might apply to a single guest or multiple guests.

multiplier string (Required)

The multiplier applied to the base rate for the specified number of guests.

In this case, it’s set to "1", meaning no change to the base price.

surcharge string (Required)

The surcharge applied for the specified number of guests. For example, a surcharge might be added for each additional guest beyond a certain number. In this case, it’s set to "0", meaning there’s no surcharge.

disable_availability boolean (Required)

Indicates whether the room’s availability is disabled.

When set to false, the room remains available for booking.

disable_rate boolean (Required)

Indicates whether the rate for the room is disabled.

When set to false, the rate is active and available for booking.

fixed_minstay object (Required)

Defines the fixed minimum stay requirement for the room:

fixed boolean (Required)

Indicates whether the minimum stay requirement is fixed.

In this case, it’s set to true, meaning the minimum stay is fixed.

minstay integer (Required)

The minimum number of nights required for booking the room.

In this case, it’s set to 1, meaning guests must stay at least one night.


Sample Request

{
    "action": "create",
    "hotel_id": "AWSTEST",
    "room_id": "1000202",
    "rate_id": "BAR",
    "channel_hotel_id": "12962495",
    "channel_room_id": "1296249501",
    "channel_rate_id": "49681540",
    "channel_id": 19,
    "pricing": [
        {
            "applicable_no_of_guest": 5,
            "multiplier": "1",
            "surcharge": "0"
        }
    ],
    "disable_availability": false,
    "disable_rate": false,
    "fixed_minstay": {
        "fixed": true,
        "minstay": 1
    }
}

Response

Sample Success Response

{
    "Status": "Success",
    "Data": [],
    "Message": "Rateplan Mapping added successfully",
    "Ruid": ""
}

Success Response Body Elements

Status string

Indicates the result of the API call.

Will be "Success" for successful operations.


Data object

An object containing data related to the successful image creation. This typically includes identifiers for the created images.


Message string

A message receives within the response body. This will generally be an empty string if no additional information is needed.


Ruid string

Specifies the unique request ID.

You can share this ID with Booking.com customer support when you run into an issue. This can help in understanding what went wrong.

Errors

Sample Error Response 1 - Validation Error Response

{
    "Status": "Fail",
    "Errors": [
        {
            "Code": "496",
            "ShortText": "action attribute is required"
        },
        {
            "Code": "400",
            "ShortText": "hotel_id: Invalid HotelCode ('')"
        },
        {
            "Code": "852",
            "ShortText": "Product: room_id - is invalid or not found!"
        },
        {
            "Code": "856",
            "ShortText": "Product: rate_id - is invalid or not found!"
        }
    ],
    "Message": "",
    "Ruid": ""
}

Error Response Body Elements

Status string

Indicates the result of the API call, which will be always "Fail" in case of an error response.


Error array

Array that contains details about any errors that occurred during the API call. Each object in the Errors array contains the following properties:

Code string

Specific error code that helps identify the type of error.

For example: "400" indicates a bad request.

ShortText string

A short description of the error.


Message string

A message providing more information about the error.


Ruid string

A unique identifier for tracking the request.