Get all voucher codes
POST /api/connector/v1/voucherCodes/getAll
Returns all voucher codes filtered by Voucher or other filter parameters. Note this operation uses Pagination and 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.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
Unique identifiers of the voucher codes.
Unique identifiers of vouchers.
Interval of voucher code’s last update date and time.
object
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "VoucherCodeIds": [ "8c364829-c7ae-4972-b67f-93ea704d7228", "dc9d3488-7fc4-4fc9-a524-14e6504d8734" ], "VoucherIds": [ "fe568bbd-1ecb-4bb2-bf77-96c3698de20d" ], "UpdatedUtc": { "StartUtc": "2023-10-10T00:00:00Z", "EndUtc": "2023-10-17T00:00:00Z" }, "Limitation": { "Count": 10 }}Responses
Section titled “ Responses ”OK
object
Information about voucher codes used by customers.
object
Unique identifier of the voucher code.
Unique identifier of Voucher the code belongs to.
Value of voucher code used by customers.
If specified, marks the beginning of interval in which the code can be used.
If specified, marks the end of interval in which the code can be used.
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.
Whether voucher code is active or deleted.
Whether the voucher code is still active.
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.
Example
{ "VoucherCodes": [ { "Id": "8c364829-c7ae-4972-b67f-93ea704d7228", "VoucherId": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d", "Value": "0E5856B0A73E62B7E446", "ValidityStartUtc": null, "ValidityEndUtc": null, "CreatedUtc": "2023-10-30T13:37:16Z", "UpdatedUtc": "2023-10-30T13:37:16Z", "ActivityState": "Active" }, { "Id": "dc9d3488-7fc4-4fc9-a524-14e6504d8734", "VoucherId": "fe568bbd-1ecb-4bb2-bf77-96c3698de20d", "Value": "021D047E42A5FD522CBA", "ValidityStartUtc": "2023-10-09T22:00:00Z", "ValidityEndUtc": "2023-10-09T22:00:00Z", "CreatedUtc": "2023-10-09T15:08:14Z", "UpdatedUtc": "2023-10-09T15:08:14Z", "ActivityState": "Active" } ]}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.