create_promotion

Parameters schema

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name",
    "code",
    "value"
  ],
  "properties": {
    "code": {
      "type": "string",
      "description": "Coupon code customers enter at checkout (auto-uppercased)"
    },
    "name": {
      "type": "string",
      "description": "Promotion name (internal)"
    },
    "type": {
      "enum": [
        "percentage",
        "fixed_amount"
      ],
      "type": "string",
      "description": "Default percentage"
    },
    "value": {
      "type": "string",
      "description": "Discount value as decimal string"
    },
    "endsAt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "ISO datetime — when the promo expires"
    },
    "status": {
      "enum": [
        "active",
        "inactive",
        "expired"
      ],
      "type": "string",
      "description": "Default active"
    },
    "startsAt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "ISO datetime — when the promo becomes valid"
    },
    "posEnabled": {
      "type": "boolean",
      "description": "Allow at POS"
    },
    "description": {
      "type": "string",
      "description": "Description"
    },
    "eventEnabled": {
      "type": "boolean",
      "description": "Allow on event registrations"
    },
    "minimumAmount": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Minimum order amount required, decimal string"
    },
    "onlineEnabled": {
      "type": "boolean",
      "description": "Allow on online shop orders"
    },
    "bookingEnabled": {
      "type": "boolean",
      "description": "Allow on bookings"
    },
    "maximumDiscount": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Cap on percentage discounts, decimal string"
    },
    "minimumQuantity": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "description": "Minimum item count required"
    },
    "usageLimitTotal": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "description": "Max total uses across all customers"
    },
    "usageLimitPerCustomer": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "description": "Max uses per single customer"
    }
  }
}

No endpoints wrapped at confidence ≥ 0.70.

Parent server