Get a gift voucher's redemption rules
GET/v2/experiences/{experienceId}/retail-voucher-config
Requires your API key in the X-API-Key header.
Returns the redemption rules of your gift voucher product. Organizer only (403 otherwise).
Returns 400 (VOUCHER_EXPERIENCE_REQUIRED) when the experience is not a VOUCHER, and 404
when no rules have been set yet.
curl "https://api.turneo.co/v2/experiences/8e7d6c5b-4a39-4281-90ef-1a2b3c4d5e6f/retail-voucher-config" \
-H "X-API-Key: <your-api-key>"Path parameters
experienceIdstring (uuid)requiredUUID of the gift voucher product (an experience with
experienceTypeVOUCHER).- Example:
8e7d6c5b-4a39-4281-90ef-1a2b3c4d5e6f
Responses
200object
The voucher's redemption rules.
redemptionsPerUnitintegerHow many uses one voucher grants. One use covers one booking.
- Limits:
- minimum 1
- Example:
5
scopeExperienceIdsstring (uuid)[]The experiences the voucher can be redeemed against.
includesAddonbooleanWhether a redeemed booking may include one add-on of its option at no charge.
- Example:
false
{
"redemptionsPerUnit": 5,
"scopeExperienceIds": [
"0d4dbb2e-8a51-4a4b-9d3e-6f2b7c1a9e55"
],
"includesAddon": false
}Errors
- 400
Validation failed. Inspect
errors[].fieldanderrors[].code.- 401
Missing or invalid
X-API-Keyheader.- 403
The API key is valid but not allowed to perform this action on this resource.
- 404
The resource does not exist or belongs to another partner (existence is not leaked across partners).
Error body
typestringError class.
- Allowed values:
validation_errorclient_errorserver_error- Example:
validation_error
errorsobject[]Child fields
codestringMachine-readable error code.
- Example:
required
fieldstringnullableOffending field, or null/'general' for non-field errors.
- Example:
startTime
messagestringHuman-readable message.
- Example:
This field is required.
{
"type": "validation_error",
"errors": [
{
"code": "required",
"field": "startTime",
"message": "This field is required."
}
]
}