AppliedCoupon

Type: schema

Description

Details about an active coupon applied to a cart/order

TypeScript Definition

AppliedCoupon: {{
            coupon_id: string;
            /** @enum {unknown} */
            coupon_type: "discount" | "free-goods" | "fixed-price" | "free-shipping" | "buy-x-get-y" | "volume-based" | "accelerated-rewards";
            savings: number;
            product_id: string | null;
            variant_id: string | null;
            product_name: string | null;
            variant_name: string | null;
        };
        /**
         * AppliedPromotion
         * @description Details about an active promotion applied to a cart/order
         */
}

OpenAPI Schema

{
  "title": "AppliedPromotion",
  "description": "Details about an active coupon applied to a cart/order",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/AppliedCoupon",
    "description": "API reference for the AppliedCoupon schema"
  },
  "required": [
    "coupon_id",
    "coupon_type",
    "savings",
    "product_id",
    "variant_id",
    "product_name",
    "variant_name"
  ],
  "properties": {
    "coupon_id": {
      "type": "string"
    },
    "coupon_type": {
      "enum": [
        "discount",
        "free-goods",
        "fixed-price",
        "free-shipping",
        "buy-x-get-y",
        "volume-based",
        "accelerated-rewards"
      ]
    },
    "savings": {
      "type": "number"
    },
    "product_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "variant_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "product_name": {
      "type": [
        "string",
        "null"
      ]
    },
    "variant_name": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions