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 (Occupancy Based)

PreviousProduct Map Modify (Room Based)NextProduct Map Modify (Occupancy Based)

Last updated 3 months ago

Was this helpful?

This endpoint creates a new rate plan mapping for a hotel with pricing based on multiple guest occupancy levels.


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, the action is "create", which indicates that a new room rate plan is being created for the specified hotel and room.


hotel_id string (Required)

The unique identifier for the hotel. This field associates the request with a specific hotel in the system, linking the room rate to the right hotel.


room_id string (Required)

The identifier for the specific room type. This links the rate plan to a particular room type in the hotel.


rate_id string (Required)

The identifier for the rate plan associated with the room. It specifies the pricing rules and conditions for booking the room.


channel_hotel_id string (Required)

The identifier for the hotel in the distribution channel’s system. This links the hotel to the respective channel (for example, OTA, GDS).


channel_room_id string (Required)

The identifier for the specific room type in the channel’s system. It associates the room in the channel with the rate plan.


channel_rate_id string (Required)

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


channel_id integer (Required)

The identifier for the distribution channel. This links the room rate plan to a specific external platform, such as an online travel agency or global distribution system.


pricing array (Required)

An array that defines pricing rules based on the number of guests. Each entry in the array includes:

applicable_no_of_guest integer (Required)

The number of guests the pricing applies to.

multiplier string (Required)

The multiplier applied to the base rate for the specified number of guests. For example, if the base rate is $100 and the multiplier is 8, the price would be $800 for that number of guests.

surcharge string (Required)

An additional surcharge for the specified number of guests. This adds extra cost to the base rate based on the number of guests.

For example, a surcharge of $5 for 2 guests.

Example:

  • For 1 guest, no surcharge and the base rate applies.

  • For 2 guests, the multiplier is 8, and there’s a surcharge of $5.

  • For 3 guests, the multiplier is 4, and a surcharge of $1 applies


disable_availability boolean (Required)

Indicates whether the room’s availability is disabled.

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

disable_rate boolean (Required)

Indicates whether the rate plan is disabled.

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


fixed_minstay object (Required)

Defines the fixed minimum stay requirement for the room:

fixed boolean (Required)

Specifies whether the minimum stay is fixed.

In this case, it’s set to true, indicating the minimum stay requirement cannot be adjusted.

minstay integer (Required)

The minimum number of nights required for booking the room.

In this case, it’s set to 2, meaning guests must book at least 2 nights.


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": 1,
            "multiplier": "1",
            "surcharge": "0"
        },
        {
            "applicable_no_of_guest": 2,
            "multiplier": "8",
            "surcharge": "5"
        },
        {
            "applicable_no_of_guest": 3,
            "multiplier": "4",
            "surcharge": "1"
        },
        {
            "applicable_no_of_guest": 4,
            "multiplier": "9",
            "surcharge": "2"
        },
        {
            "applicable_no_of_guest": 5,
            "multiplier": "7",
            "surcharge": "6"
        }
    ],
    "disable_availability": false,
    "disable_rate": false,
    "fixed_minstay": {
        "fixed": true,
        "minstay": 2
    }
}

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.