The Subscription LifecycleEnrollmentAdd a Subscription to Cart

Domain Objects

Reference for core data types used in Ordergroove offer elements
View as Markdown

Frequency

Frequency is the cadence at which orders associated with a given opt-in are placed. Frequency is a tuple consisting of “every” and “every period”. “Every period” may be days, weeks, months, or years, represented as 1, 2, 3, and 4 respectively. “Every” is a positive integer multiplier applied to the period. Together, “every” and “every period” are represented as a string separated by an underscore.

Examples

FrequencyDescription
1_1Every 1 day
2_1Every 2 days
4_2Every 4 weeks
4_3Every 4 months

List of Frequencies

A list of frequencies is a space-separated list of frequency values, represented as a single string.

Examples

List of FrequenciesDescription
1_3 2_3 3_3Every 1 month, every 2 months, every 3 months

List of Product Components (Legacy Bundles)

A list of product components is a space-separated list of product IDs that together comprise a single product. This is useful for representing bundles or boxes.

Examples

List of Product ComponentsDescription
foo bar bazThe product is comprised of the products foo, bar, and baz

Offer Type

Offer type refers to the type of UI element displayed for an offer. It is an enumerated string with the following valid values: radio, select, or toggle.