Vouchers
Get all vouchers
Returns all rate vouchers filtered by Service, voucher code or voucher identifier. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/vouchers/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. |
| required | Extent of data to be returned. Whether only specific voucher info should be returned or related items as well. | |
| array of string | required, max 1000 items | Unique identifiers of Services where the vouchers belong to. |
| array of string | optional, max 1000 items | Unique identifiers of vouchers. |
| array of string | optional, max 1000 items | Unique identifiers of the companies. |
| array of string | optional, max 1000 items | Value of voucher codes used by customers. |
| array of Activity state | optional | Whether to return only active, only deleted, or both types of record. If not specified, both active and deleted records will be returned. |
| optional, max length 3 months | ||
| array of string | optional, max 1000 items | Identifiers of Voucher from external systems. |
| required | Limitation on the quantity of data returned. |
Voucher Extent
Extent of data to be returned. Whether only specific voucher info should be returned or related items as well.
Property | Type | Contract | Description |
---|---|---|---|
| boolean | optional | Whether the response should contain main information about vouchers. |
| boolean | optional | Whether the response should contain assignments between vouchers and Rates. |
| boolean | optional | Whether the response should contain detail of assigned rates. |
|
|
|
|
|
|
|
|
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Voucher | optional | Details about vouchers added to the system. |
| array of Voucher code | optional | Information about voucher codes used by customers. |
| array of Voucher assignment | optional | The assignments between vouchers and Rates. |
| array of Rate | optional | The assigned rates. |
| array of Company | optional | The related companies and travel agencies. |
| 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. |
Voucher
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of voucher. |
| string | required | Unique identifier of Service the voucher belongs to. |
| string | required, max length 128 characters | Internal name of the voucher. |
| string | required | Creation date and time of the voucher in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the voucher in UTC timezone in ISO 8601 format. |
| required | Type of the voucher. | |
| string | optional | Unique identifier of Company the voucher is related to. |
| string | optional | Unique identifier of Company with Travel agency contract the voucher is related to. |
| string | optional | Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format (or null if the start time should not be updated). |
| string | optional | End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format (or null if the end time should not be updated). |
| string | optional, max length 255 characters | Identifier of the voucher from external system. |
| boolean | required | Whether the voucher is still active. |
|
|
|
Voucher Type
Public
PartnerCompany
TravelAgency
Voucher assignment
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of Voucher. |
| string | required | Unique identifier of Rate the voucher is assigned with. |
Add vouchers
Adds the specified vouchers to the specified Services. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/vouchers/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. |
| string | optional | Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise. |
| array of Voucher Parameters | required, max 1000 items | Vouchers to be added. |
Voucher Parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of Service. |
| string | required, max length 128 characters | Internal name of the voucher. |
| required | Type of the voucher. | |
| string | optional | Unique identifier of Company. |
| array of string | optional, max 5 items | Unique identifiers of Rates. |
| string | optional | Start of the interval in which the voucher can be applied. |
| string | optional | End of the interval in which the voucher can be applied. |
| string | optional, max length 255 characters | Identifier of the voucher from external system. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Voucher | optional | Details about vouchers added to the system. |
Update vouchers
Updates information about the specified vouchers. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/vouchers/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. |
| string | optional | Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise. |
| array of Vouchers update parameters | required, max 1000 items | Details of voucher updates. |
Vouchers update parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Voucher. |
| optional, max length 128 characters | Internal name of the voucher (or | |
| optional | Type of the voucher e.g. 'Public', 'PartnerCompany' or 'TravelAgency' (or | |
| optional | Unique identifier of Company (Company or Travel Agency) the voucher is related to. This is required for Type of | |
| optional, max length 5 characters | Unique identifiers of Rates (or | |
| optional | Start of the interval in which the voucher can be applied (or | |
| optional | End of the interval in which the voucher can be applied (or | |
| optional, max length 255 characters | Identifier of the voucher from external system (or |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Voucher | optional | Details about vouchers added to the system. |
Delete vouchers
Delete specified vouchers. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/vouchers/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. |
| string | optional | Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise. |
| array of string | required, max 1000 items | Unique identifiers of the vouchers to be deleted. |
Response
Last updated