Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • Get all rate groups
  • Request
  • Response

Was this helpful?

  1. API Operations

Rate groups

PreviousRatesNextReservations

Last updated 4 months ago

Was this helpful?

Get all rate groups

Returns all rate groups, filtered by unique identifiers and other filters. Note this operation uses and supports .

Request

[PlatformAddress]/api/connector/v1/rateGroups/getAll

{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "RateGroupIds": [
    "6b3f718a-b537-45b0-a8ee-d30897723834"
  ],
  "ServiceIds": [
    "bd26d8db-86da-4f96-9efc-e5a4654a4a94"
  ],
  "ExternalIdentifiers": [
    "RG-001"
  ],
  "UpdatedUtc": {
    "StartUtc": "2024-01-27T11:48:57Z",
    "EndUtc": "2024-02-27T11:48:57Z"
  },
  "ActivityStates": [
    "Active"
  ],
  "EnterpriseIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "4d0201db-36f5-428b-8d11-4f0a65e960cc"
  ],
  "Limitation": {
    "Count": 1000,
    "Cursor": "e7f26210-10e7-462e-9da8-ae8300be8ab7"
  }
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

EnterpriseIds

array of string

optional, max 1000 items

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

RateGroupIds

array of string

optional, max 1000 items

ServiceIds

array of string

optional, max 1000 items

ExternalIdentifiers

array of string

optional, max 1000 items

UpdatedUtc

optional, max length 3 months

ActivityStates

optional

Whether to return only active, only deleted or both records.

Limitation

required

Limitation on the quantity of data returned and optional Cursor for the starting point of data.

Response

{
  "RateGroups": [
    {
      "Id": "6b3f718a-b537-45b0-a8ee-d30897723834",
      "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
      "IsActive": true,
      "CreatedUtc": "2023-01-11T13:32:32Z",
      "UpdatedUtc": "2023-01-13T15:27:28Z",
      "Ordering": 0,
      "Names": {
        "en-US": "Default group"
      },
      "ShortNames": {
        "en-US": "Default group"
      },
      "Descriptions": {
        "en-US": "Default group"
      },
      "ExternalIdentifier": "RG-001"
    }
  ],
  "Cursor": "6b3f718a-b537-45b0-a8ee-d30897723834"
}
Property
Type
Contract
Description

RateGroups

required, max 1000 items

The filtered rate groups.

Cursor

string

optional

Rate Group

Property
Type
Contract
Description

Id

string

required

Unique identifier of the rate group.

ServiceId

string

required

IsActive

boolean

required

Whether the rate group is still active.

CreatedUtc

string

required

Creation date and time of the rate group in UTC timezone in ISO 8601 format.

UpdatedUtc

string

required

Last update date and time of the rate group in UTC timezone in ISO 8601 format.

Ordering

integer

required

Ordering of the rate group.

Names

required

All translations of the name.

ShortNames

optional

All translations of the short name.

Descriptions

optional

All translations of the description.

ExternalIdentifier

string

optional, max length 255 characters

Identifier of the rate group from external system.

Unique identifiers of the . Required if ServiceIds filter is not provided.

Unique identifiers of the . Required if RateGroupIds filter is not provided.

Identifiers of from external systems.

array of

array of

Unique identifier of the last and hence oldest rate group returned. This can be used in in a subsequent request to fetch the next batch of older rate groups.

Unique identifier of the the rate group belongs to.

Pagination
Portfolio Access Tokens
Rate group
Rate group
Rate Group
Limitation
Limitation
Service
Service
Time interval
Activity state
Localized text
Localized text
Localized text