Kibo Commerce · Schema

CatalogAdminsProduct

Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.

CompanyCommerceE-CommerceHeadless CommerceOrder ManagementB2BConsumerInventoryFulfillment

Properties

Name Type Description
applicableDiscounts arraynull Read only. List of discounts that are available for a product.
auditInfo object
baseProductCode stringnull This is the base product ProductCode of a product that is a variation. It is read-only and only populated for products that are variations of a configurable base product.
bundledProducts arraynull list of other products that are included in a BundleProduct This requires that the ProductUsage be set to Bundle
content object
extras arraynull The Extras defined in the product Type that are currently assigned to this product
fulfillmentTypesSupported arraynull Indicates the fulfillment types the product supports.
hasConfigurableOptions boolean Read only. If true, this product has configurable options. The product is not purchasable until the shopper selects options that resolve to a product variation. System-supplied and read-only.
hasStandAloneOptions boolean Read only. If true, the product has stand-alone options that a shopper may select. System-supplied and read-only.
inventoryInfo object
isPackagedStandAlone booleannull Does this product need to be packaged on its own
isRecurring booleannull If true, the product can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.
isTaxable booleannull If true, the product is subject to tax.
isValidForProductType booleannull Read only flag that indicates if the product meets the product type constraints (All adminRequired attributes have a valid value)
isVariation boolean Read only. If true, this is a product variation of a product with configurable options. System-supplied and read-only.
localizedContent arraynull The content for each locale code supported by the master catalog
localizedSEOContent arraynull The default content SEO content of a product. This content is always in the default language of the MasterCatalog
masterCatalogId integernull Identifier of the Master Catalog that this product is a member of. System-supplied and read-only
options arraynull The Options defined in the product Type that are currently assigned to this product
packageHeight object
packageLength object
packageWeight object
packageWidth object
price object
pricingBehavior object
primaryProductCollectionCode stringnull When this product belongs to a product collection this is the product id for the primary collection.
productCode stringnull Merchant-created code identifier associated with the product, for example, a SKU or product item number.
productCollectionProducts arraynull list of other products that are members of a ProductCollection This requires that the ProductUsage be set to Collection
productCollections arraynull List of Mozu.ProductAdmin.Contracts.ProductCollectionInfo that this product belongs to
productImageGroups arraynull List of the image groups this product uses. Image groups are used to map different images to different product options. If the product doesn't have options then all images will be in the default image
productInCatalogs arraynull Catalog specific info for each catalog a product is valid in. There should always be one or more entries here.
productSequence integernull System generated monotonically increasing sequence
productTypeId integernull Unique identifier of the productType of the product. Refers to a valid ProductType that was previously created with the ProductType resource.
productUsage stringnull Indicates the usage type of this product. Must be one of the values in ProductUsageConst.
properties arraynull The Properties defined in the product Type that are currently assigned to this product
publishingInfo object
seoContent object
shippingClassId integernull
slicingSettings object
standAlonePackageType stringnull When packaged alone this is the package type
supplierInfo object
upc stringnull UPC code of the product.
variationKey stringnull Read only. If IsVariation true, thish provides a unique key to manage the variation of the base product.
variationOptions arraynull Read only List of variations that exist for a product. This is only populated when IsVariation is true. To get the list of options, the GET request must include the VariationOptions response group.
View JSON Schema on GitHub

JSON Schema

kibo-commerce-catalog-admins-product-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-product-schema.json",
  "title": "CatalogAdminsProduct",
  "description": "Use the Products resource to create and manage products for your store. You can create products with options that a shopper configures (such as a T-shirt color and size). The system can manage inventory for all combinations of your product options, and can calculate tax and shipping costs.",
  "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/CatalogAdminsProduct",
  "properties": {
    "applicableDiscounts": {
      "description": "Read only. List of discounts that are available for a product.",
      "items": {
        "$ref": "#/$defs/CatalogAdminsDiscount"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "auditInfo": {
      "$ref": "#/$defs/AuditInfo"
    },
    "baseProductCode": {
      "description": "This is the base product ProductCode of a product that is a variation. It is read-only and only populated for products that are variations of a configurable base product.",
      "type": [
        "string",
        "null"
      ]
    },
    "bundledProducts": {
      "description": "list of other products that are included in a BundleProduct\nThis requires that the ProductUsage be set to Bundle",
      "items": {
        "$ref": "#/$defs/CatalogAdminsBundledProduct"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "content": {
      "$ref": "#/$defs/ProductLocalizedContent"
    },
    "extras": {
      "description": "The Extras defined in the product Type that are currently assigned to this product",
      "items": {
        "$ref": "#/$defs/ProductExtra"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "fulfillmentTypesSupported": {
      "description": "Indicates the fulfillment types the product supports.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "hasConfigurableOptions": {
      "description": "Read only. If true, this product has configurable options. The product is not purchasable until the shopper selects options that resolve to a product variation. System-supplied and read-only.",
      "nullable": false,
      "type": "boolean"
    },
    "hasStandAloneOptions": {
      "description": "Read only. If true, the product has stand-alone options that a shopper may select. System-supplied and read-only.",
      "nullable": false,
      "type": "boolean"
    },
    "inventoryInfo": {
      "$ref": "#/$defs/ProductInventoryInfo"
    },
    "isPackagedStandAlone": {
      "description": "Does this product need to be packaged on its own",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isRecurring": {
      "description": "If true, the product can be purchased or fulfilled at regular intervals, for example, monthly billing or a subscription.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isTaxable": {
      "description": "If true, the product is subject to tax.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isValidForProductType": {
      "description": "Read only flag that indicates if the product meets the product type constraints (All adminRequired attributes have a valid value)",
      "type": [
        "boolean",
        "null"
      ]
    },
    "isVariation": {
      "description": "Read only. If true, this is a product variation of a product with configurable options. System-supplied and read-only.",
      "nullable": false,
      "type": "boolean"
    },
    "localizedContent": {
      "description": "The content for each locale code supported by the master catalog",
      "items": {
        "$ref": "#/$defs/ProductLocalizedContent"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "localizedSEOContent": {
      "description": "The default content SEO content of a product. This content is always in the default language of the MasterCatalog",
      "items": {
        "$ref": "#/$defs/ProductLocalizedSEOContent"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "masterCatalogId": {
      "description": "Identifier of the Master Catalog that this product is a member of. System-supplied and read-only",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "options": {
      "description": "The Options defined in the product Type that are currently assigned to this product",
      "items": {
        "$ref": "#/$defs/CatalogAdminsProductOption"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "packageHeight": {
      "$ref": "#/$defs/Measurement"
    },
    "packageLength": {
      "$ref": "#/$defs/Measurement"
    },
    "packageWeight": {
      "$ref": "#/$defs/Measurement"
    },
    "packageWidth": {
      "$ref": "#/$defs/Measurement"
    },
    "price": {
      "$ref": "#/$defs/CatalogAdminsProductPrice"
    },
    "pricingBehavior": {
      "$ref": "#/$defs/ProductPricingBehaviorInfo"
    },
    "primaryProductCollectionCode": {
      "description": "When this product belongs to a product collection this is the product id for the primary collection.",
      "type": [
        "string",
        "null"
      ]
    },
    "productCode": {
      "description": "Merchant-created code identifier associated with the product, for example, a SKU or product item number.",
      "type": [
        "string",
        "null"
      ]
    },
    "productCollectionProducts": {
      "description": "list of other products that are members of a ProductCollection\nThis requires that the ProductUsage be set to Collection",
      "items": {
        "$ref": "#/$defs/ProductCollectionProduct"
      },
      "maxItems": 35,
      "type": [
        "array",
        "null"
      ]
    },
    "productCollections": {
      "description": "List of Mozu.ProductAdmin.Contracts.ProductCollectionInfo that this product belongs to",
      "items": {
        "$ref": "#/$defs/ProductCollectionInfo"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "productImageGroups": {
      "description": "List of the image groups this product uses.\nImage groups are used to map different images to different product options.\nIf the product doesn't have options then all images will be in the default\nimage group.",
      "items": {
        "$ref": "#/$defs/ProductImageGroup"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "productInCatalogs": {
      "description": "Catalog specific info for each catalog a product is valid in. There should always be one or more entries here.",
      "items": {
        "$ref": "#/$defs/ProductInCatalogInfo"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "productSequence": {
      "description": "System generated monotonically increasing sequence",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "productTypeId": {
      "description": "Unique identifier of the productType of the product. Refers to a valid ProductType that was previously created with the ProductType resource.",
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "productUsage": {
      "description": "Indicates the usage type of this product. Must be one of the values in ProductUsageConst.",
      "type": [
        "string",
        "null"
      ]
    },
    "properties": {
      "description": "The Properties defined in the product Type that are currently assigned to this product",
      "items": {
        "$ref": "#/$defs/CatalogAdminsProductProperty"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "publishingInfo": {
      "$ref": "#/$defs/ProductPublishingInfo"
    },
    "seoContent": {
      "$ref": "#/$defs/ProductLocalizedSEOContent"
    },
    "shippingClassId": {
      "format": "int32",
      "type": [
        "integer",
        "null"
      ]
    },
    "slicingSettings": {
      "$ref": "#/$defs/SlicingSettings"
    },
    "standAlonePackageType": {
      "description": "When packaged alone this is the package type",
      "type": [
        "string",
        "null"
      ]
    },
    "supplierInfo": {
      "$ref": "#/$defs/ProductSupplierInfo"
    },
    "upc": {
      "description": "UPC code of the product.",
      "type": [
        "string",
        "null"
      ]
    },
    "variationKey": {
      "description": "Read only. If IsVariation true, thish provides a unique key to manage the variation of the base product.",
      "type": [
        "string",
        "null"
      ]
    },
    "variationOptions": {
      "description": "Read only List of variations that exist for a product. This is only populated when IsVariation is true. To get the list of options, the GET request must include the VariationOptions response group.",
      "items": {
        "$ref": "#/$defs/ProductVariationOption"
      },
      "type": [
        "array",
        "null"
      ]
    }
  },
  "type": "object",
  "$defs": {
    "AttributeVocabularyValueLocalizedContent": {
      "description": "Attribute Value Localized Resource",
      "properties": {
        "localeCode": {
          "description": "Language used for the string attribute value. Currently, only en_US is supported.",
          "type": [
            "string",
            "null"
          ]
        },
        "stringValue": {
          "description": "Localized Value in the language of the locale code",
          "minLength": 1,
          "nullable": false,
          "type": "string"
        }
      },
      "type": "object"
    },
    "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"
    },
    "CatalogAdminsActiveDateRange": {
      "description": "Active Effectivity Dates",
      "properties": {
        "endDate": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        },
        "startDate": {
          "format": "date-time",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "CatalogAdminsAttributeVocabularyValue": {
      "description": "Value of an attribute",
      "properties": {
        "content": {
          "$ref": "#/$defs/AttributeVocabularyValueLocalizedContent"
        },
        "displayOrder": {
          "description": "The order in which the attribute value displays. If you omit a value for this property, Mozu infers the display order from the attribute value's position the list.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        },
        "localizedContent": {
          "description": "The Content of an attribute value. This content is in multiple locals supported by the master catalog and is only valid for String DataType.",
          "items": {
            "$ref": "#/$defs/AttributeVocabularyValueLocalizedContent"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "mappedGenericValues": {
          "description": "The actual values of the related generic attribute. This value must match the datatype of the attribute and already exist \nwithin the Vocabulary values of the related ValueMappingAttribute. Only supporting string at this time.",
          "items": {},
          "maxItems": 200,
          "type": [
            "array",
            "null"
          ]
        },
        "productName": {
          "description": "The ProductName when the Attribute DataType is ProductCode.",
          "type": [
            "string",
            "null"
          ]
        },
        "value": {
          "description": "The actual value of the attribute vocabulary. This value must be unique within the vocabulary for a single attribute and match the datatype of the attribute. \nString data type requires a canonical value here or one will be system generated if null. The actual string content displayed to users should be stored as Content. \nString values require content to be present.\nOnce this value is set it cannot be changed.",
          "maxLength": 50,
          "nullable": false,
          "pattern": "^[A-Za-z0-9-_\\.()]*[A-Za-z0-9-_()]"
        },
        "valueSequence": {
          "description": "Read only System generated monotonically increasing unique sequence.",
          "format": "int32",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "CatalogAdminsBundledProduct": {
      "description": "Price of the product and currency used.",
      "properties": {
        "fulfillmentTypesSupported": {
          "description": "Indicates the fulfillment types the product supports.",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "packageHeight": {
          "$ref": "#/$defs/Measurement"
        },
        "packageLength": {
          "$ref": "#/$defs/Measurement"
        },
        "packageWeight": {
          "$ref": "#/$defs/Measurement"
        },
        "packageWidth": {
          "$ref": "#/$defs/Measurement"
        },
        "price": {
          "$ref": "#/$defs/CatalogAdminsProductPrice"
        },
        "productCode": {
          "description": "Product Code",
          "type": [
            "string",
            "null"
          ]
        },
        "productName": {
          "description": "Read only Name of the BundledProduct",
          "type": [
            "string",
            "null"
          ]
        },
        "quantity": {
          "description": "Qty of the bundled PRoduct",
          "format": "int32",
          "nullable": false,
          "type": "integer"
        }
      },
      "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"
    },
    "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.",
      "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"
    },
    "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 disco

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://artifacts.apis.io/kibo-commerce/json-schema/kibo-commerce-catalog-admins-product-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-product"
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.