Optimizely · Schema

CatalogEntry

A catalog entry (product, variant, package, or bundle)

A/B TestingContent ManagementCustomer DataE-CommerceExperimentationFeature FlagsMarketing

Properties

Name Type Description
code string Unique code for the catalog entry
name string Display name of the entry
entry_type string Type of catalog entry
start_date string Availability start date
end_date string Availability end date
is_active boolean Whether the entry is active
properties object Dynamic properties specific to the entry type
prices array Price information for the entry
View JSON Schema on GitHub

JSON Schema

optimizely-catalogentry-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CatalogEntry",
  "title": "CatalogEntry",
  "type": "object",
  "description": "A catalog entry (product, variant, package, or bundle)",
  "properties": {
    "code": {
      "type": "string",
      "description": "Unique code for the catalog entry"
    },
    "name": {
      "type": "string",
      "description": "Display name of the entry"
    },
    "entry_type": {
      "type": "string",
      "description": "Type of catalog entry",
      "enum": [
        "Product",
        "Variation",
        "Package",
        "Bundle"
      ]
    },
    "start_date": {
      "type": "string",
      "format": "date-time",
      "description": "Availability start date"
    },
    "end_date": {
      "type": "string",
      "format": "date-time",
      "description": "Availability end date"
    },
    "is_active": {
      "type": "boolean",
      "description": "Whether the entry is active"
    },
    "properties": {
      "type": "object",
      "description": "Dynamic properties specific to the entry type",
      "additionalProperties": true
    },
    "prices": {
      "type": "array",
      "description": "Price information for the entry",
      "items": {
        "type": "object",
        "properties": {
          "currency": {
            "type": "string",
            "description": "Currency code"
          },
          "amount": {
            "type": "number",
            "description": "Price amount"
          },
          "market_id": {
            "type": "string",
            "description": "Market identifier"
          }
        }
      }
    }
  }
}