Skip to content
Mews Open API

Update routing rules

POST
/api/connector/v1/routingRules/update

Updates routing rules.

Request Body

Section titled “Request Body ”
MultipleRoutingRuleUpdateParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
RoutingRuleUpdates
required

Collection of Routing rules to be updated.

Array<object>
>= 1 items <= 1000 items
RoutingRuleUpdateParameters
object
RoutingRuleId
required
string format: uuid
CompanyId
Guid update value
object
Value

Value which is to be updated.

string format: uuid
ServiceId
Guid update value
object
Value

Value which is to be updated.

string format: uuid
CompanyRelation
Any of:
string
Allowed values: PartnerCompany TravelAgency
Applicability
Any of:
string
Allowed values: Always PrepaidOnly
RouteType
Any of:
string
Allowed values: AllStayItems SelectedStayItems
AssignmentTargetType
Any of:
string
Allowed values: AllStayItems SelectedStayItems
SelectedStayItems
RoutingRuleStayItemsUpdateParameters
object
Nights
Boolean update value
object
Value

Value which is to be updated.

boolean
CityTax
Boolean update value
object
Value

Value which is to be updated.

boolean
ProductCategoryIds
Guid array update value
object
Value

Value which is to be updated.

Array<string>
nullable
Example
{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "RoutingRuleUpdates": [
    {
      "RoutingRuleId": "ff785b22-5422-4d1d-87f4-af2e00b3dfda",
      "CompanyId": {
        "Value": "35f493d1-6cf7-4132-982a-a5540549c322"
      },
      "CompanyRelation": {
        "Value": "PartnerCompany"
      },
      "ServiceId": {
        "Value": "708b3509-69ad-4a92-841b-d81f103edcee"
      },
      "Applicability": {
        "Value": "Always"
      },
      "RouteType": {
        "Value": "AllStayItems"
      }
    },
    {
      "RoutingRuleId": "d98c9611-0006-4691-a835-af2e00b170c4",
      "CompanyId": {
        "Value": "73a1fc8e-11c5-4019-b296-9234b651fc68"
      },
      "CompanyRelation": {
        "Value": "TravelAgency"
      },
      "ServiceId": {
        "Value": "708b3509-69ad-4a92-841b-d81f103edcee"
      },
      "Applicability": {
        "Value": "Always"
      },
      "RouteType": {
        "Value": "SelectedStayItems"
      },
      "SelectedStayItems": {
        "Nights": {
          "Value": false
        },
        "CityTax": {
          "Value": true
        },
        "ProductCategoryIds": {
          "Value": [
            "004fa262-7b08-4853-b544-af2a00d5cf1f"
          ]
        }
      }
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

RoutingRuleResult
object
RoutingRules
required

Collection of Routing rules.

Array<object>
<= 1000 items
Routing rule
object
Id
required

Unique identifier of the routing rule.

string format: uuid
EnterpriseId
required

Unique identifier of the Enterprise.

string format: uuid
CompanyId
required

Unique identifier of the Company routing rule is assigned to.

string format: uuid
CompanyRelation
required
string
Allowed values: PartnerCompany TravelAgency
Applicability
required
string
Allowed values: Always PrepaidOnly
RouteType
required
string
Allowed values: AllStayItems SelectedStayItems
ServiceId

Unique identifier of the Service routing rule is assigned to.

string format: uuid
nullable
SelectedStayItems
RoutingRuleStayItems

Specific items to which the routing rule applies. Returns only if RouteType value is SelectedStayItems.

object
Nights
boolean
CityTax
boolean
ProductCategoryIds
Array<string>
nullable
CreatedUtc
required

Creation date and time of the routing rule in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the routing rule in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
Cursor

Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.

string format: uuid
nullable
Example
{
  "RoutingRules": [
    {
      "Id": "ff785b22-5422-4d1d-87f4-af2e00b3dfda",
      "CompanyId": "35f493d1-6cf7-4132-982a-a5540549c322",
      "CompanyRelation": "PartnerCompany",
      "ServiceId": "708b3509-69ad-4a92-841b-d81f103edcee",
      "Applicability": "Always",
      "RouteType": "AllStayItems",
      "CreatedUtc": "2023-10-01T11:48:57Z",
      "UpdatedUtc": "2023-10-28T11:48:57Z"
    },
    {
      "Id": "d98c9611-0006-4691-a835-af2e00b170c4",
      "CompanyId": "73a1fc8e-11c5-4019-b296-9234b651fc68",
      "CompanyRelation": "TravelAgency",
      "ServiceId": "708b3509-69ad-4a92-841b-d81f103edcee",
      "Applicability": "Always",
      "RouteType": "SelectedStayItems",
      "CreatedUtc": "2023-10-01T11:48:57Z",
      "UpdatedUtc": "2023-10-28T11:48:57Z",
      "SelectedStayItems": {
        "Nights": false,
        "CityTax": true,
        "ProductCategoryIds": [
          "004fa262-7b08-4853-b544-af2a00d5cf1f"
        ]
      }
    }
  ]
}

204

Section titled “204 ”

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

400

Section titled “400 ”

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

401

Section titled “401 ”

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

403

Section titled “403 ”

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

408

Section titled “408 ”

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

429

Section titled “429 ”

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

500

Section titled “500 ”

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable