LoyaltyPointActivity

Type: schema

Description

Loyalty Point Activity

TypeScript Definition

LoyaltyPointActivity: {{
            /**
             * @description The action that occurred.
             * @enum {string}
             */
            action?: "add" | "remove";
            /**
             * @description The activity that occurred.
             * @enum {string}
             */
            activity?: "order-placed" | "credit-note-issued" | "tier-upgrade" | "tier-downgrade" | "points-expired" | "points-carryforward" | "signup" | "bonus" | "other";
            reference_number?: string | null;
            title?: string;
            loyalty_points?: number;
            remarks?: string | null;
            /** Format: date-time */
            created_at?: string;
            /** Format: date-time */
            modified_at?: string;
        };
        /** ManualPaymentMethod */
}

OpenAPI Schema

{
  "title": "LoyaltyPointActivity",
  "description": "Loyalty Point Activity",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/LoyaltyPointActivity",
    "description": "API reference for the LoyaltyPointActivity schema"
  },
  "properties": {
    "action": {
      "description": "The action that occurred.",
      "type": "string",
      "enum": [
        "add",
        "remove"
      ]
    },
    "activity": {
      "description": "The activity that occurred.",
      "type": "string",
      "enum": [
        "order-placed",
        "credit-note-issued",
        "tier-upgrade",
        "tier-downgrade",
        "points-expired",
        "points-carryforward",
        "signup",
        "bonus",
        "other"
      ]
    },
    "reference_number": {
      "type": [
        "string",
        "null"
      ]
    },
    "title": {
      "type": "string"
    },
    "loyalty_points": {
      "type": "integer"
    },
    "remarks": {
      "type": [
        "string",
        "null"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions