Configuration

What is a Project?

In Omnium, a project is a flexible framework used to collect and structure information. Projects support any process that spans beyond a single order. They can be used for simple tasks such as collecting and tracking leads, or for more complex workflows like designing and building a kitchen.

Project Types

Every project in Omnium is defined by a project type. The project type determines the structure and behavior of the project, including:

• Statuses and workflow steps
• Notification templates
• Custom dashboards
• Properties and checklists
• Other project-specific configurations

A project type is similar to an order type in Omnium—the key difference is that it specifies rules and settings for projects instead of orders.

Statuses

Statuses define the different steps in a project workflow. By setting up statuses, you create a clear progression for how projects move from start to finish.

Each status can be configured to support project execution, for example:

• Triggering notifications
• Running workflow actions (similar to order workflows)
• Setting deadlines
• Adding checklists
• Displaying custom dashboards

Notifications

Notifications are configured per project type using Omnium’s email template designer. Each notification is tied to a project status and is triggered automatically when that status is reached.

Product Tokens in Email Templates

Project notification templates support a product repeater for rendering the list of products associated with a project. This is useful for claim notifications that need to list the affected products with their status and reason codes.

Repeater syntax:

{#PRODUCT_REPEAT}
  Product: {PRODUCT_NAME} (SKU: {PRODUCT_SKU_ID})
  Status: {PRODUCT_STATUS}
  Reason: {PRODUCT_CANCELLATION_CODE} - {PRODUCT_CANCELLATION_REASON}
{/PRODUCT_REPEAT}

Available product tokens (inside the repeater):

These tokens are available in the email template designer under the Project products merge tag group when editing project notification templates.

Project Information

Projects in Omnium can contain a wide range of information. Not every option is required for every project type, but the table below shows the most common types of information:

Project Products

Projects can include a list of products, providing per-product tracking for claims, complaints, and other project types.

Per-Product Fields

Each product in a project supports the following fields beyond the basic product reference:

Cancellation Codes for Products

Product-level cancellation codes are sourced from Order Settings > Order Line Settings > Cancellation Types in the tenant configuration. These are the same codes used for order line cancellations.

Managing Products via API

Products can be managed through:

• PUT / PATCH project endpoints — include the products array in the request body
• UpdateProjectProductStatus endpoint — update status and cancellation codes per product without replacing the full product list

See API Reference for endpoint details and examples.

Project Planning

The Omnium UI includes a project calendar to help with planning and execution.

Setup

1. Set a capacity cost on a project type.
2. Define store project capacity (Stores → Date Planner → Default Project Capacity).

Using the Calendar

From the project calendar, you can:

• Create projects directly by clicking on a date.
• View all projects planned for each day.
• See store-specific capacity and availability (if a store is selected in the global store selector).

Dashboards and Custom Views

Projects in Omnium support dashboards and custom views to provide tailored insights.

A project is the hub for all activities carried out over a period of time. Common use cases include:

• Returns and claim workflows
• Long-running sales processes
• Selling and delivering services

Projects tie together carts, orders, returns, and all other relevant data needed for effective project management.

Use Cases

Claims and Returns

One of the most common uses of projects in Omnium is handling customer claims and returns. Projects provide a structured way to track, process, and follow up on these cases.

When you create a return in Omnium, you can also create a linked claim project by selecting the appropriate project type. The claim project is automatically connected to the order, making it easy to manage both the return process and its related complaint in one place.

This allows customer service teams to:

• Get a full overview of the claim history.
• Ensure no steps are missed in the follow-up process.
• Maintain clear communication with customers about the progress of their claim.

Service Projects

Omnium projects can also be used to manage repair and maintenance services.

For example, a sports shop offering bicycle repairs can define a BikeRepair project type. The workflow may include the following statuses:

Each BikeRepair project can be assigned a capacity cost, and each store can configure its daily service capacity. With this setup, the project calendar helps staff plan and allocate work based on availability, reducing bottlenecks and improving turnaround times.

Kitchen Sales and Installations

Another powerful use case is managing large, multi-step projects, such as selling and installing a new kitchen.

These projects involve many moving parts—multiple product orders, deliveries, subcontractors (such as carpenters, electricians, and plumbers), and ongoing customer communication.

A project type called KitchenInstallation could include statuses such as:

Using projects for this type of workflow provides:

• A single hub connecting all related orders, deliveries, and sub-contractors.
• Clear task management across multiple stakeholders.
• A timeline view in the project calendar to ensure coordination between delivery and installation.
• A communication log (customer, partner, internal) to keep everyone aligned throughout the project.

This makes projects in Omnium especially useful for businesses where sales and services overlap and where customer satisfaction depends on smooth execution across several teams.