Schema
iglooX Quantity Exchange Option
Current exchange discovery metadata. Only destinations with fixed or percentage voucher benefits are exposed; checkout exchange is not implemented in these YQ APIs.
Overview
Properties
uuid
string
Required
Format
uuid
quantity_cost
integer
Required
Whole stamps or points required; this exchange field uses quantity_cost for both mechanics.
Minimum
1
voucher_program_uuid
string
Required
Format
uuid
voucher_program
object
Required
Nested properties
uuid
string
Required
Format
uuid
name
string
Required
currency_code
string
Required
outlet_uuids
array
Required
Voucher redemption outlets; an empty list permits all merchant outlets.
Array items
Items
string
Format
uuid
voucher_configuration
object
Required
Nested properties
calculation
allOf
Required
All of
All of 1
reference
References Calculation.
All of 2
object
Nested properties
type
string
Required
Allowed values
fixedpercentageprice_override
null
Required
minimum_eligible_spend
oneOf
Required
Nullable
Yes
One of
One of 1
null
One of 2
reference
References Money.
validity_period_in_days
integer | null
Required
Minimum
1
Nullable
Yes
fixed_usable_from
string | null
Required
Format
date-time
Nullable
Yes
fixed_expires_at
string | null
Required
Format
date-time
Nullable
Yes
is_stackable
boolean
Required
total_issuance_limit
integer | null
Required
Minimum
1
Nullable
Yes
customer_issuance_limit
integer | null
Required
Minimum
1
Nullable
Yes
is_affordable
boolean
Required
Advisory affordability based on current available units; destination eligibility and capacity are separate conditions.
Used by
Raw YAML
Download source
title: iglooX Quantity Exchange Option
type: object
description: Current exchange discovery metadata. Only destinations with fixed or percentage voucher benefits are exposed; checkout exchange is not implemented in these YQ APIs.
required: [uuid, quantity_cost, voucher_program_uuid, voucher_program, is_affordable]
properties:
uuid:
type: string
format: uuid
quantity_cost:
type: integer
minimum: 1
description: Whole stamps or points required; this exchange field uses quantity_cost for both mechanics.
voucher_program_uuid:
type: string
format: uuid
voucher_program:
type: object
required: [uuid, name, currency_code, outlet_uuids, voucher_configuration]
properties:
uuid:
type: string
format: uuid
name:
type: string
currency_code:
type: string
outlet_uuids:
type: array
description: Voucher redemption outlets; an empty list permits all merchant outlets.
items:
type: string
format: uuid
voucher_configuration:
type: object
required: [calculation, minimum_eligible_spend, validity_period_in_days, fixed_usable_from, fixed_expires_at, is_stackable, total_issuance_limit, customer_issuance_limit]
properties:
calculation:
allOf:
- $ref: ./Calculation.yaml
- type: object
required: [type, fixed_value, percentage, percentage_cap, price_override]
properties:
type:
type: string
enum: [fixed, percentage]
price_override:
type: 'null'
minimum_eligible_spend:
oneOf:
- type: 'null'
- $ref: ./Money.yaml
validity_period_in_days:
type: [integer, 'null']
minimum: 1
fixed_usable_from:
type: [string, 'null']
format: date-time
fixed_expires_at:
type: [string, 'null']
format: date-time
is_stackable:
type: boolean
total_issuance_limit:
type: [integer, 'null']
minimum: 1
customer_issuance_limit:
type: [integer, 'null']
minimum: 1
is_affordable:
type: boolean
description: Advisory affordability based on current available units; destination eligibility and capacity are separate conditions.
x-tags:
- iglooX Integration