FreeGoodsPromotion

Type: schema

TypeScript Definition

FreeGoodsPromotion: {{
            /**
             * @description discriminator enum property added by openapi-typescript
             * @enum {string}
             */
            promotion_type: "free-goods";
            /** @description The quantity of items a customer must buy to receive free goods. */
            buy_quantity: number;
            /** @description The quantity of free goods the customer receives. */
            get_quantity: number;
        };
        /** FreeGoodsRule */
}

OpenAPI Schema

{
  "title": "FreeGoodsPromotion",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/FreeGoodsPromotion",
    "description": "API reference for the FreeGoodsPromotion schema"
  },
  "required": [
    "promotion_type",
    "buy_quantity",
    "get_quantity"
  ],
  "properties": {
    "promotion_type": {
      "type": "string",
      "enum": [
        "discount",
        "volume-based",
        "fixed-price",
        "free-goods"
      ],
      "const": "free-goods",
      "readOnly": true
    },
    "buy_quantity": {
      "description": "The quantity of items a customer must buy to receive free goods.",
      "type": "integer"
    },
    "get_quantity": {
      "description": "The quantity of free goods the customer receives.",
      "type": "integer"
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions