Item Schema

Definition

An item schema defines the attributes that can be used in each item. You have to define the name of each attribute as well as its type. It's used for item validation.

Structure

Name	Type	Description
name	string	Name of the item type. Must be unique, not empty and can only include alphanumeric characters, underscores and hyphens.
tenant	string	Tenant of the account
environment	string	Environment to use
version	integer	Automatically created
attributes	list	see Attributes
nestedItemSchemas	list	see NestedItemSchemas

AttributesNested Item SchemasUsing the Item Schema API

Customers onboarding on Fredhopper, please refer also to the section below

Onboarding on/migrating to Fredhopper

Validation

Additional validations on schema:

• the name of the item schema should match "^[\w\-]+$" i.e. The item schema name must only contain Latin letters (both uppercase and lowercase): a-z, A-Z, digits: 0-9, hyphens: -

• a schema (and all the inner schemas) should have unique name