Q3
  • Introduction
  • Related Projects
  • Roadmap
  • API
    • Core
      • Rest
      • Session
      • Schema plugins
    • Schemas
      • Rates
      • Rebates
      • Permissions
    • Utils
      • Subdocuments
      • Soft deleting
  • Client
    • gatsby-theme-q3
    • q3-components
      • Quantity
    • q3-ui-cart
      • Drawer
    • Admin
      • Builders
      • Containers
        • Contexts
    • Datatables
      • TableBadge
    • Forms
      • Field
      • Presets
        • <PasswordChange />
    • Repeater
    • UI
      • CallToAction
      • Avatar
      • CollapsiblePanel
      • SubMenu
Powered by GitBook
On this page

Was this helpful?

  1. API
  2. Schemas

Rebates

Instant rebates/coupon schema with evaluation and query decorators

Property

Description

Type

name

A user-friendly name for the rebate

string*

description

An expanded description of the rebate

string*

couponCode

A unique identifier for users to lookup rebates

string

value

A positive number that is used to generate a monetary value

number*

symbol

A character that defines how the value calculates an output (either $ for dollar-off, % for percent-off or = to apply a fixed price)

string*

tiers

See schema below

TierSchema

maximumPerOrder

The maximum number of this rebate a user can order per instance

number

maximumPerHistory

The maximum number of this rebate a user can order ever

number

maximumPerProduct

The maximum number of this rebate for a specific product line

number

requiredSkus

An array of SKUs that will determine the eligibility of a rebate and derive value from

array [string]

conditionalSkus

An array of conditional SKUs that must be present but do not affect value

array [string]

conditionalSkuThreshold

The combined quantity of conditional SKUs that must be met to unlock this rebate

number

Tiers Schema

Property

Description

Type

value

A new value to use with parent symbol

number

quantity

The quantity at which the new value is unlocked

number

PreviousRatesNextPermissions

Last updated 5 years ago

Was this helpful?