latest--schema-0.3.0

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/common-catalog-data/_shared/latest--schema-0.3.0.json
Parent schema common-catalog-data
Type: object

Represents a Common Schema for any Catalog Data This is used for a full relationship declaration in the menu service

Properties

classifications Classification[]

Classification Data and how different classifications relates to one another

concepts Concept[]

All abstract concepts that ties different concrete items or abstract values together this is also used to create complex mappings between different concrete items

items ItemDefinition[]

All concrete items in a catalog (usually each item tied to a specific sku)

title string

Title of the data

Definitions

AddOn object

Represents an AddOn in an Item Definition

attributes Attribute[]
choiceType string
Values: "option" "range"
itemId string

Id of the Item

pattern=^[A-Za-z0-9_\-]+$
option ConceptOption | RangeOption
target string
Values: "replace" "supplement"
AddOnChoiceType string
Attribute object

Represents an Attribute

conceptId string

Id of the Concept

pattern=^[A-Za-z0-9_\-]+$
isDefault boolean
value string | number | boolean
Choice object

Represents a Choice in a Item Definition

choiceValues ChoiceValue[]
conceptId string

Id of the Concept

pattern=^[A-Za-z0-9_\-]+$
defaultQuantity number
maxQuantity number
minQuantity number
required boolean
selectType string
Values: "multiple" "single"
target string
Values: "replace" "supplement"
ChoiceValue object
data Record<string, string | number | boolean>

This is a data object that is tied to the value, for the item

value string

value is the associated value in the concept (pointed by the conceptId)

Classification object

Represents a specific classification

id string

An unique id for the classification

pattern=^[A-Za-z0-9_\-]+$
name string

Proper classification name

parent string

The Id of its parent classification If parent is not present, that means the classification is a top-level classification

synonyms string[]

A list of common names for this classification

ClassificationItem object
classificationId string

Id of the Classification

pattern=^[A-Za-z0-9_\-]+$
Component object

Represents a Component A Component is a concrete item that makes up another concrete item

attribute QuantityAttribute | ConceptAttribute
itemId string

Id of the Item

pattern=^[A-Za-z0-9_\-]+$
type string
Values: "concept" "quantity"
ComponentType string
Concept object

Represents a Concept

displayName string

Proper name

id string

An unique id for the concept

pattern=^[A-Za-z0-9_\-]+$
quantity object
3 nested properties
incrementBy number
maxQuantity number
minQuantity number
type string
Values: "discrete" "discrete-ordered" "quantity"
values DiscreteItem[]

The list of values

ConceptAttribute object
conceptId string
defaultValue string
ConceptOption object
conceptId string
defaultValue string
optionValues OptionValue[]
ConceptType string
Customization object

Represents a Customization Option which points to a Concept Customization changes the aspect (associated concept) of a Component or an AddOn

conceptId string

Id of the Concept

pattern=^[A-Za-z0-9_\-]+$
defaultQuantity number
maxQuantity number
minQuantity number
DiscreteItem object

Represents a Text Value in a Concept

associatedItemId string

An unique id for the item associated with the item

pattern=^[A-Za-z0-9_\-]+$
synonyms string[]
value string
ItemDefinition object

Represents a concrete item and all its attributes and relationships

addOns AddOn[]
choices Choice[]
classifications ClassificationItem[]
commonNames string[]
components Component[]
customizations Customization[]
disambiguationAttributes Attribute[]
displayName string
id string

Id of the item

pattern=^[A-Za-z0-9_\-]+$
metadata Metadata[]
Metadata object
name string
value string | number | boolean
OptionValue object
data Record<string, string | number | boolean>
value string
QuantityAttribute object
defaultQuantity number
maxQuantity number
minQuantity number
QuantityValue object
incrementBy number
maxQuantity number
minQuantity number
RangeOption object

Represents a Range Option

defaultQuantity number
incrementBy number
maxQuantity number
minQuantity number
SelectType string
Target string