Pricing Engine - Enum Values Reference

Complete reference for all enum fields in the Pricing Engine API.

PricingRule Enums

rule_type

Field: pricing_rule.rule_type
Type: String (required)
Default: "specific_date_time"

Example:

{
  "rule_type": "specific_date_time"
}

date_type (PricingRule Level)

Field: pricing_rule.date_type
Type: String (nullable)
Applies to: specific_date_time rules only

Example:

{
  "rule_type": "specific_date_time",
  "date_type": "specific_date",
  "start_date": "2024-12-15",
  "end_date": "2024-12-31",
  "is_no_end_date": false
}

Example (Ongoing):

{
  "date_type": "specific_date",
  "start_date": "2024-01-01",
  "end_date": null,
  "is_no_end_date": true
}

DateTimeCondition Enums

date_type (Condition Level)

Field: date_time_condition.date_type
Type: String (required)

Examples:

Everyday:

{
  "date_type": "everyday",
  "action_type": "increase",
  "value_type": "percentage",
  "value": 1000  // 10%
}

Weekend Only:

{
  "date_type": "day_of_week",
  "days_of_week": [0, 6],  // Sunday, Saturday
  "action_type": "increase",
  "value_type": "percentage",
  "value": 2000  // 20%
}

Friday Night Special:

{
  "date_type": "day_time_of_week",
  "days_of_week": [5],  // Friday
  "action_type": "decrease",
  "value_type": "percentage",
  "value": 1500,  // 15% off
  "condition_items_attributes": [{
    "start_time": "17:00",
    "end_time": "19:00",
    "is_anytime": false
  }]
}

action_type

Field: date_time_condition.action_type
Type: String (required when value is specified)

Example:

{
  "action_type": "increase"
}

value_type

Field: date_time_condition.value_type
Type: String (required when value is specified)

Examples:

15% increase:

{
  "value_type": "percentage",
  "value": 1500  // 15% = 1500 basis points
}

฿500 increase:

{
  "value_type": "fixed",
  "value": 50000  // ฿500 = 50000 cents
}

period_mode

Field: date_time_condition.period_mode
Type: String (nullable)

Example:

{
  "period_mode": "range"
}

days_of_week

Field: date_time_condition.days_of_week
Type: Integer Array
Values: 0-6

Examples:

Weekends:

{
  "days_of_week": [0, 6]  // Sunday and Saturday
}

Weekdays:

{
  "days_of_week": [1, 2, 3, 4, 5]  // Mon-Fri
}

Friday Only:

{
  "days_of_week": [5]
}

Calculation Examples

Base Price: ฿1,000 (100000 cents)

Percentage Adjustments

Fixed Amount Adjustments

Value Conversion Reference

Percentage (Basis Points)

Formula:
basis_points = percentage × 100
percentage = basis_points / 100

Fixed Amount (Cents)

Formula:
cents = baht × 100
baht = cents / 100

Common Patterns

Weekend Surge (20% increase)

{
  "pricing_rule": {
    "name": "Weekend Surge",
    "rule_type": "specific_date_time",
    "date_type": "specific_date",
    "start_date": "2024-01-01",
    "is_no_end_date": true,
    "requires_approval": false,
    "date_time_conditions_attributes": [{
      "date_type": "day_of_week",
      "days_of_week": [0, 6],
      "action_type": "increase",
      "value_type": "percentage",
      "value": 2000
    }]
  }
}

Happy Hour (15% discount, Mon-Fri 5-7pm)

{
  "pricing_rule": {
    "name": "Happy Hour",
    "rule_type": "specific_date_time",
    "date_type": "specific_date",
    "start_date": "2024-01-01",
    "is_no_end_date": true,
    "date_time_conditions_attributes": [{
      "date_type": "day_time_of_week",
      "days_of_week": [1, 2, 3, 4, 5],
      "action_type": "decrease",
      "value_type": "percentage",
      "value": 1500,
      "condition_items_attributes": [{
        "start_time": "17:00",
        "end_time": "19:00"
      }]
    }]
  }
}

Holiday Special (New Year’s Eve)

{
  "pricing_rule": {
    "name": "New Year's Eve Special",
    "rule_type": "specific_date_time",
    "date_type": "specific_date_time",
    "start_date": "2024-12-31",
    "end_date": "2024-12-31",
    "start_time": "20:00",
    "end_time": "23:59",
    "requires_approval": true,
    "date_time_conditions_attributes": [{
      "date_type": "specific_date_time",
      "action_type": "increase",
      "value_type": "fixed",
      "value": 100000,  // ฿1000
      "condition_items_attributes": [{
        "start_date": "2024-12-31",
        "end_date": "2024-12-31",
        "start_time": "20:00",
        "end_time": "23:59"
      }]
    }]
  }
}

Validation Rules

Required Fields

PricingRule:

• name (string)
• rule_type (enum)
• priority (integer, 0-1000)

DateTimeCondition:

• date_type (enum)
• action_type (enum) - when value specified
• value_type (enum) - when value specified
• value (integer) - when action specified

Conditional Requirements

If date_type is day_of_week or day_time_of_week:

• days_of_week array is required

If date_type is specific_date, specific_time, specific_date_time, or day_time_of_week:

• At least one condition_item is required

If end_date is provided:

• Must be >= start_date
• If is_no_end_date is true, end_date is ignored

If end_time is provided:

• Must be >= start_time
• If is_no_end_time or is_anytime is true, times are ignored

API Response Format

{
  "data": {
    "id": 123,
    "restaurant_id": "rest_abc123",
    "name": "Weekend Surge",
    "rule_type": "specific_date_time",
    "priority": 100,
    "active": true,
    "requires_approval": false,
    "date_type": "specific_date",
    "start_date": "2024-01-01",
    "end_date": null,
    "start_time": null,
    "end_time": null,
    "is_no_end_date": true,
    "is_no_end_time": false,
    "is_anytime": false,
    "ongoing": true,
    "apply_to_all_packages": true,
    "package_ids": [],
    "date_time_conditions": [
      {
        "id": 456,
        "date_type": "day_of_week",
        "period_mode": "range",
        "action_type": "increase",
        "value_type": "percentage",
        "value": 2000,
        "days_of_week": [0, 6],
        "condition_items": []
      }
    ],
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}