Completeness
Completeness attributes measure how much of a product's required data has been filled in. They provide a visual progress indicator on the product editor, helping your team identify products that need attention before publishing.
How completeness works
A completeness attribute is a special attribute type that doesn't store product data directly. Instead, it defines a set of conditions — each condition checks whether a specific piece of product data exists. The completeness score is calculated automatically based on how many conditions are met.
The score appears as a visual indicator on the product overview page and as a column on the product list.
Creating a completeness attribute
- Go to Products → Attributes and click Create Attribute.
- Set the type to Completeness.
- Set the appearance to Bars (progress bar visualization).
- Click Create Attribute.
- Open the attribute and go to the Completeness tab to configure conditions.
Configuring completeness conditions
Each completeness attribute has a list of conditions. Every condition checks whether a specific piece of data exists on the product.
Adding a condition
- In the completeness attribute editor, go to the Completeness tab.
- Click Add Condition.
- Configure the condition:
| Field | Required | Description |
|---|---|---|
| Type | Yes | What kind of data to check — System, Attribute, or Asset. |
| Target | Yes | The specific field or attribute to check. Options depend on the type selected. |
| Required Locales | No | Which languages must have a value. Leave empty to require any value (or non-localized value). |
Condition types
System conditions
Check built-in product fields:
| Target | Description |
|---|---|
| Product Name | Checks that the product has a name. |
| Handle (URL) | Checks that the URL slug is set. |
| SKU | Checks that the SKU is filled. |
| Status | Checks that the status is set. |
| Brand / Manufacturer | Checks that the brand field is filled. |
Attribute conditions
Check any product attribute by searching and selecting from your attribute list. The search shows attribute name and code. The condition passes when the attribute has a non-empty value.
For localized attributes, specify required locales to check that specific languages are filled. If no locales are specified, having a value in any locale is sufficient.
Asset conditions
Check that the product has media files attached:
| Target | Description |
|---|---|
| Any Asset | At least one asset of any type. |
| Image | At least one image file. |
| Video | At least one video file. |
| Document | At least one document file. |
Removing a condition
Click the trash button on any condition to remove it.
How the completeness score is calculated
The score is a percentage based on conditions met vs. total conditions:
$$\text{Completeness} = \frac{\text{Conditions met}}{\text{Total conditions}} \times 100$$
Color coding
| Score | Color | Meaning |
|---|---|---|
| 100% | Green | Product is fully complete. |
| 50–99% | Yellow/Warning | Some data is missing. |
| 0–49% | Red | Significant data is missing. |
Condition evaluation
For each condition, the system checks:
- System fields — Whether the product has a non-empty value for the field. For localized fields (like name), it checks the required locales.
- Attributes — Whether the attribute has a non-empty value. Respects localization settings and required locale configuration.
- Assets — Whether the product has at least one matching asset type.
Where completeness appears
Product overview
The completeness indicator appears in the right column of the product overview page, above the definition card. It shows a per-condition breakdown with:
- Condition name
- Whether it's completed (✓) or missing (✗)
- A message explaining what's needed
Product list
The product list table can include completeness columns — one column per completeness attribute. This lets you quickly scan your catalog for products that need attention.
Attribute list filters
On the product editor's attribute list, you can filter by completeness groups to show only the attributes tracked by a specific completeness attribute. This helps focus editing on the fields that matter for completeness.
Multiple completeness attributes
You can create multiple completeness attributes to track different aspects of product readiness:
- Publishing readiness — Check that title, description, images, and price exist.
- SEO completeness — Check that meta titles, meta descriptions, and handles are filled.
- Marketplace readiness — Check that all required marketplace fields are present.
Each completeness attribute is independent and appears as its own indicator on the product.
Best practices
- Start with a "Publishing readiness" attribute — Define the minimum conditions a product must meet before publishing.
- Use required locales strategically — Only require locales that you actively sell in. Requiring all locales can prevent publishing in markets where you do have complete data.
- Check assets — Include at least "Any Asset" or "Image" as a condition. Products without images rarely perform well.
- Review completeness on the product list — Use the completeness columns to identify products that need attention before a launch.
- Keep conditions achievable — A completeness attribute with 50 conditions will leave most products at low scores, which can be discouraging. Focus on the truly important fields.