xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField SalesCRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/Shelf Product — entity reference
REFERENCE · Last reviewed

Shelf Product — entity reference

The tenant's reporting identity for one shelf-vision detection label: maps a stable, lowercase gallery label (detectionLabel) to a display name, an optional roll-up cluster (clusterId) and the isOwnBrand flag that drives the share-of-shelf numerator. One row per label, enforced by a filtered unique index, so reporting joins stay unambiguous. When any active rows have isOwnBrand set they supersede the feature-setting CSV fallback of target brands.

Fields

FieldLabelTypeRequiredWhat it does
ClusterIdClusterLookup → ShelfProductCluster
DescriptionDescriptionMultiLineText
DetectionLabelDetection LabelMultiLineText, uniqueYesThe recognition-gallery label this product maps to - must match a gallery label verbatim (lowercase, hyphenated). One row per label, enforced by a filtered unique index; the human-friendly name lives in the row's display name, not here.
IsOwnBrandIs Own BrandBooleanCounts this label toward the tenant's own share-of-shelf numerator. When any active rows set it, they supersede the feature-setting CSV of target brands; it also unions with the cluster-level own-brand flag.
LabelLabelMultiLineText

Actions

ActionLabelTypeWhat it does
DeleteEntityDeleteDeleteDeleteEntity
DeleteHeaderDeleteDeleteDelete Header
DeleteRowDeleteDeleteDelete Row
EditEntityEditEditEditEntity
EditInLineEntityEditEditInlineEditInLineEntity
EditInLineHeaderEditEditInlineEdit In Line Header
EditRowEditEditEdit Row
NewHeaderNewNewNew Header