`IPromoIssue`

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IPromoIssue

Code issued to a customer.

app/interfaces/orionplace/marketing/IPromoActions.ts

TypeScript

export interface IPromoIssue {
  // Issued promo-code ID. Submit `code_value` to apply it.
  id: number;
  // Code text.
  code_value: string;
  // Whether this issued code is active. This alone does not prove cart
  // eligibility.
  is_code_active: boolean;
  // Maximum redemptions; `EPromoUsageLimit.UNLIMITED_USAGE` means unlimited.
  maximum_usages: number;
  // Stored usage count. Applying a code rechecks its actual usage restrictions.
  current_usages: number;
  // Promotion definition: type, amount, dates and optional product, category or
  // seller restrictions.
  promo_type: IPromoDefinition | null;
  // Whether this code is attached to the customer’s cart; retain this response
  // spelling.
  applyed_to_cart: boolean;
}