Skip to content

LoyaltyPointActivity ​

Type: schema

TypeScript Definition ​

typescript
LoyaltyPointActivity: {{
            /** @enum {unknown} */
            activity: "order" | "credit-note" | "tier-upgrade" | "signup" | "bonus" | "other" | "new-customer";
            /** @enum {unknown} */
            action: "add" | "remove";
            title: string;
            loyalty_points: number;
            reference_number?: string | null;
            internal_note?: string | null;
            remarks?: string | null;
            /** Format: date-time */
            created_at?: $Read<string>;
            /** Format: date-time */
            modified_at?: $Read<string>;
        };
        /** LoyaltyProgram */
}

OpenAPI Schema ​

json
{
  "title": "LoyaltyPointActivity",
  "type": "object",
  "required": [
    "activity",
    "action",
    "title",
    "loyalty_points"
  ],
  "properties": {
    "activity": {
      "enum": [
        "order",
        "credit-note",
        "tier-upgrade",
        "signup",
        "bonus",
        "other",
        "new-customer"
      ]
    },
    "action": {
      "enum": [
        "add",
        "remove"
      ]
    },
    "title": {
      "type": "string"
    },
    "loyalty_points": {
      "type": "integer"
    },
    "reference_number": {
      "type": [
        "string",
        "null"
      ]
    },
    "internal_note": {
      "type": [
        "string",
        "null"
      ]
    },
    "remarks": {
      "type": [
        "string",
        "null"
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-tags": [
    "Customers"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: