Salsify: Most-used fields

Salsify: Most-used fields#

The table below gives information about most-used fields that you can import from Salsify. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name

Adverity UI name

Description

Use in Adverity

Taxonomy

Taxonomy

Categorization of the product within a hierarchical structure, used for organizing and classifying products.

dimension

activated_at

activated_at

The timestamp indicating when a product or record was officially activated or made live within the Salsify platform. This could represent the moment it became available for distribution or sale.

dimension

archived

archived

Indicates whether a product’s lifecycle status is ‘Archived’. This status signifies that a product is no longer actively managed or available, but its data is retained.

dimension

base_price

base_price

The standard or base selling price of the product before any discounts or promotions.

dimension

brand_name

brand_name

The name of the brand associated with the product.

dimension

campaign_landscape_media.de-DE

campaign_landscape_media.de-DE

URL or identifier for landscape-oriented media assets used in marketing campaigns for the German market.

dimension

campaign_landscape_media.en-GB

campaign_landscape_media.en-GB

URL or identifier for landscape-oriented media assets used in marketing campaigns for the UK market.

dimension

campaign_message_line.de-DE

campaign_message_line.de-DE

Short marketing message or tagline for campaigns targeted at the German market.

dimension

campaign_message_line.en-GB

campaign_message_line.en-GB

Short marketing message or tagline for campaigns targeted at the UK market.

dimension

campaign_portrait_media.de-DE

campaign_portrait_media.de-DE

URL or identifier for portrait-oriented media assets used in marketing campaigns for the German market.

dimension

campaign_portrait_media.en-GB

campaign_portrait_media.en-GB

URL or identifier for portrait-oriented media assets used in marketing campaigns for the UK market.

dimension

color

color

The color of the product.

dimension

color_display

color_display

The human-readable display name for the product’s color.

dimension

color_variant

color_variant

A specific variant of the product based on its color.

dimension

color_variants

color_variants

A collection or list of available color variants for the product.

dimension

contains_batteries

contains_batteries

A boolean indicator that specifies if the product contains batteries. This is often used for compliance, shipping regulations, or consumer information.

dimension

created_at

created_at

The timestamp when the product record was initially created.

dimension

created_at_date

created_at_date

The date when the product record was initially created.

dimension

details

details

Detailed description or specifications of the product.

dimension

discount_price

discount_price

The promotional or discounted selling price of the product.

dimension

ean

ean

The European Article Number (EAN) for the product, a unique product identifier.

metric

electronic_item

electronic_item

A boolean indicator that specifies if the product is classified as an electronic item. This can be important for categorization, regulatory compliance, or marketing.

dimension

hs_code

hs_code

The Harmonized System (HS) code for the product, used for customs and trade.

dimension

is_electronic_item

is_electronic_item

A boolean indicator that specifies if the product is classified as an electronic item. This field serves a similar purpose to ‘electronic_item’ and may be an alias or a related attribute.

metric

is_private_label

is_private_label

A boolean indicator that specifies if the product is a private label brand, meaning it is exclusively manufactured for a specific retailer or company.

dimension

list_price

list_price

The suggested retail price or manufacturer’s list price for the product.

metric

manual_shopify_collection_url.it-IT

manual_shopify_collection_url.it-IT

Manually assigned Shopify collection URL for the product, specific to the Italian market.

dimension

manufacturer_country

manufacturer_country

The country where the product was manufactured.

dimension

master_sku

master_sku

The Stock Keeping Unit (SKU) for the master product, representing a group of variants.

dimension

master_sku_computed

master_sku_computed

A system-generated or computed Stock Keeping Unit (SKU) for the master product.

dimension

material

material

The primary material composition of the product.

dimension

material_variant

material_variant

A specific variant of the product based on its material.

dimension

measures

measures

Dimensions or other quantifiable measurements of the product.

dimension

name

name

The primary name of the product.

dimension

name.de-DE

name.de-DE

The product name for the German market.

dimension

name.en-GB

name.en-GB

The product name for the UK market.

dimension

name.it-IT

name.it-IT

The product name for the Italian market.

dimension

name_variant

name_variant

A descriptive name for a specific product variant.

dimension

net_weight

net_weight

The net weight of the product, excluding packaging.

metric

new_product

new_product

A boolean indicator that signifies if the product is a new introduction to the market or the product catalog, often used for promotional purposes.

dimension

number_separate_packages

number_separate_packages

The total number of separate packages included when shipping the product.

dimension

package_height

package_height

The height of the product’s packaging.

dimension

package_length

package_length

The length of the product’s packaging.

dimension

package_units

package_units

The number of individual units contained within a single package.

metric

package_weight

package_weight

The weight of the product’s packaging, including the product.

metric

package_width

package_width

The width of the product’s packaging.

dimension

packaging_size

packaging_size

The overall dimensions or size of the product’s packaging.

dimension

pdp_url

pdp_url

The URL to the Product Detail Page (PDP) for the product.

dimension

photo_credit.de-DE

photo_credit.de-DE

Attribution or credit for the photographic media used for the German market.

dimension

photo_credit.en-GB

photo_credit.en-GB

Attribution or credit for the photographic media used for the UK market.

dimension

photo_credit.es-ES

photo_credit.es-ES

Attribution or credit for the photographic media used for the Spanish market.

dimension

private_label_product

private_label_product

A boolean indicator that specifies if the product is a private label brand, similar to ‘is_private_label’, indicating it is manufactured for a specific retailer.

dimension

product_class

product_class

The classification or category of the product.

metric

production_approved

production_approved

A boolean indicator that denotes whether the product has received final approval to proceed with production or manufacturing.

dimension

quantity

quantity

The numerical quantity of the product.

metric

regular_price

regular_price

The standard selling price of the product before any discounts, promotions, or special offers are applied.

dimension

salsify:created_at

salsify:created_at

The timestamp when the Salsify record was created.

dimension

salsify:digital_assets

salsify:digital_assets

References to digital assets (images, videos, documents) associated with the Salsify record.

dimension

salsify:id

salsify:id

The unique identifier assigned to the record within Salsify.

dimension

salsify:parent_id

salsify:parent_id

The unique identifier of the parent record in a hierarchical product structure within Salsify.

dimension

salsify:profile_asset_id

salsify:profile_asset_id

The unique identifier for the main profile asset associated with the Salsify record.

dimension

salsify:system_id

salsify:system_id

A system-generated unique identifier for the Salsify record.

dimension

salsify:updated_at

salsify:updated_at

The timestamp when the Salsify record was last updated.

dimension

salsify:version

salsify:version

The version number of the Salsify record, indicating changes over time.

metric

seasonality

seasonality

Describes the seasonal relevance of a product, indicating if it is primarily sold or marketed during specific seasons of the year.

dimension

shipping_size

shipping_size

The size classification for shipping purposes (e.g., small, medium, large).

dimension

shipping_size_computed

shipping_size_computed

System-computed size classification for shipping purposes.

dimension

shopify_collection_url.de-DE

shopify_collection_url.de-DE

The URL to the Shopify collection where the product is featured for the German market.

dimension

shopify_collection_url.en-GB

shopify_collection_url.en-GB

The URL to the Shopify collection where the product is featured for the UK market.

dimension

shopify_collection_url.it-IT

shopify_collection_url.it-IT

The URL to the Shopify collection where the product is featured for the Italian market.

dimension

sku

sku

The Stock Keeping Unit (SKU), a unique identifier for a specific product variant.

dimension

sku_type

sku_type

The classification or type of Stock Keeping Unit (SKU).

dimension

supplier_currency

supplier_currency

The currency used by the supplier for pricing.

dimension

supplier_name

supplier_name

The name of the supplier providing the product.

dimension

supplier_product_name

supplier_product_name

The name of the product as provided by the supplier.

dimension

supplier_product_number

supplier_product_number

The unique product identifier assigned by the supplier.

dimension

supplier_reference

supplier_reference

A reference code or identifier provided by the supplier.

dimension

supplier_set_units

supplier_set_units

The number of units set by the supplier in a specific offering.

metric

supplier_status

supplier_status

The current status of the product from the supplier’s perspective (e.g., active, discontinued).

dimension

supplier_unit_base_price

supplier_unit_base_price

The base price per unit as specified by the supplier.

metric

supplier_unit_price

supplier_unit_price

The selling price per unit as specified by the supplier.

metric

sustainable_label

sustainable_label

A boolean indicator that specifies if the product has a recognized sustainable or eco-friendly label, highlighting its environmental attributes.

dimension

total_package_volume

total_package_volume

The total volume of the product’s packaging.

dimension

total_package_weight

total_package_weight

The combined weight of the product and its packaging.

metric

updated_at_date

updated_at_date

The date when the product record was last updated.

dimension

variant_hash

variant_hash

A unique hash identifier for a specific product variant.

dimension

variant_size

variant_size

The size attribute for a specific product variant.

dimension

variant_status

variant_status

The current status of a specific product variant (e.g., in stock, out of stock).

dimension

video_data

video_data

Structured data related to product videos, such as metadata or embed codes.

dimension

video_url

video_url

The URL to a video associated with the product.

dimension