Add vouchers
POST /api/connector/v1/vouchers/add
Adds the specified vouchers to the specified Services. Note this operation supports Portfolio Access Tokens.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.
Vouchers to be added.
object
Unique identifier of Service.
Internal name of the voucher.
Type of the voucher.
Public
PartnerCompany
TravelAgency
Unique identifier of Company.
Unique identifiers of Rates.
Start of the interval in which the voucher can be applied.
End of the interval in which the voucher can be applied.
Identifier of the voucher from external system.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "VoucherParameters": [ { "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "Name": "Weekend Voucher", "Type": "Public", "CompanyId": null, "AssignedRateIds": [ "181f8cdd-04ee-4bf5-ba3e-44c108eca3cb", "8bebeddc-9137-432d-810c-1b998a90ac9a" ], "OccupiableIntervalStartUtc": null, "OccupiableIntervalEndUtc": null, "ExternalIdentifier": null }, { "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "Name": "Sample company voucher", "Type": "PartnerCompany", "CompanyId": "3506994b-3c0b-49ba-9f57-ac4700641440", "AssignedRateIds": [ "181f8cdd-04ee-4bf5-ba3e-44c108eca3cb", "8bebeddc-9137-432d-810c-1b998a90ac9a" ], "OccupiableIntervalStartUtc": "2023-12-31T22:00:00Z", "OccupiableIntervalEndUtc": "2024-01-01T22:00:00Z", "ExternalIdentifier": "VCHR-278" } ]}Responses
Section titled “ Responses ”OK
object
Details about vouchers added to the system.
object
Unique identifier of voucher.
Unique identifier of Service the voucher belongs to.
Internal name of the voucher.
Creation date and time of the voucher in UTC timezone in ISO 8601 format.
Last update date and time of the voucher in UTC timezone in ISO 8601 format.
Type of the voucher.
Public
PartnerCompany
TravelAgency
Unique identifier of Company the voucher is related to.
Unique identifier of Company with Travel agency contract the voucher is related to.
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).
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).
Identifier of the voucher from external system.
Whether the voucher is still active.
Example
{ "Vouchers": [ { "Id": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "Name": "Weekend Voucher", "CreatedUtc": "2023-12-01T08:17:05Z", "UpdatedUtc": "2023-12-02T13:38:49Z", "Type": "Public", "ActivityState": "Active", "CompanyId": null, "TravelAgencyId": null, "OccupiableIntervalStartUtc": null, "OccupiableIntervalEndUtc": null, "ExternalIdentifier": null }, { "Id": "f4a9942c-2616-4074-b1f4-4b959515e933", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "Name": "Sample company voucher", "CreatedUtc": "2023-12-01T08:17:05Z", "UpdatedUtc": "2023-12-02T13:38:49Z", "Type": "PartnerCompany", "ActivityState": "Active", "CompanyId": "3506994b-3c0b-49ba-9f57-ac4700641440", "TravelAgencyId": null, "OccupiableIntervalStartUtc": "2023-12-31T22:00:00Z", "OccupiableIntervalEndUtc": "2024-01-01T22:00:00Z", "ExternalIdentifier": "VCHR-278" } ]}Server has successfully fulfilled the request and there is no additional information to send back.
object
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).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
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.
object
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
object
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.
object
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.