This API helps you to retrieve the list of gift card templates associated with the required center. You must specify the unique identifier of the center as center_id in the API request.
Response Model
GiftCardAmountTemplateList
Json property
Data type
Description
templates
array of objects (GiftCardAmountTemplate)
A collection of gift card amount templates.
templates object (GiftCardAmountTemplate)
Json property
Data type
Description
id
string (UUID)
Unique identifier of the gift card template.
name
string
Name of the gift card template.
description
string
Description of the template.
price
number (double)
Price at which the gift card is sold.
value
number (double)
Actual value of the gift card.
discounted_price
number (decimal)
Discounted price for the gift card.
validity
integer
Validity period of the gift card, in days.
expiry_date
string (ISO 8601 date-time)
Expiry date of the gift card.
is_amount
boolean
Indicates whether the template is amount-based.
confirmation_message
string
Message shown to confirm purchase or usage.
discount
number (decimal)
Discount applied to the gift card.
can_be_sold
boolean
Indicates whether the gift card can be sold.
price_model
object (PriceModelv1)
Price model details, including sales, tax, and final amount.
benefits
array of objects (BenefitDetails)
List of benefits included with the gift card.
one_time_use
boolean
Indicates whether the gift card can only be used once.
restrict_redemption_to_sale_center
boolean
Restricts redemption of the gift card to the sale center only.
benefits object (BenefitDetails)
Json property
Data type
Description
template_id
string (UUID)
Identifier of the associated template.
id
string (UUID)
Unique identifier of the benefit.
name
string
Name of the benefit.
catalog_name
string
Catalog name to which the benefit belongs.
type
enum (ItemType)
Type of benefit (service, product, package, etc.).
quantity
integer
Quantity of the benefit.
price
object (PriceModelv1)
Price details of the benefit.
total_price
number (decimal)
Total price for the specified quantity.
services
array of objects (ServiceModel)
Services included in the benefit.
price object (PriceModelv1)
Json property
Data type
Description
currency_id
integer
Identifier of the currency.
sales
number (decimal)
Sales amount before tax.
tax
number (decimal)
Tax amount applied.
final
number (decimal)
Final amount after tax.
ApiErrorModel
Json property
Data type
Description
code
integer
Error code for the API response.
message
string
Error message description.
Language
Credentials
Header
Click Try It! to start a request and see the response here!
