--- updatedAt: 2025-09-09T21:11:38.000Z agentTools: projectIndex: https://docs.ciiruspartners.com/v2023.07.31/llms.txt --- # Retrieve all ratesets # OpenAPI definition ```json { "openapi": "3.0.0", "security": [ { "basicAuth": [] } ], "info": { "title": "CiiRUS Partner API", "version": "2023.07.31" }, "paths": { "/rates/ratesets": { "get": { "summary": "Retrieve all ratesets", "description": "", "responses": { "200": { "description": "Ratesets response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAllRatesetResponse" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" } }, "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/pageSize" }, { "$ref": "#/components/parameters/lastUpdateDate" }, { "$ref": "#/components/parameters/mcUserId" }, { "$ref": "#/components/parameters/mcUserIds" }, { "$ref": "#/components/parameters/unitIdQuery" }, { "$ref": "#/components/parameters/unitIdQueries" }, { "$ref": "#/components/parameters/excludeExpiredRates" } ], "tags": [ "Rates (Ratesets)" ] } } }, "servers": [ { "url": "https://api.ciiruspartners.com/v2023.07.31" } ], "components": { "parameters": { "unitIdQuery": { "name": "unitId", "in": "query", "description": "Unique Identifier for inventory.", "schema": { "type": "integer", "format": "int32", "minimum": 0 } }, "unitIdQueries": { "name": "unitIds", "in": "query", "description": "Unique Identifiers for inventory.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32", "minimum": 0 } } }, "pageSize": { "name": "pageSize", "in": "query", "description": "Limits the number of returned results.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 1000, "default": 25 } }, "page": { "name": "page", "in": "query", "description": "The page to be shown.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 1, "default": 1 } }, "lastUpdateDate": { "name": "lastUpdateDate", "in": "query", "description": "Only return objects which have been modified after a certain date.", "required": false, "schema": { "type": "string", "format": "date-time" } }, "excludeExpiredRates": { "name": "excludeExpiredRates", "in": "query", "description": "Only return ratesets which have future rates.", "required": false, "schema": { "type": "boolean" } }, "mcUserId": { "name": "mcUserId", "in": "query", "description": "Unique Identifier for supplier.", "required": false, "schema": { "type": "integer", "format": "int32", "minimum": 0 } }, "mcUserIds": { "name": "mcUserIds", "in": "query", "description": "Unique Identifiers for suppliers.", "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int32", "minimum": 0 } } } }, "responses": { "BadRequest": { "description": "Bad Request response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Unauthorized": { "description": "Unauthorized response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Forbidden": { "description": "Forbidden response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "NotFound": { "description": "Not Found response", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } }, "schemas": { "Error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "currency": { "properties": { "currency": { "type": "string" } } }, "property_id": { "properties": { "property_id": { "type": "integer", "format": "int32", "description": "Unique identifier for inventory" } } }, "mc_user_id": { "properties": { "mc_user_id": { "type": "integer", "format": "int32", "description": "Unique Identifier for supplier" } } }, "rate_set_id": { "properties": { "rate_set_id": { "type": "integer", "format": "int32" } } }, "RetrieveAllRatesetResponse": { "properties": { "ratesets": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveRatesetResponseObject" } } } }, "RetrieveRatesetResponseObject": { "allOf": [ { "$ref": "#/components/schemas/rate_set_id" }, { "$ref": "#/components/schemas/mc_user_id" }, { "$ref": "#/components/schemas/set_name" }, { "$ref": "#/components/schemas/weekly_daily_monthly" }, { "$ref": "#/components/schemas/includes_tax" }, { "$ref": "#/components/schemas/days_in_month" }, { "$ref": "#/components/schemas/based_on_arrival_date_band_only" }, { "$ref": "#/components/schemas/currency" }, { "$ref": "#/components/schemas/minimum_nightly_rate" }, { "$ref": "#/components/schemas/imported" }, { "$ref": "#/components/schemas/last_modified_by_staff_user_id" }, { "$ref": "#/components/schemas/last_modified_by_user_id" }, { "$ref": "#/components/schemas/ip_address" }, { "$ref": "#/components/schemas/imported_from_calendar_sync_master" }, { "$ref": "#/components/schemas/is_flat_rate_model" }, { "$ref": "#/components/schemas/rate_bands" } ] }, "rate_bands": { "properties": { "rate_bands": { "type": "array", "items": { "$ref": "#/components/schemas/rate_band" } } } }, "rate_band": { "allOf": [ { "$ref": "#/components/schemas/rate_band_id" }, { "$ref": "#/components/schemas/property_id" }, { "$ref": "#/components/schemas/date_from" }, { "$ref": "#/components/schemas/date_to" }, { "$ref": "#/components/schemas/us_rate" }, { "$ref": "#/components/schemas/rate_set_id" }, { "$ref": "#/components/schemas/minimum_nights_stay" }, { "$ref": "#/components/schemas/arrival_days" }, { "$ref": "#/components/schemas/floor_rate" }, { "$ref": "#/components/schemas/minimum_nightly_rate" }, { "$ref": "#/components/schemas/daily_rate" }, { "$ref": "#/components/schemas/monthly_rate" }, { "$ref": "#/components/schemas/departure_days" }, { "$ref": "#/components/schemas/season_name" }, { "$ref": "#/components/schemas/imported" }, { "$ref": "#/components/schemas/maximum_nights_stay" }, { "$ref": "#/components/schemas/last_modified_by_staff_user_id" }, { "$ref": "#/components/schemas/last_modified_by_user_id" }, { "$ref": "#/components/schemas/last_modified_by_ip_address" }, { "$ref": "#/components/schemas/ip_address" } ] }, "rate_band_id": { "properties": { "rate_band_id": { "type": "integer" } } }, "us_rate": { "properties": { "us_rate": { "type": "number", "multipleOf": 0.01 } } }, "minimum_nights_stay": { "properties": { "minimum_nights_stay": { "type": "integer" } } }, "floor_rate": { "properties": { "floor_rate": { "type": "number", "multipleOf": 0.01 } } }, "minimum_nightly_rate": { "properties": { "minimum_nightly_rate": { "type": "integer", "multipleOf": 0.01 } } }, "daily_rate": { "properties": { "daily_rate": { "type": "integer", "multipleOf": 0.01 } } }, "monthly_rate": { "properties": { "monthly_rate": { "type": "integer", "multipleOf": 0.01 } } }, "season_name": { "properties": { "season_name": { "type": "string" } } }, "departure_days": { "properties": { "departure_days": { "type": "integer" } } }, "imported": { "properties": { "imported": { "type": "string", "format": "date-time" } } }, "date_from": { "properties": { "date_from": { "type": "string", "format": "date-time" } } }, "date_to": { "properties": { "date_to": { "type": "string", "format": "date-time" } } }, "maximum_nights_stay": { "properties": { "maximum_nights_stay": { "type": "integer" } } }, "arrival_days": { "properties": { "arrival_days": { "type": "integer" } } }, "last_modified_by_ip_address": { "properties": { "last_modified_by_ip_address": { "type": "string" } } }, "set_name": { "properties": { "set_name": { "type": "string" } } }, "weekly_daily_monthly": { "properties": { "weekly_daily_monthly": { "type": "integer" } } }, "includes_tax": { "properties": { "includes_tax": { "type": "boolean" } } }, "days_in_month": { "properties": { "days_in_month": { "type": "integer" } } }, "based_on_arrival_date_band_only": { "properties": { "based_on_arrival_date_band_only": { "type": "boolean" } } }, "last_modified_by_staff_user_id": { "properties": { "last_modified_by_staff_user_id": { "type": "integer" } } }, "last_modified_by_user_id": { "properties": { "last_modified_by_user_id": { "type": "integer" } } }, "ip_address": { "properties": { "ip_address": { "type": "string" } } }, "imported_from_calendar_sync_master": { "properties": { "imported_from_calendar_sync_master": { "type": "boolean" } } }, "is_flat_rate_model": { "properties": { "is_flat_rate_model": { "type": "boolean" } } } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```