For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
  • Getting Started
    • Introduction
    • Getting Started
    • Tia — Operations Assistant
    • Architecture
    • Security Architecture
  • Onboarding & Plans
    • Onboarding Overview
    • Plans & Subscriptions
    • Tia Credits
  • Tenancy & Governance
    • Roles & Members
    • Audit Log
    • Notifications
    • Economic Operators
  • Authoring Studios
    • Content Studio
    • Theme Studio
    • Advanced Studio (Track B)
  • Product Module
    • Products
    • Custom Fields
    • Global Search
    • Identifiers
    • Product Import
    • Bulk Editing
    • Bulk Updates
    • Resolver & GS1 Digital Link
    • GS1 Digital Link Contract
  • Localisations
    • Overview
    • Market Packs
    • Multilingual Content
  • Domains & Custom Hostnames
    • Domain Architecture
    • Resolver Domain Flow
    • Custom Hostname Setup
    • DNS Setup Guide
    • Resolver & Passport Rendering
    • Custom Hostname Lifecycle
    • Troubleshooting
  • Passports
    • Overview
    • Passport Operations
    • Lifecycle States
    • Controlled Update & Break-Glass
    • Content & Templates
    • Themes & Presentation
    • Consumer Experience
    • Publication Lifecycle
    • Brand Setup & Readiness
    • Drafts
  • Passport Intelligence
    • Passport Intelligence
    • Intelligence Overview
    • Scan Visibility
    • Trust Signals
    • Engagement Insights
    • Investigation Timelines
    • Data & Privacy
    • Roadmap
  • Minting
    • Overview
    • Lifecycle
    • Architecture
    • Limits & Performance
    • Token Preview
    • Exports & Print Jobs
    • Carrier Output Profiles
    • Bring-Your-Own Serials
    • Security
    • FAQ
  • API Reference
    • API Credentials Guide
    • API: Credentials
    • API: Products
    • API: Identifiers
    • API: Import
    • API: Batches
    • API: Attachments
    • API: Bulk Updates
    • API: Minting
    • API: Resolver
    • API: Search
On this page
  • What Custom Fields Do
  • Who It’s For
  • How It Works
  • Defining Custom Fields
  • Scope Levels
  • Data Types
  • Custom Fields in Passports
  • Custom Fields in Product Detail
  • Three-Layer Data Model
  • Limits & Notes
  • FAQ
  • Related Docs
Product Module

Custom Fields

Was this page helpful?
Previous

Global Search

Next
Built with

Every brand has product information that doesn’t fit neatly into a standardised schema. tieback Custom Fields let you extend the product data model with brand-specific attributes — tracked, governed, and available throughout the platform alongside your standard DPP fields.

What Custom Fields Do

Custom Fields allow you to define additional data attributes that are specific to your brand’s operational needs. These fields sit alongside the standard DPP schema fields and are treated as first-class data throughout the platform:

  • Appear in Product Detail — custom fields are displayed in a dedicated section on every product record
  • Included in passport content — custom field values flow through to Digital Product Passport rendering when configured
  • Available at mint time — lot-level custom values can be set during minting for batch-specific overrides
  • Governed by the same rules — custom fields respect the platform’s data integrity, audit, and access control policies

Who It’s For

Brand administrators who need to track product attributes beyond the standard DPP field catalogue — for example, internal reference codes, brand-specific sustainability metrics, proprietary material classifications, or operational metadata.

How It Works

Defining Custom Fields

Navigate to Settings → Custom Fields to manage your brand’s custom field definitions.

1

Create a field definition

Give the field a label and a unique field identifier. Choose a data type (text, number, boolean, date, or URL). Assign it to a scope — product-level or lot-level.

2

Activate the field

New fields are created in an active state and immediately available for data entry across your product catalogue.

3

Set values on products

Open any product and navigate to the Custom Fields section. Enter values for your defined fields.

Scope Levels

Custom fields can be defined at two scope levels:

ScopeWhere values are setUse case
ProductOn the product recordBrand-specific attributes that are the same across all units of a product
LotAt mint time, per lotBatch-specific values that vary between production runs

Product-level custom values are stored on the product record. Lot-level custom values are captured during the minting process and frozen into the mint batch data.

Data Types

TypeDescriptionExample
TextFree-form text stringInternal reference code, supplier name
NumberNumeric value (integer or decimal)Weight tolerance, custom metric
BooleanTrue/false toggleOrganic certified, hand-finished
DateCalendar dateLab test date, certification expiry
URLValid web URLSupplier portal link, certificate URL

Custom Fields in Passports

Custom field values flow through to the Digital Product Passport rendering pipeline. When a passport is published:

  • Product-level custom values are included in the passport snapshot
  • Lot-level custom values are captured at mint time and included in the batch data
  • The passport template governs whether custom fields appear in the consumer-facing experience

This means custom data can be disclosed to consumers alongside standard DPP information, subject to the brand’s template configuration.

Custom Fields in Product Detail

Custom fields appear in a dedicated Custom Fields section on the Product Detail page, below the standard DPP attribute sections. Each field displays its label, current value, and data type. Values are editable inline, following the same interaction pattern as standard product attributes.

Three-Layer Data Model

Custom fields participate in tieback’s three-layer data inheritance model:

LayerSourcePurpose
Product masterProduct record (attributes)Default values for all future mints
Batch snapshotMint batch (attributes)Values frozen at mint time
Lot overrideMint lot (attributes)Per-lot values that override the batch snapshot

When a passport is rendered, the system resolves custom field values using this precedence hierarchy — lot overrides take priority over batch snapshots, which take priority over the product master.

Limits & Notes

  • Custom field definitions are brand-scoped — each brand manages its own set of fields independently
  • Field identifiers must be unique within a brand and cannot be changed after creation
  • Deactivating a field hides it from new data entry but preserves existing values
  • Custom field values are subject to the same audit and access control policies as standard product attributes

FAQ

Can I use custom fields for compliance data?

Yes. Custom fields support any data your brand needs to track. However, for fields that map to standardised DPP requirements, we recommend using the built-in DPP schema fields instead — these are already configured for your industry classification and support regulatory reporting.

Do custom fields appear in the consumer passport?

Custom field values are available in the passport rendering pipeline. Whether they appear in the consumer experience depends on your passport template configuration — you control which fields are disclosed.

Can I change a custom field's data type after creation?

No. Data types are fixed at creation to protect data integrity across existing product records and passport snapshots. If you need a different type, create a new field definition and migrate your data.

What happens to custom field data when I deactivate a field?

Existing values are preserved on all products and passport snapshots. The field is hidden from new data entry but remains part of the historical record.

Related Docs

  • Products
  • Passports Overview
  • Content & Templates
  • Minting Overview
  • Bulk Editing