Properties hold values for:

product values
property metadata
digital asset metadata

System metadata is prefixed with salsify:. You can add custom metadata to properties and digital asset entities.

Metadata is handled in pairs: {metadata_id}:{metadata_value} where metadata_id is the Salsify Property ID, and {metadata_value} is the value stored for the entity.

When storing metadata values, metadata IDs that do not already exist in Salsify will be auto created when referenced in any API call.

Metadata ID Usage

Metadata IDs are:

case sensitive
string
snake case
User-defined, custom metadata cannot begin with salsify, =, or _
System metadata properties are prefixed with salsify:

Metadata Property Types

Custom metadata values can be stored in any available Property type. Metadata properties created during an action other than creating a Property will be string type by default, and can be changed to other types.

System Property Metadata

attribute	description	user editable
salsify:id string	Unique identifier for property. Can be altered. Cannot begin with `=`, `_`, or `salsify`.	Y
salsify:name string	Property label used inside Salsify. Best practice is to make name and id the same value. If not specified when ID is created, ID value will be used as name.	Y
salsify:data_type enumerated	Contains the type of property. Use caution when adjusting the data type. In some cases, changing the data type can impact channel output and property values. See table below for allowed values and definitions. Default is `string`.	Y
salsify:is_facetable boolean	Allows a string field to suggest existing values based on what the user has typed. Changing to `no` disables this function for a property. Default value is `yes`.	Y
salsify:attribute_group string	The property group displayed on the product details page. Set property group to organize your product data. Default is `Unassigned`.	Y
salsify:position integer	Determines the order in which properties appear on the product details page. Numbering is specific to a property group. The lowest number is at the top of the page, and ascending numbers are displayed in order down the page. Default is null.	Y
salsify:help_text string	When filled, whatever is in the column in your spreadsheet all appear as help text on the product details page, indicated by a question mark symbol after the entry. Default is null.	Y
salsify:searchable boolean	Indicates whether or not search is enabled for the main menu search box, product property search, and digital asset metadata search. Default is `No` for all properties except salsify:id and salsify:name. Changes to salsify:id and salsify:name will be ignored.	Y
salsify:manage_permissions enumerated	Array of user group names with non-default manage property-level permission. Default is null.	Y
salsify:read_permissions enumerated	Array of user group names with non-default read property-level permission. Default is null.	Y
salsify:type enumerated	Filled in automatically by Salsify and notes whether it's a standard or computed property. Default value is `property`.	Y
salsify:formula string	Contains the formula for computed properties. Default is null.	Y
salsify:hidden_permissions enumerated	Array of user group names with non-default no access property-level permission. Default is null.	Y
salsify:entity_types enumerated	Lists the types of entities a property is associated with (ie. products, digital assets, properties). System setting that updates automatically as properties are assigned to entities.	N
salsify:created_at date	Date property was created, in UTC. Format: YYYY-MM-DDTHH:MM:SS.MSZ	N
salsify:updated_at date	Date property metadata was most recently updated, in UTC. Format: YYYY-MM-DDTHH:MM:SS.MSZ	N
salsify:system_id string	Unique, permanent identifier for property. System ID does not change with updates to the value in the property ID.	N

salsify:data_type Property Type Values

attribute	description
string	Stores plain-text, alphabetical, and numeric characters without any special formatting.
number	Accepts only numeric characters, and is used for numeric data such as weight, dimensions, and quantity.
enumerated	Accepts plain text, alpha numeric characters, hierarchical, and is a fixed set of values.
boolean	Accepts y, yes, n, no, true, false, not case sensitive
date	Date-formatted properties accept only dates, and are typically used for deadlines or activation dates. Data format is YYYY-MM-DD.
html	Stores HTML formatting with property value. Previews in Salsify interface with HTML applied without styling.
rich_text	Stores property values with formatting like bold, underline, italics, bullet points and numbered lists.
link	Creates property with clickable text. The link text creates the URL the text will link to automatically and is clickable from the Salsify interface and catalogs.
digital_asset	Special field type to store any digital asset file. Most image file types preview inside Salsify, are able to be viewed in catalogs and can be renamed and transformed via Salsify channel exports. File types like pdf and other document formats can be stored and downloaded but not previewed.

salsify:type Values

attribute	description
property	Standard property type.
computed_property	Holds a formula which calculates a value for the property. Click here for more on computed properties.

salsify:entity_types Values

attribute	description
products	Attributes associated with products.
properties	Attributes associated with other properties.
digital_assets	Attributes associated with digital assets.

manage_permissions, read_permissions, hidden_permissions Values

For all property permission types, values are a comma-separated array of user groups where property permission is overridden to the permission type specified. User group values are user-defined in each workspace, with the exception of Administrators group which cannot be modified. Go to Manage Organization in your workspace for its current list of groups.

In all cases, if no permission is specified, property will retain the user group permission set. Note that the Administrators group is static, cannot be overridden or removed, and retains manage permission for all options.