v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

List all templates

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.

get/v1/giftcards/templates?center_id={center_id}&giftcardtype={giftcardtype}&serviceOnly={serviceOnly}&fromOnline={fromOnline}&member_price={member_price}

Query parameters

center_idstring required

Mandatory Unique 32-character identifier of the center.

giftcardtypeinteger

Optional Indicates the type of gift card templates that you want displayed in the response: service-based or amount-based. If you specify giftcardtype = 0, the API will display all service-based gift card templates in the response. If you specify giftcardtype = 1, the API will display all amount-based gift card templates in the response. If you do not pass the giftcardtype parameter in the response, the API will retrieve only amount-based gift card templates (the default value is assumed to be 1 if the parameter is not passed).

serviceOnlyboolean

Whether to return only service-related templates

fromOnlineboolean

Whether the request is from online webstore

member_priceboolean

Whether to include member pricing information

guest_idinteger

Used to support member pricing when calling the API with an API key. This parameter should be included along with member_price set to true. This will return the applicable member price, based on the guest's active membership status, as discounted_price in the response object.

Response

200