ApplicablePromotion

Type: schema

TypeScript Definition

ApplicablePromotion: {{
            id?: string;
            name?: string;
            promotion_type?: components["schemas"]["PromotionType"];
            estimated_discount?: number;
            savings_message?: string;
        };
        /**
         * AppliedPromotion
         * @description Details about an active coupon applied to a cart/order
         */
}

Component References

Reference	Resolves To
components["schemas"]["PromotionType"]	PromotionType

OpenAPI Schema

{
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/ApplicablePromotion",
    "description": "API reference for the ApplicablePromotion schema"
  },
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "promotion_type": {
      "$ref": "#/components/schemas/PromotionType"
    },
    "estimated_discount": {
      "type": "number"
    },
    "savings_message": {
      "type": "string"
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions