Skip to content

OrderCalc Promo Platform Overview

The promo platform lets you define promotion rules once and reuse them. Qualifications, limits, and rewards come built in, and developers can add custom ones to your company app. Promo administrators combine them into promos with schedules and codes, and OrderCalc evaluates the active promos for each order.

Promos are managed in Exigo Promo, which opens from the Promos section of the Order Calc app in Admin and uses your Admin sign-in. The entries in that section depend on your company's menu setup.

System Relationship Map

The diagram shows how building, managing, and evaluating promos fit together.

Promo platform relationship map Build: extensions are implemented, the build emits their schemas, and a live company app build is published, which makes its extension definitions and schemas live. Manage: the promo management app uses the live extension definitions; in it you create and edit the Reward Catalog, templates, and saved groups, and reuse them in promos. Each save adds a promo version, and deploying a version makes it the live one. Consume: clients such as the Exigo API and Admin send orders, promo codes, and qualification requests to OrderCalc, which evaluates active promos using the version that was live at the order date. 1 · Build promo extensions 2 · Manage promos 3 · Consume configured promos Implement qualification,limit, and rewardextensions Build emitsextension schemas Publish livecompany app build Reward Catalog,templates, andsaved groups Promo management app Live extensiondefinitions and schemas Saved promo versions(each save adds one) Deployed version(the live one) Clients such as theExigo API and Admin OrderCalc evaluatesactive promos Makes extensions live Schema-drivenauthoring Create & edit Reuse in promos Save Deploy Version live at the order date Orders, promo codes, and qualification requests
Extension work at build time defines the configuration contract, the live company app build determines what can be managed, and OrderCalc evaluates the deployed promo versions.

Core Concepts

Concept Meaning
Promo A promotion definition that brings together qualifications, limits, rewards, schedules, and codes
Qualification A rule that sets what an order needs for the promo to apply
Limit A rule that decides whether a promo or reward can still be used, such as once per customer
Reward The effect granted when the promo qualifies
Configuration The JSON payload that configures a qualification, limit, or reward
Schema metadata Titles, descriptions, formats, and constraints that describe configuration to the management app and other tools
Schedule The time window that controls when a promo or code is active
Code An explicit promo code that can be entered or redeemed
Version A saved copy of a promo. Each save adds a version, and deploying a version makes it the live one

In the management app, qualifications and limits are configured directly on each promo. Rewards come from the Reward Catalog: reusable rewards that a promo starts from and can then adjust for itself.

How The Pieces Fit Together

The promo lifecycle usually looks like this:

  1. An extension author implements a qualification, limit, or reward and defines its public configuration contract.
  2. Building the company app generates schemas that describe that configuration, so the management app can show the right fields and validation.
  3. Publishing a live company app build makes its extensions, schemas, and reward types available in the management app.
  4. An authorized promo administrator or operator creates or updates promos by combining the available rules, schedules, codes, and reward definitions.
  5. OrderCalc evaluates active promos from the deployed promo versions for a given request and effective evaluation time, for clients such as the Exigo API and Admin.

These stages share the same configuration contract but use it at different points. The annotations an extension author adds are not only documentation: they shape the generated schemas and how the management app presents each field. OrderCalc, in contrast, evaluates the deployed promo versions.

Runtime evaluation is time-aware. The order date that reaches OrderCalc is converted to UTC and used as the effective evaluation time. Public API requests normally have an order date because the Exigo API supplies one when the client omits it; direct OrderCalc callers that leave OrderInput.OrderDate at its default value fall back to current UTC time. The promo version used is the one that was deployed at that effective time, so a historical or recalculated order can be evaluated against a different version than the one live today.

Readers And Common Tasks

Reader Primary task Best next guide
New promo author Build a first promo step by step Your First OrderCalc Promo
Promo administrator or operator Create, update, schedule, and review promos from available building blocks OrderCalc Promo Authoring And Management Guide
Promo author Set up rewards and understand every reward setting OrderCalc Promo Rewards
Promo author Reuse promo setups and lists of values OrderCalc Promo Templates And Saved Groups
Promo author Find the settings for a common offer OrderCalc Promo Common Offers
Promo author Try changes and test orders before saving OrderCalc Promo Workbench (Preview)
Extension implementer Build a custom qualification, limit, or reward OrderCalc Promo Extension Authoring Guide
API consumer Call public promo endpoints through the Exigo API OrderCalc Promo API Guide

Availability And Live Behavior

What a promo can do depends on what your live company app build provides: the extensions and reward types you can use in the management app, and which promo versions are live at a given evaluation time. So the version someone just saved, the version deployed now, and the version OrderCalc uses for an older order date are not always the same.

The extensions and reward types offered in the management app come from the live company app build, so promos are authored against that build. A new build can add, change, or remove extensions and reward types; existing catalog rewards are then moved to it with Remap rewards.

Continue Reading