Skip to content

ApplicableCoupon

Type: schema

TypeScript Definition

typescript
ApplicableCoupon: {{
            id?: string;
            name?: string;
            coupon_type?: components["schemas"]["CouponType"];
            coupon_code?: string[];
            estimated_discount?: number;
            savings_message?: string;
        };
}

Component References

ReferenceResolves To
components["schemas"]["CouponType"]CouponType

OpenAPI Schema

json
{
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/ApplicableCoupon",
    "description": "API reference for the ApplicableCoupon schema"
  },
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "coupon_type": {
      "$ref": "#/components/schemas/CouponType"
    },
    "coupon_code": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "estimated_discount": {
      "type": "number"
    },
    "savings_message": {
      "type": "string"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: