Kibo Commerce · Schema

CatalogAdminsDiscount

Allows you to define and manage discounts to apply to your products, product categories, or orders. The discounts can be a specified monetary amount off the price, percentage off the price, or for free shipping. You can create a coupon code that applies to the discount.

CompanyCommerceE-CommerceHeadless CommerceOrder ManagementB2BConsumerInventoryFulfillment

Properties

Name Type Description
amount numbernull Amount of the discount, as a percentage or monetary amount, for example 15% or $15. Must be either null or greater than zero.
amountType string Type of discount, which can be either a percentage off the price, a specific monetary amount, or free. Possible values: Percentage Amount Free FixedPrice
auditInfo object
canBeDeleted boolean Signifies that the discount is not referenced and can be hard deleted
canBeStackedUpon booleannull Indicates whether or not stacking is enabled for this discount
code stringnull Indicates unique code for the discount, if not present Discount Id is used as a code.
conditions object
content object
currentRedemptionCount integernull How many times this discount has been redeemed. System-supplied and read-only.
doesNotApplyToMultiShipToOrders booleannull Flag to allow or prevent application to multi-ship-to orders, Only applicable to shipping discounts.
doesNotApplyToProductsWithSalePrice booleannull Determines whether or not a discount applies to a items with a sale price. Applicable on order and line item discounts. For line items, when this is true, the discount will be disqualified. For order
doesNotApplyToSalePrice booleannull Determines if the discount should apply to sale price or regular price only. Discounts will apply to sale prices by default. Only applies to LineItem product discounts.
hasPurchaseConditions boolean Indicates if this discount has purchase conditions that must be met before the discount is applied
id integernull Unique identifier of the discount. System-supplied and read-only.
includedPriceLists arraynull Products receiving a price from a price list specified here or a child of a specified price list can be discounted.
isBxGx booleannull Readonly property indicating that the condition required purchase is the same as the target items. Used in BxGx and BoGo type discounts.
isDisabled booleannull Signifies if the discount is disabled (Null is treated as false)
isPublic booleannull Determines whether the discount is available for every shopper.
isSubscriptionDiscount booleannull Determines how discounts will be evaluated for subscription items and during continuity orders.
labels arraynull Indicates unique discount labels.
localizedContent arraynull Container for the language-specific name of the discount. You will have a container for each supported language (LocaleCode). This enables you to display the discount name in multiple languages yet ma
maximumDiscountImpactPerOrder numbernull Maximum impact this discount can apply on a single order. Must be either null or greater than zero.
maximumDiscountImpactPerRedemption numbernull Maximum impact this discount can apply on a single line item. Must be either null or greater than zero.
maximumRedemptionsPerOrder integernull Maximum number of redemptions allowed per order. If null, defaults to unlimited.
maximumUsesPerUser integernull Maximum number of times a user can redeem this discount. Must be either null or greater than zero.
preventLineItemShippingDiscounts booleannull Prevents Line Item Shipping discounts from being applied when a Line Item Product discount has been applied
preventOrderProductDiscounts booleannull Prevents Order Product discounts from being applied when a Line Item Product or Shipping discount has been applied
preventOrderShippingDiscounts booleannull Prevents Order Shipping discounts from being applied when a Line Item Product/Shipping or Order Product discount has been applied
purchaseRequirementType stringnull The type of purchase requirement for this discount, either purchase conditions and targets which Supports BoGo, and BxGx scenarios. Or Target only that only have a target and no purchase conditions
reevalFreeItemMinOrderPostDiscounts booleannull Enables post-order-discount minimum re-evaluation for eligible free-item discounts. Values null and false are treated as disabled.
scope string Scope to which the discount applies, valid values are: Order, LineItem
stackingLayer integernull Indicates which stacking layer this discount is a part of
status stringnull Discount status which can be "Active," "Scheduled," or "Expired." System-supplied and read-only.
tagCodes arraynull System-supplied and read-only.
target object
thresholdMessage object
View JSON Schema on GitHub

JSON Schema

kibo-commerce-catalog-admins-discount-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/kibo-commerce/main/json-schema/kibo-commerce-catalog-admins-discount-schema.json",
  "title": "CatalogAdminsDiscount",
  "description": "Allows you to define and manage discounts to apply to your products, product categories, or orders. The discounts can be a specified monetary amount off the price, percentage off the price, or for free shipping.\nYou can create a coupon code that applies to the discount.",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kibo-commerce-catalog-admin-openapi.yml#/components/schemas/CatalogAdminsDiscount",
  "properties": {
    "amount": {
      "description": "    Amount of the discount, as a percentage or monetary amount, for example 15% or $15.\nMust be either null or greater than zero.",
      "exclusiveMinimum": true,
      "format": "double",
      "minimum": 0,
      "type": [
        "number",
        "null"
      ]
    },
    "amountType": {
      "description": "Type of discount, which can be either a percentage off the price, \na specific monetary amount, or free. \nPossible values: \n\tPercentage \n\tAmount \n\tFree\n\tFixedPrice",
      "minLength": 1,
      "nullable": false,
      "type": "string"
    },
    "auditInfo": {
      "$ref": "#/$defs/AuditInfo"
    },
    "canBeDeleted": {
      "description": "Signifies that the discount is not referenced and can be hard deleted",
      "nullable": false,
      "type": "boolean"
    },
    "canBeStackedUpon": {
      "description": "Indicates whether or not stacking is enabled for this discount",
      "type": [
        "boolean",
        "null"
      ]
    },
    "code": {
      "description": "Indicates unique code for the discount, if not present Discount Id is used as a code.",
      "maxLength": 50,
      "pattern": "^[A-Za-z0-9-_\\.()]*[A-Za-z0-9-_()]$",
      "type": [
        "string",
        "null"
      ]
    },
    "conditions": {
      "$ref": "#/$defs/CatalogAdminsDiscountCondition"
    },
    "content": {
      "$ref": "#/$defs/DiscountLocalizedContent"
    },
    "currentRedemptionCount": {
      "description": "How many times this discount has been redeemed. System-supplied and read-only.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "doesNotApplyToMultiShipToOrders": {
      "description": "Flag to allow or prevent application to multi-ship-to orders,\nOnly applicable to shipping discounts.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "doesNotApplyToProductsWithSalePrice": {
      "description": "Determines whether or not a discount applies to a items with a sale price.  Applicable \non order and line item discounts.  For line items, when this is true, the discount will \nbe disqualified.  For order level discounts, when true, the discount will not be applied \nto those items have a sale price.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "doesNotApplyToSalePrice": {
      "description": "Determines if the discount should apply to sale price or regular price only.\nDiscounts will apply to sale prices by default.\nOnly applies to LineItem product discounts.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "hasPurchaseConditions": {
      "description": "Indicates if this discount has purchase conditions that must be met before \nthe discount is applied",
      "nullable": false,
      "type": "boolean"
    },
    "id": {
      "description": "Unique identifier of the discount. System-supplied and read-only.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "includedPriceLists": {
      "description": "Products receiving a price from a price list specified here or a child of a specified \nprice list can be discounted.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "isBxGx": {
      "description": "Readonly property indicating that the condition required purchase is the \nsame as the target items.  Used in BxGx and BoGo type discounts.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isDisabled": {
      "description": "Signifies if the discount is disabled (Null is treated as false)",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isPublic": {
      "description": "Determines whether the discount is available for every shopper.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isSubscriptionDiscount": {
      "description": "Determines how discounts will be evaluated for subscription items and during continuity orders.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "labels": {
      "description": "Indicates unique discount labels.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "localizedContent": {
      "description": "Container for the language-specific name of the discount. You will have a container for each supported language (LocaleCode).\nThis enables you to display the discount name in multiple languages yet manage it as a single discount internally.",
      "items": {
        "$ref": "#/$defs/DiscountLocalizedContent"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "maximumDiscountImpactPerOrder": {
      "description": "Maximum impact this discount can apply on a single order.\n Must be either null or greater than zero.",
      "exclusiveMinimum": true,
      "format": "double",
      "minimum": 0,
      "type": [
        "number",
        "null"
      ]
    },
    "maximumDiscountImpactPerRedemption": {
      "description": "Maximum impact this discount can apply on a single line item.\n Must be either null or greater than zero.",
      "exclusiveMinimum": true,
      "format": "double",
      "minimum": 0,
      "type": [
        "number",
        "null"
      ]
    },
    "maximumRedemptionsPerOrder": {
      "description": "Maximum number of redemptions allowed per order.\nIf null, defaults to unlimited.",
      "exclusiveMinimum": true,
      "format": "int32",
      "minimum": 0,
      "type": [
        "integer",
        "null"
      ]
    },
    "maximumUsesPerUser": {
      "description": "Maximum number of times a user can redeem this discount.\n Must be either null or greater than zero.",
      "exclusiveMinimum": true,
      "format": "int32",
      "minimum": 0,
      "type": [
        "integer",
        "null"
      ]
    },
    "preventLineItemShippingDiscounts": {
      "description": "Prevents Line Item Shipping discounts from being applied when a Line Item Product  \ndiscount has been applied",
      "type": [
        "boolean",
        "null"
      ]
    },
    "preventOrderProductDiscounts": {
      "description": "Prevents Order Product discounts from being applied when a Line Item Product  \nor Shipping discount has been applied",
      "type": [
        "boolean",
        "null"
      ]
    },
    "preventOrderShippingDiscounts": {
      "description": "Prevents Order Shipping discounts from being applied when a Line Item Product/Shipping  \nor Order Product discount has been applied",
      "type": [
        "boolean",
        "null"
      ]
    },
    "purchaseRequirementType": {
      "description": "The type of purchase requirement for this discount, either purchase conditions and targets which   \nSupports BoGo, and BxGx scenarios. Or Target only that only have a target and no purchase conditions",
      "type": [
        "string",
        "null"
      ]
    },
    "reevalFreeItemMinOrderPostDiscounts": {
      "description": "Enables post-order-discount minimum re-evaluation for eligible free-item discounts.\nValues null and false are treated as disabled.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "scope": {
      "description": "Scope to which the discount applies, valid values are: Order, LineItem",
      "minLength": 1,
      "nullable": false,
      "type": "string"
    },
    "stackingLayer": {
      "description": "Indicates which stacking layer this discount is a part of",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "status": {
      "description": "Discount status which can be \"Active,\" \"Scheduled,\" or \"Expired.\" System-supplied and read-only.",
      "type": [
        "string",
        "null"
      ]
    },
    "tagCodes": {
      "description": "System-supplied and read-only.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "target": {
      "$ref": "#/$defs/CatalogAdminsDiscountTarget"
    },
    "thresholdMessage": {
      "$ref": "#/$defs/CatalogAdminsThresholdMessage"
    }
  },
  "required": [
    "amountType",
    "scope",
    "target"
  ],
  "type": "object",
  "$defs": {
    "AuditInfo": {
      "properties": {
        "createBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "createDate": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "updateBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "updateDate": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "CatalogAdminsCustomerSegment": {
      "description": "Represents a customer segment",
      "properties": {
        "id": {
          "description": "The Customer segment Id.\nThis is the  system Id not the code.",
          "format": "int32",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "CatalogAdminsDiscountCondition": {
      "description": "Specifies constraints that must be satified for a discount to be applied to a target.\nConstraints are Anded together",
      "properties": {
        "categoriesToExcludeFromMinOrderTotal": {
          "description": "List of categories to discount. When a discount applies to a category, all products in the category are discounted.",
          "items": {
            "$ref": "#/$defs/CategoryDiscountCondition"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "continuityRecurrenceSettings": {
          "$ref": "#/$defs/ContinuityRecurrenceSettings"
        },
        "couponCode": {
          "description": "Code of the coupon associated with the discount (if a coupon code is required). The merchant can supply the code or the system can generate it.",
          "type": [
            "string",
            "null"
          ]
        },
        "customerSegments": {
          "description": "List of customer groups for which the discount applies",
          "items": {
            "$ref": "#/$defs/CatalogAdminsCustomerSegment"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "excludedCategories": {
          "description": "List of categories to discount. When a discount applies to a category, all products in the category are discounted.",
          "items": {
            "$ref": "#/$defs/CategoryDiscountCondition"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "excludedProducts": {
          "description": "List of products that are eligible for the discount.",
          "items": {
            "$ref": "#/$defs/ProductDiscountCondition"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "exclusiveLocationCodes": {
          "description": "List of locations where the item/order should be fulfilled for the discount to be valid.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "exclusiveSiteIds": {
          "description": "The discount condition for site Ids, if present the discount will be applied only to these sites.\nIf not present discount will work for all sites in a catalog.",
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "expirationDate": {
          "description": "Date when the discount expires. Default is null (no expiration date).",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "expression": {
          "$ref": "#/$defs/CatalogAdminsDynamicExpression"
        },
        "includedCategories": {
          "description": "List of categories that must be purchased in order for the discount to be valid.",
          "items": {
            "$ref": "#/$defs/CategoryDiscountCondition"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "includedPaymentWorkflows": {
          "description": "List of payment types that trigger this discount to be valid.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "includedProducts": {
          "description": "List of products that are eligible for the discount.",
          "items": {
            "$ref": "#/$defs/ProductDiscountCondition"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "maxRedemptionCount": {
          "description": "Maximum number of times that the discount can be redeemed. Default is null (no limit to discount redemptions).",
          "exclusiveMinimum": true,
          "format": "int32",
          "minimum": 0,
          "type": [
            "integer",
            "null"
          ]
        },
        "maximumOrderAmount": {
          "description": "Only applies to order.\nMaximum order subtotal after discounts in order for the associated discount to be applied",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "minDistinctProductsRequired": {
          "description": "The minimum number of distinct products on the order\nNot a quantity calculation.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "minTotalOrderQuantity": {
          "description": "The order must contain at least this total quantity of items for the discount to apply.\nYou must buy a combined quantity of at least x amount.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "minimumCategorySubtotalBeforeDiscounts": {
          "description": "Minimum amount that must be purchased in the combined categories defined in \nIncludedCategories.  Amount is calculated before discounting.\nNot used if IncludedCategories is empty.",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "minimumLifetimeValueAmount": {
          "description": "Minimum lifetime value amount required for this discount to apply",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "minimumOrderAmount": {
          "description": "Only applies to order.\nMinimum order subtotal after discounts in order for the associated discount to be applied",
          "format": "double",
          "type": [
            "number",
            "null"
          ]
        },
        "minimumQuantityProductsRequiredInCategories": {
          "description": "Minimum quantity of products in the categories specified in IncludedCategories that must be purchased to\nqualify for the associated discount.\nDefaults to 1 if  null and IncludedCategories has values",
          "exclusiveMinimum": true,
          "format": "int32",
          "minimum": 0,
          "type": [
            "integer",
            "null"
          ]
        },
        "minimumQuantityRequiredProducts": {
          "description": "Minimum quantity of products in the specified IncludedProducts that must be purchased to\nqualify for the associated discount.\nDefaults to 1 if  null and IncludedProducts has values.",
          "exclusiveMinimum": true,
          "format": "int32",
          "minimum": 0,
          "type": [
            "integer",
            "null"
          ]
        },
        "minimumRequiredQuantityPerRedemption": {
          "description": "Defines a minimum quantity that is required for a target only discount",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "pricingContext": {
          "description": "The pricing context must match on this value for the discount to apply.\nThis only matters for tenants that use subscription products",
          "type": [
            "string",
            "null"
          ]
        },
        "productsToExcludeFromMinOrderTotal": {
          "description": "List of products that are eligible for the discount.",
          "items": {
            "$ref": "#/$defs/ProductDiscountCondition"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "requiresAuthenticatedUser": {
          "description": "Determines is this discount can be used by an anonymous user \nDefaults to false to allow discounts for anonymous users.",
          "nullable": false,
          "type": "boolean"
        },
        "requiresCoupon": {
          "description": "If true, the shopper needs to enter a coupon code to redeem the discount.",
          "nullable": false,
          "type": "boolean"
        },
        "startDate": {
          "description": "Date when the discount can goes into effect, in the format yyyy-mm-dd.",
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "validFulfillmentMethods": {
          "description": "The discount condition for fulfillment methods, if present the discount will be applied only to these fulfillment methods.\nThis must be a value defined in FulfillmentMethodConst below.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "validSubscriptionContinuityOrdinals": {
          "description": "Ordinals at which a continuity order should receive the discount.",
          "items": {
            "format": "int32",
            "type": "integer"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "validSubscriptionFrequencies": {
          "description": "List of subscription frequencies to which the discount will apply.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "CatalogAdminsDiscountTarget": {
      "description": "What to discount. Specifies the type of discount (percentage off, monetary amount, or free shipping) and which products, categories, or shipping methods are eligible for the discount.\nCan also specify the minimum amount that the order must total for the discount to apply.",
      "properties": {
        "appliesToLeastExpensiveProductsFirst": {
          "description": "Determines which way the discount is optimized.  Consumers favor(default - false/null) or tenants favor (when this is set to true)\nApplies to discounts where target is not a specific product or list of products.  \nMay also impact behavior of Buy X Get Y so that X is the most expensive items and Y the least expensive.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "categories": {
          "description": "List of categories to discount. When a discount applies to a category, all products in the category are discounted.",
          "items": {
            "$ref": "#/$defs/CatalogAdminsTargetedCategory"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "doNotApplyToHandlingFees": {
          "description": "Prevents the discount from being applied to handling fees",
          "type": [
            "boolean",
            "null"
          ]
        },
        "excludeItemsWithExistingProductDiscounts": {
          "description": "Prevents order scoped discounts from layering over items that already have a product discount with the \nsame type.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "excludeItemsWithExistingShippingDiscounts": {
          "description": "Prevents order scoped discounts from layering over items that already have a shipping discount with the \nsame type.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "excludedCategories": {
          "description": "List of categories to exclude from the discount. Useful to exclude specific child categories.",
          "items": {
            "$ref": "#/$defs/CatalogAdminsTargetedCategory"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "excludedCategoriesOperator": {
          "description": "Applies to Included categories\nDefaults to Any",
          "type": [
            "string",
            "null"
          ]
        },
        "excludedProducts": {
          "description": "List of products that are excluded from the discount.",
          "items": {
            "$ref": "#/$defs/TargetedProduct"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "includeAllProducts": {
          "description": "If yes, the discount applies to all products sold on the storefront.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "includedCategoriesOperator": {
          "description": "Applies to Included categories\nWhen Any, the target product can belong to any specified category.\nWhen All, the target product must belong to all specified categories.\nDefaults to Any",
          "type": [
            "string",
            "null"
          ]
        },
        "maximumQuantityPerRedemption": {
          "description": "When a condition is specified, this property limits the number of items that can be targeted per discount redemption with an order.\nif multiple redemptions are allowed per order then multiples of this value would be allowed in multiples of the associated \ncondition.\nIf no condition is specified then this value is not used.  \nIf null and condition exists, then defaults to 1.",
          "exclusiveMinimum": true,
          "format": "int32",
          "minimum": 0,
          "type": [
            "integer",
            "null"
          ]
        },
        "products": {
          "description": "List of products that are eligible for the discount.",
          "items": {
            "$ref": "#/$defs/TargetedProduct"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "shippingMethods": {
          "description": "Shipping method that is eligible for shipping discounts. This is a shipping method defined in Shipping Settings.",
          "items": {
            "$ref": "#/$defs/CatalogAdminsTargetedShippingMethod"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "shippingZones": {
          "description": "Shipping Zones that are applicable for this discount",
          "items": {
            "$ref": "#/$defs/CatalogAdminsTargetedShippingZone"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "type": {
          "description": "    Type of target to which the discount applies. Possible values: <pre>Product</pre> or <pre>Shipping</pre>. \nIf this is a <pre>Product</pre> type, you can specify which products or categories that the discount applies to.\n    If this is a <pre>Shipping</pre> type then you must specify which shipping methods apply.",
          "minLength": 1,
          "nullable": false,
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    },
    "CatalogAdminsDynamicExpression": {
      "description": "Category",
      "properties": {
        "text": {
          "type": [
            "string",
            "null"
          ]
        },
        "tree": {
          "$ref": "#/$defs/CatalogAdminsExpression"
        }
      },
      "type": "object"
    },
    "CatalogAdminsExpression": {
      "properties": {
        "left": {
          "description": "The field target of a predicate",
          "type": [
            "string",
            "null"
          ]
        },
        "logicalOperator": {
          "description": "And or Or (if Container with More than one Node)",
          "type": [
            "string",
            "null"
          ]
        },
        "nodes": {
          "items": {
            "$ref": "#/$defs/CatalogAdminsExpression"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "operator": {
          "description": "The operator of a predicate",
          "type": [
            "string",
            "null"
          ]
        },
        "right": {
          "description": "The literal values of a predicate",
          "nullable": true
        },
        "type": {
          "description": "Container or Predicate",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "CatalogAdminsTargetedCategory": {
      "description": "Category to discount. When a discount applies to a category, all products in the category are discounted.",
      "properties": {
        "id": {
          "description": "Unique identifier of the category to which the discount applies.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "CatalogAdminsTargetedShippingMethod": {
      "description": "Shipping method that is eligible for free shipping. This is the shipping method that is defined with the Shipping\nSettings resource.",
      "properties": {
        "code": {
          "description": "Unique identifier of the shipping method as it appears in the SiteShippingMethod property of the Shipping Settings\nresource.",
          "maxLength": 100,
          "minLength": 0,
          "nullable": false,
          "type": "string"
        },
        "name": {
          "description": "Name of the shipping method as it appears in SiteShippingMethodLocalizedContent of the Shipping Settings resource.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "code"
      ],
      "type": "object"
    },
    "CatalogAdminsTargetedShippingZone": {
      "description": "Shipping method that is eligible for free shipping. This is the shipping method that is defined with the Shipping\nSettings resource.",
      "properties": {
        "zone": {
          "description": "Indicates the shipping zone that this discount is valid for.  If zone is provided the\nmethod selected must be valid for the zone and both populated in the order for the discount\nto be valid.",
          "maxLength": 200,
          "minLength": 0,
          "nullable": false,
          "type": "string"
        }
      },
      "required": [
        "zone"
      ],
      "type": "object"
    },
    "CatalogAdminsThresholdMessage": {
      "properties": {
        "auditInfo": {
          "$ref": "#/$defs/AuditInfo"
        },
        "content": {
          "$ref": "#/$defs/ThresholdMessageLocalizedContent"
        },
        "discountId": {
          "description": "Unique identifier of the discount. System-supplied and read-only.",
          "format": "int32",
          "nullable": false,
          "type": "integer"
        },
        "isActive": {
          "description": "Indicates if threshold messages are active for this discount",
          "nullable": false,
          "type": "boolean"
        },
        "localizedContent": {
          "description": "Container for the language-specific name of the threshold message. You will have a container for each supported language (LocaleCode).\nThis enables you to display the message in multiple languages yet manage it as a single message internally.",
          "items": {
            "$ref": "#/$defs/ThresholdMessageLocalizedContent"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "requiresCouponCode": {
          "description": "Indicates if the threshold message will display when a promo code is evaluated",
          "nullable": false,
          "type": "boolean"
        },
        "showInCart": {
          "description": "Indicates if the threshold message will display in the cart",
          "nullable": false,
          "type": "boolean"
        },
        "showOnCheckout": {
          "description": "Indicates if the threshold message will display on the checkout page",
          "nullable": false,
          "type": "boolean"
        },
        "thresholdValue": {
          "description": "The cart total amount that must be met before the threshold message is displayed",
          "format": "double",
          "nullable": false,
          "type": "number"
        }
      },
      "required": [
        "discountId",
        "thresholdValue"
      ],
      "type": "object"
    },
    "CategoryDiscountCondition": {
      "description": "Represents a product category and quantity constraint",
      "properties": {
        "categoryId": {
          "description": "Unique identifier of the category to which the discount condition applies.",
          "format": "int32",
          "nullable": false,
          "type": "integer"
        }
      },
      "type": "object"
    },
    "ContinuityRecurrenceSettings": {
      "properties": {
        "interval": {
          "description": "Interval until next discount applies",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "startOrdinal": {
          "description": "Continuity ordinal to start discounting",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "stopOrdinal": {
          "description": "Continuity ordinal to stop discounting",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "CustomPropertyValues": {
      "properties": {
        "value1": {
          "type": [
            "string",
            "null"
          ]
        },
        "value10": {
          "type": [
            "string",
            "null"
          ]
        },
        "value2": {
          "type": [
            "string",
            "null"
          ]
        },
        "value3": {
          "type": [
            "string",
            "null"
          ]
        },
        "value4": {
          "type": [
            "string",
            "null"
          ]
        },
        "value5": {
          "type": [
            "string",
            "null"
          ]
        },
        "value6": {
          "type": [
            "string",
            "null"
          ]
        },
        "value7": {
          "type": [
            "string",
            "null"
          ]
        },
        "value8": {
          "type": [
            "string",
            "null"
          ]
        },
        "value9": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "DiscountLocalizedContent": {
      "description": "Container for the language-specific name of the discount. You will have a container for each supported language\n(LocaleCode).\nThis enables you to display the discount name in multiple languages yet manage it as a single discount internally.",
      "properties": {
        "auditInfo": {
          "$ref": "#/$defs/AuditInfo"
        },
   

# --- truncated at 32 KB (34 KB total) ---
# Full source: https://artifacts.apis.io/kibo-commerce/json-schema/kibo-commerce-catalog-admins-discount-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/kibo-commerce-catalog-admins-discount"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.