OperationId:getControlSegments
" }, { "info": { "name": "Fetch Best Available Rates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/bestavailablerates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "startDay", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "rateCode", "value": "", "type": "query" }, { "name": "endDay", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "daysOfWeek", "value": "", "type": "query", "description": "Allowed values for the days of week type." }, { "name": "lengthOfStay", "value": "", "type": "query", "description": "Allowed values for length stay type." } ] }, "docs": "This API allows to fetch Best Available rates for rate code(s).OperationId:getBestAvailableRates
The maximum allowable limit for this API is 500.
This API allows a time span of 90 days.
" }, { "info": { "name": "Create a Best Available Rates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/bestavailablerates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows to create Best Available rates for rate code(s).OperationId:postBestAvailableRates
" }, { "info": { "name": "Delete Best Available Rates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/bestavailablerates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "code", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "start", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "friday", "value": "", "type": "query" }, { "name": "monday", "value": "", "type": "query" }, { "name": "saturday", "value": "", "type": "query" }, { "name": "sunday", "value": "", "type": "query" }, { "name": "thursday", "value": "", "type": "query" }, { "name": "tuesday", "value": "", "type": "query" }, { "name": "wednesday", "value": "", "type": "query" }, { "name": "lOS1", "value": "", "type": "query", "description": "Indicates Length of Stay 1 configuration." }, { "name": "lOS2", "value": "", "type": "query", "description": "Indicates Length of Stay 2 configuration." }, { "name": "lOS3", "value": "", "type": "query", "description": "Indicates Length of Stay 3 configuration." }, { "name": "lOS4", "value": "", "type": "query", "description": "Indicates Length of Stay 4 configuration." }, { "name": "lOS5", "value": "", "type": "query", "description": "Indicates Length of Stay 5 configuration." }, { "name": "lOS6", "value": "", "type": "query", "description": "Indicates Length of Stay 6 configuration." }, { "name": "lOS7", "value": "", "type": "query", "description": "Indicates Length of Stay 7 configuration." }, { "name": "lOS8", "value": "", "type": "query", "description": "Indicates Length of Stay 8 configuration." } ] }, "docs": "This API allows to fetch Best Available rates for rate code(s).OperationId:deleteBestAvailableRates
" }, { "info": { "name": "Get rate plans for a given block", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/blocks/ratePlans", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "Rate Plan code." }, { "name": "beginDate", "value": "", "type": "query", "description": "Start sell date of the rate code." }, { "name": "endDate", "value": "", "type": "query", "description": "End sell date of the rate code." }, { "name": "companyId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "companyIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "sourceId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "sourceIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "agentId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "agentIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "negotiatedOnly", "value": "", "type": "query", "description": "Flag to indicate if negotiated rate codes to be fetched." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Currency for the rate code to be fetched." } ] }, "docs": "This API allows you to fetch Rate Plans on a specific block.OperationId:getRatePlansForBlock
" }, { "info": { "name": "Create a new Control Segment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/controlSegments/:controlSegmentCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "controlSegmentCode", "value": "", "type": "path", "description": "Unique Code of the Control Segment." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to create a new Control Segment.OperationId:postControlSegment
" }, { "info": { "name": "Modify a Control Segment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/controlSegments/:controlSegmentCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "controlSegmentCode", "value": "", "type": "path", "description": "Unique Code of the Control Segment." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to modify a Control Segment.OperationId:changeControlSegment
" }, { "info": { "name": "Delete a Control Segment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/controlSegments/:controlSegmentCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "controlSegmentCode", "value": "", "type": "path", "description": "Unique Code of the Control Segment." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to delete a Control Segment.OperationId:removeControlSegment
" }, { "info": { "name": "Delete mass rate change log", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/massRateChangeLog", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to delete mass rate change log.OperationId:deleteMassRateChangeLog
" }, { "info": { "name": "Get mass rate change status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/massRateChangeStatus", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "detailStatus", "value": "", "type": "query", "description": "Flag to indicate to include the update process details or not." } ] }, "docs": "This API allows you to fetch mass rate change status.OperationId:getMassRateChangeStatus
" }, { "info": { "name": "Set mass rate plan schedules", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/massRatePlanSchedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update mass Rate Plan schedules.OperationId:setMassRatePlanSchedules
" }, { "info": { "name": "Get negotiated rates and profiles ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/negotiatedRates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "startDate", "value": "", "type": "query", "description": "Start Date." }, { "name": "endDate", "value": "", "type": "query", "description": "End Date." }, { "name": "includeInactiveNegotiatedRates", "value": "", "type": "query", "description": "Inactive negotiated rates." }, { "name": "fetchInstructionsLimit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for negotiated rates instructions that can be used in requests for partial operations." } ] }, "docs": "This API allows you to fetch negotiated rates and profile for a given hotel id.OperationId:getNegotiatedRates
The maximum allowable limit for this API is 500.
This API allows a time span of 90 days.
" }, { "info": { "name": "Create negotiated rates ", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/negotiatedRates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create negotiated rate for a given profile.OperationId:postNegotiatedRates
" }, { "info": { "name": "Distribute negotiated rates", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/negotiatedRates/distributions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to distribute negotiated Rate.OperationId:distributeNegotiatedRates
" }, { "info": { "name": "Change negotiated rates ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/negotiatedRates/:rateCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update negotiated rate for a given profile.OperationId:putNegotiatedRates
" }, { "info": { "name": "Fetch Negotiated Rates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/negotiatedRates/:rateCode/profiles", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "startDate", "value": "", "type": "query", "description": "Start Date." }, { "name": "endDate", "value": "", "type": "query", "description": "End Date." }, { "name": "includeInactiveNegotiatedRates", "value": "", "type": "query", "description": "Inactive negotiated rates." }, { "name": "fetchInstructionsLimit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for negotiated rates instructions that can be used in requests for partial operations." } ] }, "docs": "This API allows you to fetch a Rate Plan and Profile for given hotel id and negotiated rate code.OperationId:getNegotiatedRatesForGivenHotelAndRate
The maximum allowable limit for this API is 500.
This API allows a time span of 90 days.
" }, { "info": { "name": "Get Hotel Package Forecast Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/packageForecastGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "PackageForecastGroupCodes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Inactive flag - whether or not to display inactive records" } ] }, "docs": "This API allows you to fetch package forecast groups.OperationId:getHotelPackageForecastGroups
The maximum allowable limit for this API is 1000.
" }, { "info": { "name": "Create Hotel Package Forecast Groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/packageForecastGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create package forecast groups.OperationId:postHotelPackageForecastGroups
" }, { "info": { "name": "Change Hotel Package Forecast Groups", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/packageForecastGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update package forecast groups.OperationId:putHotelPackageForecastGroups
" }, { "info": { "name": "Delete Hotel Package Forecast Groups", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/packageForecastGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "code", "value": "", "type": "query", "description": "Configuration code." } ] }, "docs": "This API allows you to delete package forecast groups.OperationId:deleteHotelPackageForecastGroups
" }, { "info": { "name": "Get package formula ranges", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/packageFormulaRanges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "taxRangeType", "value": "", "type": "query", "description": "Tax Range Type." } ] }, "docs": "This API allows you to fetch package formula ranges.OperationId:getPackageFormulaRanges
" }, { "info": { "name": "Create package formula ranges", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/packageFormulaRanges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create package formula ranges.OperationId:postPackageFormulaRanges
" }, { "info": { "name": "Change package formula ranges", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/packageFormulaRanges/:packageFormulaRangeId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "packageFormulaRangeId", "value": "", "type": "path", "description": "Package Formula Range Id." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update package formula ranges.OperationId:putPackageFormulaRanges
" }, { "info": { "name": "Delete package formula ranges", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/packageFormulaRanges/:packageFormulaRangeId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "packageFormulaRangeId", "value": "", "type": "path", "description": "Package Formula Range Id." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." } ] }, "docs": "This API allows you to delete package formula ranges.OperationId:deletePackageFormulaRanges
" }, { "info": { "name": "Get package groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/packageGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "code", "value": "", "type": "query", "description": "Package code or group to be searched." }, { "name": "descriptionWildCard", "value": "", "type": "query", "description": "The description or a part of the description based on which results should be filtered." }, { "name": "includeOnlySeparateLinePackages", "value": "", "type": "query", "description": "If set to true, the API returns only those package groups where all package codes are configured as Add to Rate - Separate Line packages. If false or omitted, no additional filtering is applied." } ] }, "docs": "This API allows you to fetch package group.OperationId:getPackageGroups
The maximum allowable limit for this API is 1000.
" }, { "info": { "name": "Create package group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/packageGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create package group.OperationId:postPackageGroup
" }, { "info": { "name": "Change package group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/packageGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to change package group.OperationId:putPackageGroup
" }, { "info": { "name": "Delete package group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/packageGroups/:packageCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "packageCode", "value": "", "type": "path", "description": "Package Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to delete package group.OperationId:deletePackageGroups
" }, { "info": { "name": "Get package for given package", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/packages/:packageCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "packageCode", "value": "", "type": "path", "description": "Package Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for package instructions that can be used in requests for partial operations." } ] }, "docs": "This API allows you to fetch package details for a given package.OperationId:getPackage
" }, { "info": { "name": "Create package", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/packages/:packageCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "packageCode", "value": "", "type": "path", "description": "Package Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create a package.OperationId:postPackage
" }, { "info": { "name": "Change the package", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/packages/:packageCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "packageCode", "value": "", "type": "path", "description": "Package Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update a package.OperationId:putPackage
" }, { "info": { "name": "Delete the package", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/packages/:packageCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "packageCode", "value": "", "type": "path", "description": "Package Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to delete a package.OperationId:deletePackage
" }, { "info": { "name": "Get package rates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/packages/:packageCode/rates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "packageCode", "value": "", "type": "path", "description": "Package Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." } ] }, "docs": "This API allows you to fetch rate plan codes associated for a package.OperationId:getPackageRates
The maximum allowable limit for this API is 1000.
" }, { "info": { "name": "Generate package description with AI Author Service Proxy.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/packages/:packageCode/text", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "packageCode", "value": "", "type": "path", "description": "Package Code." } ] }, "docs": "This API allows you to call the AI Author Service Proxy to generate a description for a package code." }, { "info": { "name": "Delete negotiated rates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/startDate/:startDate/negotiatedRates/:ratePlanId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanId", "value": "", "type": "path", "description": "Rate Plan ID." }, { "name": "startDate", "value": "", "type": "path", "description": "Start Date." }, { "name": "profileId", "value": "", "type": "path", "description": "Unique ID that identifies a profile." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to delete negotiated rate.OperationId:deleteNegotiatedRates
" }, { "info": { "name": "Get promotion codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/promotionCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "promotionCode", "value": "", "type": "query" }, { "name": "promotionGroup", "value": "", "type": "query" }, { "name": "rateCodes", "value": "", "type": "query", "description": "Comma separated list of rates codes. This is used to filter the response and return only those promotion codes that are tied to any of these rate codes." }, { "name": "description", "value": "", "type": "query", "description": "Category Description of the promotion." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether to include inactive promotions." }, { "name": "promotionsValidAfterDate", "value": "", "type": "query", "description": "Filter based on a booking end date that grabs all promotions on or after the input date" } ] }, "docs": "This API allows you to fetch promotion codes.OperationId:getPromotionCodes
The maximum allowable limit for this API is 1000.
" }, { "info": { "name": "Create promotion codes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/promotionCodes/:promotionCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create promotion codes.OperationId:postPromotionCode
" }, { "info": { "name": "Change promotion codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/promotionCodes/:promotionCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update promotion codes.OperationId:putPromotionCode
" }, { "info": { "name": "Get promotion coupon codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/promotionCodes/:promotionCode/coupons", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "batchCode", "value": "", "type": "query" }, { "name": "createdOn", "value": "", "type": "query", "description": "Date when promotion coupon code was created." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether to include inactive promotion coupon codes." }, { "name": "couponCode", "value": "", "type": "query", "description": "Promotion Coupon Code." } ] }, "docs": "This API allows you to get promotion coupon codes.OperationId:getPromotionCouponCodes
" }, { "info": { "name": "Generate promotion coupon codes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/promotionCodes/:promotionCode/coupons", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." } ] }, "docs": "This API allows you to generate promotion coupon codes.OperationId:generatePromotionCouponCodes
" }, { "info": { "name": "Get promotion coupon code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/promotionCodes/:promotionCode/coupons/:couponId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." }, { "name": "couponId", "value": "", "type": "path", "description": "Promotion Coupon Code Id." } ] }, "docs": "This API allows you to get promotion coupon code based on promotion coupon code id.OperationId:getPromotionCouponCode
" }, { "info": { "name": "Update promotion coupon codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/promotionCodes/:promotionCode/coupons/:couponId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." }, { "name": "couponId", "value": "", "type": "path", "description": "Promotion Coupon Code Id." } ] }, "docs": "This API allows you to update promotion coupon codes.OperationId:putPromotionCouponCode
" }, { "info": { "name": "Get promotion groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/promotionGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "code", "value": "", "type": "query" }, { "name": "promotionGroupListCode", "value": "", "type": "query" }, { "name": "rateCodes", "value": "", "type": "query", "description": "Comma separated list of rates codes. This is used to filter the response and return only those promotion codes that are tied to any of these rate codes." }, { "name": "description", "value": "", "type": "query", "description": "Category Description of the promotion." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether to include inactive promotions." } ] }, "docs": "This API allows you to fetch promotion codes.OperationId:getPromotionGroups
The maximum allowable limit for this API is 1000.
" }, { "info": { "name": "Copy promotion groups", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/promotionGroups/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to copy promotions groups.OperationId:copyPromotionGroups
" }, { "info": { "name": "Create promotion groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/promotionGroups/:groupCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "groupCode", "value": "", "type": "path", "description": "Promotion Group Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create promotion groups.OperationId:postPromotionGroup
" }, { "info": { "name": "Change promotion groups", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/promotionGroups/:groupCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "groupCode", "value": "", "type": "path", "description": "Promotion Group Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update promotion groups.OperationId:putPromotionGroup
" }, { "info": { "name": "Delete promotion groups", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/promotionGroups/:groupCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "groupCode", "value": "", "type": "path", "description": "Promotion Group Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to delete promotion groups.OperationId:deletePromotionGroup
" }, { "info": { "name": "Set rate access exclusions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/rateAccessExclusions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to set rate access exclusions.OperationId:setRateAccessExclusions
" }, { "info": { "name": "Delete rate access exclusions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/rateAccessExclusions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "rateCode", "value": "", "type": "query", "description": "Rate code" }, { "name": "allowCancelReservation", "value": "", "type": "query", "description": "Allow to cancel a reservation under this access exclusion." }, { "name": "allowCreateReservation", "value": "", "type": "query", "description": "Allow to create a reservation under this access exclusion." }, { "name": "allowModifyReservation", "value": "", "type": "query", "description": "Allow to modify a reservation under this access exclusion." }, { "name": "excludeFromAvailability", "value": "", "type": "query", "description": "Exclude a specific rate from availability" }, { "name": "inactive", "value": "", "type": "query", "description": "The rate access exclusion is inactive" }, { "name": "sourceType", "value": "", "type": "query", "description": "The type of source (CRO or Hotel code) for which the rate access exclusion is set." }, { "name": "sourceValue", "value": "", "type": "query", "description": "CRO or Hotel code value." }, { "name": "end", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "start", "value": "", "type": "query", "description": "The starting value of the date range." } ] }, "docs": "This API allows you to delete rate access exclusions.OperationId:deleteRateAccessExclusions
This API allows a time span of 90 days.
" }, { "info": { "name": "Get rate groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rateGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "code", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "description", "value": "", "type": "query", "description": "Rate Group Description." } ] }, "docs": "This API allows you to update rate groups.OperationId:getRateGroups
" }, { "info": { "name": "Create rate groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/rateGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create rate groups.OperationId:postRateGroups
" }, { "info": { "name": "Change rate groups", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/rateGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update rate groups.OperationId:putRateGroups
" }, { "info": { "name": "Delete rate groups", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/rateGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to delete rate groups.OperationId:deleteRateGroups
" }, { "info": { "name": "Get rate plan schedule yield adjustments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/ratePlan/schedule/yieldAdjustment", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "summaryInfo", "value": "", "type": "query", "description": "When true response will return summary information otherwise detailed information." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "Rate plan code." } ] }, "docs": "This API allows you to fetch Rate Plan schedules for yield adjustments.OperationId:getRatePlanScheduleYieldAdjustments
" }, { "info": { "name": "Split rate plan schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/ratePlanSchedules/:scheduleId/split", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "scheduleId", "value": "", "type": "path", "description": "Schedule Id." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to split Rate Plan schedule.OperationId:splitRatePlanSchedule
" }, { "info": { "name": "Get rate plans by Hotel Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "Rate plan code." }, { "name": "postingInterval", "value": "", "type": "query", "description": "Optional posting interval filter. When nothing is provided in this filter then only Nightly rates will be returned" }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for Rate plan codes instructions that can be used in requests for partial operations." } ] }, "docs": "This API allows you to fetch Rate Plans for a given hotel id. API returns only Nightly rates when posting interval is not providedOperationId:getRatePlansByHotel
" }, { "info": { "name": "Create rate plans ", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create Rate Plans for a given hotel ID.OperationId:postRatePlan
" }, { "info": { "name": "Synchronizes Rate Plan information including Rate Header and Packages across target properties.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/sync", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API updates all requested properties having the same rate code so they have the same rate code attributes." }, { "info": { "name": "Get rate plan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for Rate plan codes instructions that can be used in requests for partial operations." } ] }, "docs": "This API allows you to fetch Rate Plan for a given hotel id and Rate Plan Code.OperationId:getRatePlan
" }, { "info": { "name": "Change rate plan ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update Rate Plan information such as date range, linked room types, and rate controls for a given hotelID. There is a separate API to add or update the rate plan pricing schedule.OperationId:putRatePlan
" }, { "info": { "name": "Delete rate plan ", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to delete Rate Plan for a given hotel id.OperationId:deleteRatePlan
" }, { "info": { "name": "Copy rate plans", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to copy Rate Plans.OperationId:copyRatePlans
" }, { "info": { "name": "Set daily rate plan schedule range", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/dailySchedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to set Rate Plan schedule range.OperationId:setDailyRatePlanScheduleRange
" }, { "info": { "name": "Delete daily rate plan schedule range", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/dailySchedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "roomType", "value": "", "type": "query", "description": "Room Type." }, { "name": "roomClass", "value": "", "type": "query", "description": "Room Class." }, { "name": "friday", "value": "", "type": "query" }, { "name": "monday", "value": "", "type": "query" }, { "name": "saturday", "value": "", "type": "query" }, { "name": "sunday", "value": "", "type": "query" }, { "name": "thursday", "value": "", "type": "query" }, { "name": "tuesday", "value": "", "type": "query" }, { "name": "wednesday", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "advancedDailyBaseRatePlanCode", "value": "", "type": "query", "description": "The Base Rate Plan Code which will be used to look up for and configure the Pricing Schedule for the main Rate Plan Code" } ] }, "docs": "This API allows you to delete daily Rate Plan schedules.OperationId:deleteDailyRatePlanScheduleRange
" }, { "info": { "name": "Get rate plan metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/metrics", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "fields", "value": "", "type": "query", "description": "Select which metric fields to return. Supported values are 'dependentBaseRates' and 'rateCodePricingSchedules'. If omitted, all supported metrics are returned." } ] }, "docs": "Provides counts for dependent base rates and rate code pricing schedules for a given rate plan. If no 'fields' are specified, all supported metrics are returned." }, { "info": { "name": "Create rate plan package", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/packages", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create Rate Plan package.OperationId:postRatePlanPackages
" }, { "info": { "name": "Change rate plan package", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/packages", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update Rate Plan package.OperationId:putRatePlanPackages
" }, { "info": { "name": "Delete rate plan packages", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/packages", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "packageCode", "value": "", "type": "query", "description": "Configuration code." }, { "name": "packageGroup", "value": "", "type": "query", "description": "Configuration code." } ] }, "docs": "This API allows you to delete Rate Plan package.OperationId:deleteRatePlanPackages
" }, { "info": { "name": "Create rate plan posting rhythms", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/postingRhythms", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create Rate Plan posting rhythms.OperationId:postRatePlanPostingRhythms
" }, { "info": { "name": "Change rate plan posting rhythms", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/postingRhythms", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update Rate Plan posting rhythms.OperationId:putRatePlanPostingRhythms
" }, { "info": { "name": "Delete rate plan posting rhythms", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/postingRhythms", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "code", "value": "", "type": "query" } ] }, "docs": "This API allows you to delete Rate Plan posting rhythms.OperationId:deleteRatePlanPostingRhythms
" }, { "info": { "name": "Get rate plan schedules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/schedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "excludeRatePlanPackage", "value": "", "type": "query", "description": "Exclude the List of Pricing Schedule Packages from the response." }, { "name": "tierId", "value": "", "type": "query" }, { "name": "ratePlanScheduleId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "ratePlanScheduleIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "duration", "value": "", "type": "query" }, { "name": "roomType", "value": "", "type": "query", "description": "Room Type." }, { "name": "roomClass", "value": "", "type": "query", "description": "Room Class." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return. When offset is sent, limit value cannot exceed 500. " }, { "name": "includeInactive", "value": "", "type": "query", "description": "Include inactive rate schedules in the fetch result." } ] }, "docs": "This API allows you to fetch Rate Plan schedules.OperationId:getRatePlanSchedules
This API allows a time span of 365 days.
" }, { "info": { "name": "Create rate plan schedules", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/schedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create Rate Plan pricing schedule.OperationId:postRatePlanSchedules
" }, { "info": { "name": "Change rate plan schedules", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/schedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update Rate Plan schedules.OperationId:putRatePlanSchedules
" }, { "info": { "name": "Delete rate plan schedule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/schedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "ratePlanScheduleIds", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "tierID", "value": "", "type": "query", "description": "Tier that the rate plan schedule belongs to." }, { "name": "seasonCode", "value": "", "type": "query", "description": "Season code attached to the rate plan schedule that defines the start and end dates. When creating a rate plan schedule, if a season code is provided the start and end dates will be ignored. These values will be pulled from the season code record." }, { "name": "start", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "end", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "roomType", "value": "", "type": "query", "description": "List of room types that are for the rate plan schedule." }, { "name": "sunday", "value": "", "type": "query", "description": "Day Of The Week Schedule Should Be Applicable." }, { "name": "monday", "value": "", "type": "query", "description": "Day Of The Week Schedule Should Be Applicable." }, { "name": "tuesday", "value": "", "type": "query", "description": "Day Of The Week Schedule Should Be Applicable." }, { "name": "wednesday", "value": "", "type": "query", "description": "Day Of The Week Schedule Should Be Applicable." }, { "name": "thursday", "value": "", "type": "query", "description": "Day Of The Week Schedule Should Be Applicable." }, { "name": "friday", "value": "", "type": "query", "description": "Day Of The Week Schedule Should Be Applicable." }, { "name": "saturday", "value": "", "type": "query", "description": "Day Of The Week Schedule Should Be Applicable." } ] }, "docs": "This API allows you to delete Rate Plan schedules.OperationId:deleteRatePlanSchedules
" }, { "info": { "name": "Set rate plan schedules", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/schedules/set", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to set Rate Plan schedules.OperationId:setRatePlanSchedules
" }, { "info": { "name": "Copy tiered rate schedules", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/ratePlans/:ratePlanCode/sourceTiers/:sourceTierId/destinationTiers/:destinationTierId/schedules/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "destinationTierId", "value": "", "type": "path", "description": "Destination Tier Id." }, { "name": "sourceTierId", "value": "", "type": "path", "description": "Source Tier Id." }, { "name": "ratePlanCode", "value": "", "type": "path", "description": "Rate Plan Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to copy tiered rate schedules.OperationId:copyTieredRateSchedules
" }, { "info": { "name": "Get rate strategies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rateStrategies", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "restrictionDate", "value": "", "type": "query", "description": "search Rate Strategies with this restriction date." } ] }, "docs": "This API allows you to fetch rate strategies.OperationId:getRateStrategies
The maximum allowable limit for this API is 1000.
" }, { "info": { "name": "Create rate strategies", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/rateStrategies", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create rate strategies.OperationId:postRateStrategy
" }, { "info": { "name": "Change rate strategies", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/rateStrategies/:rateStrategyId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateStrategyId", "value": "", "type": "path", "description": "Strategy Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update rate strategies.OperationId:putRateStrategy
" }, { "info": { "name": "Delete rate strategies", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/rateStrategies/:rateStrategyId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateStrategyId", "value": "", "type": "path", "description": "Strategy Id" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to delete rate strategies.OperationId:deleteRateStrategy
" }, { "info": { "name": "Get rate activity log", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rates/activityLog", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "module", "value": "", "type": "query", "description": "Activity module." }, { "name": "parameterName", "value": "", "type": "query", "description": "Name of the parameter." }, { "name": "parameterValue", "value": "", "type": "query", "description": "Value of the parameter." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "activityGroup", "value": "", "type": "query" }, { "name": "activityType", "value": "", "type": "query" }, { "name": "fromDate", "value": "", "type": "query", "description": "Search from date for the user activity log." }, { "name": "toDate", "value": "", "type": "query", "description": "Search to date for the user activity log." }, { "name": "searchText", "value": "", "type": "query", "description": "Search text for the user activity log." }, { "name": "userId", "value": "", "type": "query" }, { "name": "userForIdsUserId", "value": "", "type": "query" } ] }, "docs": "This API allows you to fetch Rate Activity Log.OperationId:getRateActivityLog
The maximum allowable limit for this API is 500.
This API allows a time span of 90 days.
" }, { "info": { "name": "Get yield adjustments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/yieldAdjustments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "currencyCode", "value": "", "type": "query", "description": "fetch adjustment codes attached to this Currency code." } ] }, "docs": "This API allows you to fetch yield adjustments.OperationId:getYieldAdjustments
The maximum allowable limit for this API is 1000.
" }, { "info": { "name": "Get Template Package Forecast Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/packageForecastGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "includeInactive", "value": "", "type": "query", "description": "Inactive flag - whether or not to display inactive records" }, { "name": "packageForecastGroupCode", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." } ] }, "docs": "This API allows you to fetch Package Forecast groups template.OperationId:getTemplatePackageForecastGroups
" }, { "info": { "name": "Create Template Package Forecast Groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/packageForecastGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API allows you to create Package Forecast groups template.OperationId:postTemplatePackageForecastGroups
" }, { "info": { "name": "Change Template Package Forecast Groups", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/packageForecastGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API allows you to update Package Forecast groups template.OperationId:putTemplatePackageForecastGroups
" }, { "info": { "name": "Delete Template Package Forecast Groups", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/packageForecastGroups/:packageForecastGroupCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "packageForecastGroupCode", "value": "", "type": "path", "description": "Code." } ] }, "docs": "This API allows you to delete Package Forecast groups template.OperationId:deleteTemplatePackageForecastGroups
" }, { "info": { "name": "Get packages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/packages", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code." }, { "name": "packageCode", "value": "", "type": "query" }, { "name": "packageCategory", "value": "", "type": "query", "description": "Package Category based on which results should be filtered." }, { "name": "descriptionWildCard", "value": "", "type": "query", "description": "The description or a part of the description based on which results should be filtered." }, { "name": "startDate", "value": "", "type": "query", "description": "Start Date for pricing schedule." }, { "name": "endDate", "value": "", "type": "query", "description": "End Date for pricing schedule." }, { "name": "adults", "value": "", "type": "query", "description": "Number of adults for pricing schedule calculation." }, { "name": "children", "value": "", "type": "query", "description": "Number of children for pricing schedule calculation." }, { "name": "bucket1Count", "value": "", "type": "query", "description": "Number of children classified under the first Age Qualifying Group(Child Bucket#1)." }, { "name": "bucket2Count", "value": "", "type": "query", "description": "Number of children classified under the second Age Qualifying Group(Child Bucket#2)." }, { "name": "bucket3Count", "value": "", "type": "query", "description": "Number of children classified under the third Age Qualifying Group(Child Bucket#3)." }, { "name": "bucket4Count", "value": "", "type": "query", "description": "Number of children classified under the fourth Age Qualifying Group(Child Bucket#4)." }, { "name": "bucket5Count", "value": "", "type": "query", "description": "Number of children classified under the fifth Age Qualifying Group(Child Bucket#5)." }, { "name": "includeGroup", "value": "", "type": "query", "description": "Indicates if Group Packages will be fetched." }, { "name": "sellSeparate", "value": "", "type": "query", "description": "Indicates if Only Sell Separate Packages will be fetched, if not specified, it will ignore the criteria." }, { "name": "ticketPostingRhythm", "value": "", "type": "query", "description": "Indicates if Only Ticket Posting Rhythm will be fetched, if not specified, it will ignore the criteria." }, { "name": "excludeRedemptionPackages", "value": "", "type": "query", "description": "Indicates if redemption packages must be excluded from the list." }, { "name": "includeOnlySeparateLinePackages", "value": "", "type": "query", "description": "Indicates if Only Add to Rate - Separate line will be fetched, if not specified, it will ignore the criteria." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for package instructions that can be used in requests for partial operations." } ] }, "docs": "This API allows you to fetch packages for a hotel id.OperationId:getPackages
This API allows a time span of 365 days.
" }, { "info": { "name": "Copy package code(s) ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/packages/copy", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API allows you to copy package codes(s) from one hotel to another.OperationId:copyPackages
" }, { "info": { "name": "Save the package description to the AI Author Service.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/packages/text/:responseId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" } ], "params": [ { "name": "responseId", "value": "", "type": "path", "description": "Response value of the AI Proxy Service." } ] }, "docs": "This API allows you to call the AI Author Service Proxy to save the description for a package code." }, { "info": { "name": "Get negotiated rate details for given profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/negotiatedRates", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "startDate", "value": "", "type": "query", "description": "Start Date." }, { "name": "endDate", "value": "", "type": "query", "description": "End Date." }, { "name": "hotelCode", "value": "", "type": "query", "description": "Hotel code associated to the hotel" }, { "name": "hotelCodes", "value": "", "type": "query", "description": "Hotel code of negotiated rates to be searched." }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "Rate Plan Code associated with the rate" }, { "name": "includeInactiveNegotiatedRates", "value": "", "type": "query", "description": "Inactive negotiated rates." }, { "name": "fetchInstructionsLimit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Simple type for negotiated rates instructions that can be used in requests for partial operations." } ] }, "docs": "This API allows you to fetch negotiated Rates for a given profile.OperationId:getNegotiatedRatesForGivenProfile
The maximum allowable limit for this API is 500.
This API allows a time span of 90 days.
" }, { "info": { "name": "Get Template Promotion Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/promotionCodes", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code." }, { "name": "promotionCode", "value": "", "type": "query" }, { "name": "promotionGroup", "value": "", "type": "query" }, { "name": "rateCodes", "value": "", "type": "query", "description": "Comma separated list of rates codes. This is used to filter the response and return only those promotion codes that are tied to any of these rate codes." }, { "name": "description", "value": "", "type": "query", "description": "Category Description of the promotion." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether to include inactive promotions." } ] }, "docs": "This API allows you to fetch Promotion Code template.OperationId:getTemplatePromotionCodes
The maximum allowable limit for this API is 1000.
" }, { "info": { "name": "Create Template Promotion Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/promotionCodes/:promotionCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." } ] }, "docs": "This API allows you to create Promotion Code template.OperationId:postTemplatePromotionCode
" }, { "info": { "name": "Change Template Promotion Code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/promotionCodes/:promotionCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." } ] }, "docs": "This API allows you to update Promotion Code template.OperationId:putTemplatePromotionCode
" }, { "info": { "name": "Get promotion coupon codes at template level.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/promotionCodes/:promotionCode/coupons", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." }, { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "batchCode", "value": "", "type": "query" }, { "name": "createdOn", "value": "", "type": "query", "description": "Date when promotion coupon code was created." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicates whether to include inactive promotion coupon codes." }, { "name": "couponCode", "value": "", "type": "query", "description": "Promotion Coupon Code." } ] }, "docs": "This API allows you to get promotion coupon codes for a template.OperationId:getTemplatePromotionCouponCodes
" }, { "info": { "name": "Generate template promotion coupon codes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/promotionCodes/:promotionCode/coupons", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Coupon Code." } ] }, "docs": "This API allows you to generate promotion coupon codes at template promotion level.OperationId:generateTemplatePromotionCouponCodes
" }, { "info": { "name": "Inactivate promotion coupon codes for a given batch code.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/promotionCodes/:promotionCode/coupons/inactivate", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." } ] }, "docs": "This API allows you to inactivate promotion coupon codes for a given batch code.OperationId:inactivatePromotionCouponBatchCode
" }, { "info": { "name": "Get promotion coupon code at template level.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/promotionCodes/:promotionCode/coupons/:couponId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." }, { "name": "couponId", "value": "", "type": "path", "description": "Promotion Coupon Code Id." } ] }, "docs": "This API allows you to get promotion coupon code based on promotion coupon code id for a template.OperationId:getTemplatePromotionCouponCode
" }, { "info": { "name": "Update promotion coupon codeat template level.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/promotionCodes/:promotionCode/coupons/:couponId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." }, { "name": "couponId", "value": "", "type": "path", "description": "Promotion Coupon Code Id." } ] }, "docs": "This API allows you to update promotion coupon code at template level.OperationId:putTemplatePromotionCouponCode
" }, { "info": { "name": "Manages rate plan schedules", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/ratePlanSchedules", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API allows you to update Rate Plan schedules.OperationId:manageRatePlansSchedules
" }, { "info": { "name": "Get rate plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/ratePlans", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query", "description": "Hotel code." }, { "name": "includeRateInformation", "value": "", "type": "query", "description": "Indicates whether rate plan short and long information should be included in the fetched results." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "ratePlanCode", "value": "", "type": "query", "description": "Rate Plan code." }, { "name": "rateCategory", "value": "", "type": "query", "description": "Rate category of the rate plan." }, { "name": "sellDate", "value": "", "type": "query", "description": "Sell date of the rate plan." }, { "name": "displaySet", "value": "", "type": "query", "description": "Display set for the rate plan." }, { "name": "postingInterval", "value": "", "type": "query", "description": "Optional posting interval filter. When nothing is provided in this filter then only Nightly rates will be returned" }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "idExtension", "value": "", "type": "query", "description": "Additional identifying value assigned by the creating system." }, { "name": "idContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "type", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT)." }, { "name": "attributeName", "value": "", "type": "query" }, { "name": "orderType", "value": "", "type": "query" }, { "name": "includeInactive", "value": "", "type": "query", "description": "Include or not include inactive rate codes." }, { "name": "dayUseOnly", "value": "", "type": "query", "description": "Indicates to only fetch rate plans flagged as Day Use." }, { "name": "approvalStatus", "value": "", "type": "query", "description": "Indicates that the Rate Plan is approved for selling." } ] }, "docs": "This API allows you to fetch Rate Plans. API returns only Nightly rates when posting interval is not provided.OperationId:getRatePlans
The maximum allowable limit for this API is 1000.
" }, { "info": { "name": "Set rate strategies", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rateStrategies", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API allows you to set Rate strategies.OperationId:setRateStrategies
" }, { "info": { "name": "Get Rate plan service version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/rateplan/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "This API allows you to fetch Rate Plan Service version.OperationId:pingRatePlanService
" }, { "info": { "name": "Create/Change package formula ranges", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/hotels/:hotelId/packageFormulaRanges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to create/update package formula ranges.OperationId:putUpsertPackageFormulaRanges
" }, { "info": { "name": "Change/Create promotion codes", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/hotels/:hotelId/promotionCodes/:promotionCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update/create promotion codes.OperationId:putUpsertPromotionCode
" }, { "info": { "name": "Change/Create rate groups", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/hotels/:hotelId/rateGroups", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to update/create rate groups.OperationId:putUpsertRateGroups
" }, { "info": { "name": "Create/Change rate strategies", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/hotels/:hotelId/rateStrategies", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to Create/Change rate strategies.OperationId:putUpsertRateStrategy
" }, { "info": { "name": "Change/create Template Promotion Code", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/promotionCodes/:promotionCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." } ] }, "docs": "This API allows you to update/create Promotion Code template.OperationId:putUpsertTemplatePromotionCode
" } ] }, { "info": { "name": "ChainConfig", "type": "folder" }, "items": [ { "info": { "name": "Get Display Sets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/displaySets", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fetchInactive", "value": "", "type": "query", "description": "Determines wether to fetch inactive records or not." }, { "name": "codes", "value": "", "type": "query", "description": "Codes to be searched." }, { "name": "wildCard", "value": "", "type": "query", "description": "Wildcard search on the code." }, { "name": "description", "value": "", "type": "query", "description": "Description of the code." } ] }, "docs": "Use this API to get Display Sets.OperationId:getDisplaySets
" }, { "info": { "name": "Create Display Sets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/displaySets", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to create Display Sets.OperationId:postDisplaySets
" }, { "info": { "name": "Change Display Sets", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/displaySets/:displaySetsId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "displaySetsId", "value": "", "type": "path", "description": "Unique ID of Display Sets." } ] }, "docs": "Use this API to update Display Sets.OperationId:putDisplaySets
" }, { "info": { "name": "Delete Display Sets", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/displaySets/:displaySetsId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "displaySetsId", "value": "", "type": "path", "description": "Unique ID of Display Sets." } ] }, "docs": "Use this API to delete Display Sets.OperationId:deleteDisplaySets
" } ] }, { "info": { "name": "HotelConfig", "type": "folder" }, "items": [ { "info": { "name": "Get Rate Category", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rateCategories", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "rateCategoryListCodes", "value": "", "type": "query" }, { "name": "rateCategoryDescription", "value": "", "type": "query", "description": "Rate Category description. Partial description searches are considered." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicator that tells whether inactive rate category should be included in fetch result." } ] }, "docs": "Search for Rate Categories. The search criteria can include a Rate category, the list of hotel Codes and the description of the Rate Category.OperationId:getRateCategory
The maximum allowable limit for this API is 1000.
" }, { "info": { "name": "Create Rate Category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/rateCategories", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "This API can be used to Use this API to create a Rate Category e.g. RACK. Only one rate category can be Use this API to created at a time.OperationId:postRateCategory
" }, { "info": { "name": "Change Rate Category", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/rateCategories", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "This API can be used to Modify a Rate Category e.g. RACK. Only one rate category can be modified at a time.OperationId:changeRateCategory
" }, { "info": { "name": "Delete Rate Category", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/rateCategories", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." }, { "name": "rateCategory", "value": "", "type": "query", "description": "Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X." } ] }, "docs": "Use this delete a Rate Category e.g. RACK.OperationId:deleteRateCategory
" }, { "info": { "name": "Get rate classes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rateClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "rateClassListCodes", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query", "description": "Description of the rate class." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicator which tells whether inactive rate class to be included or not." } ] }, "docs": "Use this API to get rate classes.OperationId:getRateClass
The maximum allowable limit for this API is 1000.
" }, { "info": { "name": "Create new rate class", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/rateClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to create new rate class.OperationId:postRateClass
" }, { "info": { "name": "Changes to rate class", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/rateClasses/:rateClassCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateClassCode", "value": "", "type": "path", "description": "Unique Code of rate class." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to updates to rate class.OperationId:changeRateClass
" }, { "info": { "name": "Delete rate class", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/rateClasses/:rateClassCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateClassCode", "value": "", "type": "path", "description": "Unique Code of rate class." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to delete rate class.OperationId:deleteRateClass
" }, { "info": { "name": "Get Hotel Rate Seasons", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rateSeasons", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "seasonsCodes", "value": "", "type": "query" } ] }, "docs": "Use this API to get Hotel Rate Seasons.OperationId:getRateSeasons
The maximum allowable limit for this API is 1000.
" }, { "info": { "name": "Create Hotel Rate Seasons", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/rateSeasons", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to create Hotel Rate Seasons.OperationId:postRateSeasons
" }, { "info": { "name": "Change Hotel Rate Seasons", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/rateSeasons/:seasonCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "seasonCode", "value": "", "type": "path", "description": "Unique Code of season." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to update Hotel Rate Seasons.OperationId:changeRateSeasons
" }, { "info": { "name": "Delete Hotel Rate Seasons", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/rateSeasons/:seasonCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "seasonCode", "value": "", "type": "path", "description": "Unique Code of season." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to delete Hotel Rate Seasons.OperationId:removeRateSeasons
" }, { "info": { "name": "Get Template Rate Categories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/templates/rateCategories", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateCategoryListCodes", "value": "", "type": "query" }, { "name": "rateCategoryDescription", "value": "", "type": "query", "description": "Rate Category description. Partial description searches are considered." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicator that tells whether inactive rate category should be included in fetch result." } ] }, "docs": "Use this API to fetch a Template Rate Category. The search criteria can include rate category and the property code.OperationId:getTemplateRateCategory
" }, { "info": { "name": "Create a Template Rate Category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/templates/rateCategories", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to create a new Template Rate Category.OperationId:postTemplateRateCategory
" }, { "info": { "name": "Change Template Rate Category", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/templates/rateCategories/:rateCategoryCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateCategoryCode", "value": "", "type": "path", "description": "Unique Code of rate category." } ] }, "docs": "Use this API to Modify a Template Rate Category. Only one template can be updated at a time.OperationId:changeTemplateRateCategory
" }, { "info": { "name": "Delete a Template Rate Category", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/templates/rateCategories/:rateCategoryCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateCategoryCode", "value": "", "type": "path", "description": "Unique Code of rate category." } ] }, "docs": "Use this API to delete a Template Rate Category. Only one rate category template can be sent as part of the request.OperationId:deleteTemplateRateCategory
" }, { "info": { "name": "Get template rate classes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/templates/rateClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "rateClassListCodes", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query", "description": "Description of the rate class." }, { "name": "includeInactive", "value": "", "type": "query", "description": "Indicator which tells whether inactive rate class to be included or not." } ] }, "docs": "Use this API to get template rate classes.OperationId:getTemplateRateClass
" }, { "info": { "name": "Create new template rate class", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/templates/rateClasses", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to create new template rate class.OperationId:postTemplateRateClass
" }, { "info": { "name": "Change template rate class", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/templates/rateClasses/:rateClassCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateClassCode", "value": "", "type": "path", "description": "Unique Code of rate class." } ] }, "docs": "Use this API to modify template rate class.OperationId:changeTemplateRateClass
" }, { "info": { "name": "Delete template rate class", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/templates/rateClasses/:rateClassCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "rateClassCode", "value": "", "type": "path", "description": "Unique Code of rate class." } ] }, "docs": "Use this API to delete template rate class.OperationId:deleteTemplateRateClass
" }, { "info": { "name": "Get Template Rate Seasons", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/templates/rateSeasons", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "seasonCodes", "value": "", "type": "query" } ] }, "docs": "Use this API to get Template Rate Seasons.OperationId:getTemplateRateSeasons
" }, { "info": { "name": "Create Template Rate Seasons", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/templates/rateSeasons", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to create Template Rate Seasons.OperationId:postTemplateRateSeasons
" }, { "info": { "name": "Change Template Rate Seasons", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/templates/rateSeasons/:seasonCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "seasonCode", "value": "", "type": "path", "description": "Unique Code of season." } ] }, "docs": "Use this API to update Template Rate Seasons.OperationId:changeTemplateRateSeasons
" }, { "info": { "name": "Delete Template Rate Seasons", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/templates/rateSeasons/:seasonCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "seasonCode", "value": "", "type": "path", "description": "Unique Code of season." } ] }, "docs": "Use this API to delete Template Rate Seasons.OperationId:removeTemplateRateSeasons
" }, { "info": { "name": "Create/Change Hotel Rate Seasons", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/upsert/hotels/:hotelId/rateSeasons/:seasonCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "seasonCode", "value": "", "type": "path", "description": "Unique Code of season." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of hotel." } ] }, "docs": "Use this API to create/update Hotel Rate Seasons.OperationId:changeUpsertRateSeasons
" } ] }, { "info": { "name": "Availability", "type": "folder" }, "items": [ { "info": { "name": "Validate a coupon code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rates/coupons/:couponCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "couponCode", "value": "", "type": "path", "description": "Coupon Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to validate a coupon code.OperationId:validateRateCoupon
" }, { "info": { "name": "Validate a promotion code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rates/promotions/:promotionCode", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "promotionCode", "value": "", "type": "path", "description": "Promotion Code." }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." } ] }, "docs": "This API allows you to validate a promotion code.OperationId:validateRatePromotion
" }, { "info": { "name": "Validate promotion and coupon code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/rates/promotionsCoupons", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID that identifies a single hotel property." }, { "name": "couponCode", "value": "", "type": "query", "description": "Coupon code to validate." }, { "name": "promotionCode", "value": "", "type": "query", "description": "Promotion Code to which the coupon belongs." }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" } ] }, "docs": "This API allows you to validate a promotion and coupon code.OperationId:validateRatePromotionCoupon
" } ] } ], "bundled": true }