YQueue DocsDevelopers

Schema

iglooX Quantity Redemption Option

Current fixed or percentage reward terms. Affordability is advisory; it does not reserve units or promise checkout eligibility.

  • iglooX Integration

Overview

object · 6 properties · 6 required

Properties

uuid

string Required

Submit this as redemption_option_uuid with the owning balance UUID. Refresh discovery if the selected option is no longer available.

Format uuid

description

string Required

A display description of the monetary benefit.

calculation

allOf Required

Only fixed-value and percentage monetary rewards are exposed. Unsupported calculations are omitted.

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 remaining discounted eligible sale amount required immediately before this reward.

Nullable Yes
One of

One of 1

null

One of 2

reference

References Money.

is_stackable

boolean Required

Every active voucher, stamp and point discount participating in checkout must allow stacking. Fully reversed and failed discounts do not participate.

is_affordable

boolean Required

Whether the current available pool covers the complete unit cost. This does not check the cart's minimum spend or stacking.

Used by

Raw YAML
Download source
title: iglooX Quantity Redemption Option
type: object
description: Current fixed or percentage reward terms. Affordability is advisory; it does not reserve units or promise checkout eligibility.
required:
  - uuid
  - description
  - calculation
  - minimum_eligible_spend
  - is_stackable
  - is_affordable
properties:
  uuid:
    type: string
    format: uuid
    description: Submit this as redemption_option_uuid with the owning balance UUID. Refresh discovery if the selected option is no longer available.
  description:
    type: string
    description: A display description of the monetary benefit.
  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'
    description: Only fixed-value and percentage monetary rewards are exposed. Unsupported calculations are omitted.
  minimum_eligible_spend:
    oneOf:
      - type: 'null'
      - $ref: ./Money.yaml
    description: The remaining discounted eligible sale amount required immediately before this reward.
  is_stackable:
    type: boolean
    description: Every active voucher, stamp and point discount participating in checkout must allow stacking. Fully reversed and failed discounts do not participate.
  is_affordable:
    type: boolean
    description: Whether the current available pool covers the complete unit cost. This does not check the cart's minimum spend or stacking.
x-tags:
  - iglooX Integration

Search documentation

Search across this documentation site.