> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.littglobal.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.littglobal.com/_mcp/server. # Get Vouchers List POST TBD/api/v2/gifts/vouchers-list Grants quick access to a list of available vouchers based on country and state IDs in the request. The response incorporates distinct categories of vouchers and details about each one. These details include voucher and merchant identifiers, descriptions, redemption locations, validity periods, and their respective balance options. ### Request Body - `country_id` (string): Specifies the country ID for filtering the voucher list. - `state_id` (string): Denotes the state ID for further request customization. Can be empty. ### Response - `categories` (array): Holds unique categories within the available voucher list. - `vouchers` (array): Provides a compilation of vouchers, along with detailed data such as: - `voucher_id` (string): Uniquely identifies vouchers. - `merchant_id` (string): Correlates vouchers with specific merchants. - `image_id` (string): Supplies a unique identifier for voucher-related graphics. - `barcode_batch_id` (string): Connects to batch-processed barcode data. - `voucher_category_id` (string): Assists with voucher categorization. - `country_id` (integer): Points to the country where voucher application is valid. - `currency_id` (integer): Cites the applicable currency type. - `zone_id` (integer): Specifies a zone for voucher restriction or allowance. - `city_id` (integer): Defines a city for further voucher application limitations. - `name` (string): Official name of the voucher. - `description` (string): Offers specific details about the voucher. - `balance_options` (string): Gives potential balance options for voucher recipients. - `is_universal` (integer): Informs whether voucher is applicable across all geographic locations. - `bonus_amount` (string): Indicates possible bonus amounts associated with the voucher. - `bonus_percent` (string): Gives probable bonus percentages linked to the voucher. - `total_bonus_available` (string): States the total available bonus amount for voucher. - `total_bonus_remaining` (string): Shares remaining bonus amount after voucher usage. - `status` (string): Shares status of the voucher—likely "approved" or "pending". - `validity_period` (integer): Time (likely in days) for which the voucher is valid. - `url` (string): URL to be used for redeeming the voucher. - `created_at` (string): Specifies voucher creation timestamp. - `updated_at` (string): Specifies the most recent update timestamp for the voucher. - `category_name` (string): Legible name for the category associated with the voucher. - `category_id` (string): Identifier for the category associated with the voucher. - `country_name` (string): Name of the country where voucher is valid. - `city_name` (string): Name of the city where the voucher is valid. - `image_url` (string): URL of voucher infographics. - `converted_balance_options` (array): Converted values of balance options. - `full_address` (string): Complete geographical specifications for voucher redemption. - `currency` (json): Compiles standard currency parameters. - `merchant` (json): Assembles merchant-specific data. - `state_id` (integer): Provides a state ID for voucher application. - `state_code` (string): Lists a short code for the state of voucher application. Reference: https://docs.littglobal.com/litt-white-label/api-reference/gift-card-promotion/get-vouchers-list ## Request ### Query parameters - `api_token` (string, optional) ## Response ### 200 Get Vouchers List - `message` (string, optional) - `api` (string, optional) - `status` (string, optional) - `data` (ApiV2GiftsVouchersListPostResponsesContentApplicationJsonSchemaData, optional) ## Types ### ApiV2GiftsVouchersListPostResponsesContentApplicationJsonSchemaData - `categories` (list of string, optional) - `vouchers` (list of ApiV2GiftsVouchersListPostResponsesContentApplicationJsonSchemaDataVouchersItems, optional) ### ApiV2GiftsVouchersListPostResponsesContentApplicationJsonSchemaDataVouchersItems - `voucher_id` (string, optional) - `merchant_id` (string, optional) - `image_id` (string, optional) - `barcode_batch_id` (any, optional, nullable) - `voucher_category_id` (string, optional) - `country_id` (integer, optional) - `currency_id` (integer, optional) - `zone_id` (integer, optional) - `city_id` (integer, optional) - `name` (string, optional) - `description` (string, optional) - `balance_options` (string, optional) - `is_universal` (integer, optional) - `bonus_amount` (string, optional) - `bonus_percent` (string, optional) - `total_bonus_available` (string, optional) - `total_bonus_remaining` (string, optional) - `status` (string, optional) - `validity_period` (integer, optional) - `url` (string, optional) - `created_at` (string, optional) - `updated_at` (string, optional) - `category_name` (string, optional) - `category_id` (string, optional) - `country_name` (string, optional) - `city_name` (string, optional) - `image_url` (string, optional) - `converted_balance_options` (list of ApiV2GiftsVouchersListPostResponsesContentApplicationJsonSchemaDataVouchersItemsConvertedBalanceOptionsItems, optional) - `full_address` (string, optional) - `currency` (ApiV2GiftsVouchersListPostResponsesContentApplicationJsonSchemaDataVouchersItemsCurrency, optional) - `merchant` (ApiV2GiftsVouchersListPostResponsesContentApplicationJsonSchemaDataVouchersItemsMerchant, optional) - `state_id` (integer, optional) - `state_code` (string, optional) ### ApiV2GiftsVouchersListPostResponsesContentApplicationJsonSchemaDataVouchersItemsConvertedBalanceOptionsItems - `balance` (string, optional) - `bonus` (string, optional) - `symbol` (string, optional) - `converted_balance` (string, optional) - `converted_symbol` (string, optional) - `base_currency_balance` (string, optional) ### ApiV2GiftsVouchersListPostResponsesContentApplicationJsonSchemaDataVouchersItemsCurrency - `id` (integer, optional) - `name` (string, optional) - `code` (string, optional) - `code_symbol` (string, optional) - `exchange_rate` (double, optional) - `decimal_digits` (integer, optional) - `rounding` (integer, optional) - `status` (integer, optional) - `is_base_currency` (boolean, optional) ### ApiV2GiftsVouchersListPostResponsesContentApplicationJsonSchemaDataVouchersItemsMerchant - `username` (string, optional) - `name` (string, optional) ## Examples **Response** ```json { "message": "Successfully retrieved vouchers list.", "api": "vouchersList", "status": "success", "data": { "categories": [ "All categories", "Grocery Stores" ], "vouchers": [ { "voucher_id": "e1089e3-10f1-4b2b-bfcb-3ea48e515f9e", "merchant_id": "e2cd56d0-7865-4509-8a72-23a1a2d9b73e", "image_id": "23146c74-75a1-405a-acda-e9449df5fb23", "barcode_batch_id": null, "voucher_category_id": "57c7c420bd12x", "country_id": 14, "currency_id": 1, "zone_id": 0, "city_id": 4952, "name": "Tango Mart Gift Card", "description": "The Tango Mart gift card can be used at any of our Tango Mart store locations or online.\n\nRedeemable with the LITT Visa debit card.\n", "balance_options": "10, 50, 100", "is_universal": 0, "bonus_amount": "0.00", "bonus_percent": "0.00", "total_bonus_available": "0.00", "total_bonus_remaining": "0.00", "status": "approved", "validity_period": 1095, "url": "", "created_at": "2024-04-19 04:16:47", "updated_at": "2024-04-19 04:17:01", "category_name": "Grocery Stores", "category_id": "57c7c420bd12x", "country_name": "Australia", "city_name": "Dawesville", "image_url": "https://litt-ap-southeast-2-dev.s3-accelerate.amazonaws.com/1353513e-28db-4c21-b022-3126cc25c830/image/c1aef516-224a-4eae-bca6-c792f6b5d43b.jpg", "converted_balance_options": [ { "balance": "10.00", "bonus": "0.00", "symbol": "A$", "converted_balance": "10.00", "converted_symbol": "A$", "base_currency_balance": "10.00" }, { "balance": "50.00", "bonus": "0.00", "symbol": "A$", "converted_balance": "50.00", "converted_symbol": "A$", "base_currency_balance": "50.00" }, { "balance": "100.00", "bonus": "0.00", "symbol": "A$", "converted_balance": "100.00", "converted_symbol": "A$", "base_currency_balance": "100.00" } ], "full_address": "71 Dandaragan Drive, Dawesville, 6211, WA, Australia", "currency": { "id": 1, "name": "Australian Dollar", "code": "AUD", "code_symbol": "A$", "exchange_rate": 1.000001, "decimal_digits": 2, "rounding": 0, "status": 1, "is_base_currency": true }, "merchant": { "username": "tmdawesville", "name": "Tango Mart" }, "state_id": 3906, "state_code": "WA" } ] } } ``` **SDK Code** ```python Gift Card & Promotion_getVouchersList_example import requests url = "https://tbd/api/v2/gifts/vouchers-list" querystring = {"api_token":"{{token}}"} response = requests.post(url, params=querystring) print(response.json()) ``` ```javascript Gift Card & Promotion_getVouchersList_example const url = 'https://tbd/api/v2/gifts/vouchers-list?api_token=%7B%7Btoken%7D%7D'; const options = {method: 'POST'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Gift Card & Promotion_getVouchersList_example package main import ( "fmt" "net/http" "io" ) func main() { url := "https://tbd/api/v2/gifts/vouchers-list?api_token=%7B%7Btoken%7D%7D" req, _ := http.NewRequest("POST", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Gift Card & Promotion_getVouchersList_example require 'uri' require 'net/http' url = URI("https://tbd/api/v2/gifts/vouchers-list?api_token=%7B%7Btoken%7D%7D") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) response = http.request(request) puts response.read_body ``` ```java Gift Card & Promotion_getVouchersList_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://tbd/api/v2/gifts/vouchers-list?api_token=%7B%7Btoken%7D%7D") .asString(); ``` ```php Gift Card & Promotion_getVouchersList_example request('POST', 'https://tbd/api/v2/gifts/vouchers-list?api_token=%7B%7Btoken%7D%7D'); echo $response->getBody(); ``` ```csharp Gift Card & Promotion_getVouchersList_example using RestSharp; var client = new RestClient("https://tbd/api/v2/gifts/vouchers-list?api_token=%7B%7Btoken%7D%7D"); var request = new RestRequest(Method.POST); IRestResponse response = client.Execute(request); ``` ```swift Gift Card & Promotion_getVouchersList_example import Foundation let request = NSMutableURLRequest(url: NSURL(string: "https://tbd/api/v2/gifts/vouchers-list?api_token=%7B%7Btoken%7D%7D")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```