YQueue DocsDevelopers

Schema

iglooX Voucher Balance

A customer-owned voucher balance available at the associated iglooX outlet, including voucher quantities, validity and redemption terms.

  • iglooX Integration

Overview

object · 9 properties · 9 required

Properties

uuid

string Required

The customer voucher-balance UUID. Redeeming this balance consumes one voucher.

Format uuid

name

string Required

The current program display name.

Min length 1
Max length 255

balance

integer Required

The number of vouchers held in this balance.

Minimum 0

available_balance

integer Required

The number of vouchers currently available for redemption.

Minimum 0

state

string Required

Allowed values

availableinsufficient_balanceexpirednot_yet_usablearchived

is_usable

boolean Required

Whether the balance is currently usable. Eligibility and savings for a particular order are checked separately.

usable_from

string Required
Format date-time

expires_at

string Required
Format date-time

terms

object Required
Nested properties

calculation

allOf Required

The fixed or percentage benefit saved when the voucher was issued. Later program edits do not replace this benefit.

All of
All of 1
reference

References Calculation.

All of 2
object
Nested properties
type
string Required

Allowed values

fixedpercentage
price_override
null Required

minimum_eligible_spend

oneOf Required

The minimum remaining discounted eligible sale amount currently required immediately before redeeming one voucher.

Nullable Yes
One of
One of 1
null
One of 2
reference

References Money.

is_stackable

boolean Required

The current program stacking rule. Each successful payment records the rule that applied to that redemption.

Used by

Raw YAML
Download source
title: iglooX Voucher Balance
type: object
description: A customer-owned voucher balance available at the associated iglooX outlet, including voucher quantities, validity and redemption terms.
required:
  - uuid
  - name
  - balance
  - available_balance
  - state
  - is_usable
  - usable_from
  - expires_at
  - terms
properties:
  uuid:
    type: string
    format: uuid
    description: The customer voucher-balance UUID. Redeeming this balance consumes one voucher.
  name:
    type: string
    minLength: 1
    maxLength: 255
    description: The current program display name.
  balance:
    type: integer
    minimum: 0
    description: The number of vouchers held in this balance.
  available_balance:
    type: integer
    minimum: 0
    description: The number of vouchers currently available for redemption.
  state:
    type: string
    enum:
      - available
      - insufficient_balance
      - expired
      - not_yet_usable
      - archived
  is_usable:
    type: boolean
    description: Whether the balance is currently usable. Eligibility and savings for a particular order are checked separately.
  usable_from:
    type: string
    format: date-time
  expires_at:
    type: string
    format: date-time
  terms:
    type: object
    required:
      - calculation
      - minimum_eligible_spend
      - is_stackable
    properties:
      calculation:
        description: The fixed or percentage benefit saved when the voucher was issued. Later program edits do not replace this benefit.
        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
        description: The minimum remaining discounted eligible sale amount currently required immediately before redeeming one voucher.
      is_stackable:
        type: boolean
        description: The current program stacking rule. Each successful payment records the rule that applied to that redemption.
x-tags:
  - iglooX Integration

Search documentation

Search across this documentation site.