Return Vouchers

Description

Returns the list of registered vouchers, which can be filtered by different criteria, such as ID, name, branch, and type. The query can also include pagination and filtering by validity, allowing you to obtain only the active and available vouchers in the system.

🔑 Query Parameters

Parameter	Type	Required	Description
idVoucher	int32	No	Filter by the specific ID of the voucher.
name	string	No	Filter by the name of the voucher.
idBranch	int32	Recommended	Filter by the branch number (only applicable for multi-location keys; ignored otherwise).
take	int32	No	Number of records to be returned (maximum 50). Default: 25.
skip	int32	No	Number of records to be ignored in the listing (pagination). Default: 0.
valid	boolean	No	Filter to return only valid vouchers (true) or invalid (false).
type	int32	No	Filter by the type of voucher, according to types defined in the system.

📤 Response Structure

The response returns the list of vouchers found based on the provided filters. Each voucher object includes information such as name, type, availability, applicable discounts, and expiration date.

Field	Type	Description
idVoucher	int32	Unique ID of the voucher.
nameVoucher	string	Name of the voucher.
typeVoucher	string	Type of the voucher (e.g., promotional, membership discount, service discount).
limited	boolean	Indicates if the voucher has limited use.
available	int32	Quantity available for use.
used	int32	Quantity already used.
expirationDate	string (date-time)	Expiration date and time of the voucher.
overdue	boolean	Indicates if the voucher is expired (`true`) or still valid (`false`).
siteAvailable	boolean	Indicates if the voucher is available for use on the site/app.
idMemberships	array<int32>	List of membership IDs to which the voucher applies.
monthyDiscount	object	Information about applicable monthly discount.
yearlyDiscount	object	Information about applicable annual discount.
serviceDiscount	object	Information about applicable service discount.

🧩 Structure of the `monthyDiscount` Object

Field	Type	Description
typeDiscountMembership	string	Type of membership discount (e.g., percentage, fixed amount).
value	number	Value of the discount.
numberMounths	int32	Number of months the discount will be applied

🧩 Structure of the `yearlyDiscount` Object

Field	Type	Description
typeDisocuntYearly	string	Type of annual discount (e.g., percentage, fixed amount).
value	number	Value of the discount.

🧩 Structure of the `serviceDiscount` Object

Field	Type	Description
typeDiscountService	string	Type of service discount (e.g., percentage, fixed amount).
value	number	Value of the discount.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

[
    {
        "idVoucher": 0,
        "nameVoucher": "string",
        "typeVoucher": "string",
        "limited": true,
        "available": 0,
        "used": 0,
        "expirationDate": "2019-08-24T14:15:22.123Z",
        "overdue": true,
        "siteAvailable": true,
        "idMemberships": [
            0
        ],
        "monthyDiscount": {
            "typeDiscountMembership": "string",
            "value": 0,
            "numberMounths": 0
        },
        "yearlyDiscount": {
            "typeDisocuntYearly": "string",
            "value": 0
        },
        "serviceDiscount": {
            "typeDiscountService": "string",
            "value": 0
        }
    }
]

🟠400Bad Request

Get vouchers

Return Vouchers#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 Structure of the monthyDiscount Object#

🧩 Structure of the yearlyDiscount Object#

🧩 Structure of the serviceDiscount Object#

Request