Routing rules
Get all routing rules
Returns all routing rules. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/routingRules/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| 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. |
| array of string | required, max 1000 items | Unique identifier of the Routing rule. |
| array of string | required, max 1000 items | Unique identifier of the Company. |
| optional, max length 3 months | Interval in which Routing rule was updated. | |
| required | Limitation on the quantity of data returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Routing rules | required | Collection of routing rules. |
| string | optional | 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. |
Routing rule
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the routing rule. |
| string | required | Unique identifier of the Enterprise. |
| string | required | Unique identifier of the Company routing rule is assigned to. |
| string Company relation | required | Relation of the company to the routing rule. |
| string Applicability | required | Determines if routing rule applies to all future reservations with this company or travel agency, or only future reservations that are prepaid. |
| string | required | Unique identifier of the Service routing rule is assigned to. |
| string Route type | required | Determines to which stay items the routing rule applies. |
| string | required | Creation date and time of the routing rule in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the routing rule in UTC timezone in ISO 8601 format. |
| optional | Specific items to which the routing rule applies. Returns only if RouteType value is SelectedStayItems. |
Company relation
PartnerCompany
TravelAgency
...
Applicability
Always
PrepaidOnly
...
Route type
AllStayItems
SelectedStayItems
...
Selected stay items
Property | Type | Contract | Description |
---|---|---|---|
| boolean | required | Whether routing rule applies to nights. |
| boolean | required | Whether routing rule applies to city tax. |
| array of string | optional | Product categories to which routing rule applies. |
Add routing rules
Adds a new routing rules.
Request
[PlatformAddress]/api/connector/v1/routingRules/add
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of Routing rule parameters | required, max 1000 items | Collection of Routing rules to be added. |
Routing rule parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Company routing rule is assigned to. |
| string Company relation | required | Relation of the company to the routing rule. |
| string Applicability | required | Determines if routing rule applies to all future reservations with this company or travel agency attached or only future reservations that are prepaid in online travel agency (OTA). |
| string | required | Unique identifier of the Service routing rule is assigned to. |
| string Route type | required | What should be routed. |
| optional | To which stay items routing rule applies to. Required only if RouteType value is |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Routing rules | required | Routing rules. |
Update routing rules
Updates routing rules.
Request
[PlatformAddress]/api/connector/v1/routingRules/update
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of Routing rule update parameters | required, max 1000 items | Collection of Routing rules to be updated. |
Routing rule update parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the routing rule. |
| optional | Unique identifier of the Company (or | |
| optional | Company relation to the routing rule (or | |
| required | Unique identifier of the Service routing rule is assigned to (or | |
| required | Applicability that determines if routing rule apply to all future reservations with this company or travel agency attached or only future reservations that are prepaid in online travel agency (OTA) (or | |
| required | What should be routed Route type (or | |
| optional | To which stay items routing rule applies to. Required only if RouteType value is SelectedStayItems. |
String array update value
Property | Type | Contract | Description |
---|---|---|---|
| array of string | optional | Value which is to be updated. |
Selected stay items update parameters
Property | Type | Contract | Description |
---|---|---|---|
| optional | Whether routing rule applies to nights (or | |
| optional | Whether routing rule applies to city tax (or | |
| optional | Product categories to which the routing rule applies (or |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Routing rules | required | Collection of Routing rules. |
Delete routing rules
Deletes routing rules.
Request
[PlatformAddress]/api/connector/v1/routingRules/delete
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | required, max 1000 items | Unique identifiers of the routing rules to be deleted. |
Response
Last updated