YQueue DocsDevelopers

Schema

iglooX Quantity Balance

Shared stamp and point pool fields. The containing stamps or points collection identifies the mechanic. Balance and reward costs are whole units, not currency amounts. Empty, expired and archived pools remain visible.

  • iglooX Integration

Overview

object · 12 properties · 12 required

Properties

uuid

string Required

The customer balance UUID used for redemption.

Format uuid

loyalty_program_uuid

string Required
Format uuid

name

string Required

The current program name.

earning_mode

string Required

All three earning modes support monetary reward options.

Allowed values

orderspend_intervalproduct_quantity

currency_code

string Required

The currency used by monetary reward benefits; pool quantities are not Money.

balance

integer Required

Recorded whole units, including units that cannot currently be spent.

Minimum 0

available_balance

integer Required

Available whole units; zero for unusable pools. A positive value does not guarantee affordability of an option.

Minimum 0

state

string Required

Allowed values

availableinsufficient_balanceexpirednot_yet_usablearchived

is_usable

boolean Required

Baseline pool usability; option eligibility, affordability and checkout stacking are checked separately.

exchange_options

array Required

Current monetary voucher exchange descriptions. YQ-Platform does not expose a checkout exchange action.

Array items

Items

reference

References iglooX Quantity Exchange Option.

usable_from

string Required
Format date-time

expires_at

string | null Required
Format date-time
Nullable Yes

Used by

Raw YAML
Download source
title: iglooX Quantity Balance
type: object
description: >-
  Shared stamp and point pool fields. The containing stamps or points collection identifies the mechanic.
  Balance and reward costs are whole units, not currency amounts. Empty, expired and archived pools remain visible.
required:
  - uuid
  - loyalty_program_uuid
  - name
  - earning_mode
  - currency_code
  - balance
  - available_balance
  - state
  - is_usable
  - exchange_options
  - usable_from
  - expires_at
properties:
  uuid:
    type: string
    format: uuid
    description: The customer balance UUID used for redemption.
  loyalty_program_uuid:
    type: string
    format: uuid
  name:
    type: string
    description: The current program name.
  earning_mode:
    type: string
    enum: [order, spend_interval, product_quantity]
    description: All three earning modes support monetary reward options.
  currency_code:
    type: string
    description: The currency used by monetary reward benefits; pool quantities are not Money.
  balance:
    type: integer
    minimum: 0
    description: Recorded whole units, including units that cannot currently be spent.
  available_balance:
    type: integer
    minimum: 0
    description: Available whole units; zero for unusable pools. A positive value does not guarantee affordability of an option.
  state:
    type: string
    enum: [available, insufficient_balance, expired, not_yet_usable, archived]
  is_usable:
    type: boolean
    description: Baseline pool usability; option eligibility, affordability and checkout stacking are checked separately.
  exchange_options:
    type: array
    description: Current monetary voucher exchange descriptions. YQ-Platform does not expose a checkout exchange action.
    items:
      $ref: ./IglooxQuantityExchangeOption.yaml
  usable_from:
    type: string
    format: date-time
  expires_at:
    type: [string, 'null']
    format: date-time
x-tags:
  - iglooX Integration

Search documentation

Search across this documentation site.