xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField Sales & SFACRMRewardsClaimsInventoryProcurementWarehouse 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
Auto DMSConsumer Goods DMSSales Force Automation (SFA) 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

One pack that the Shelf Vision recognition model can detect, identified by its detection label and kept in the Field Sales Setup app under Shelf Vision. Shelf products marked Is Own Brand, or in a cluster marked Is Own Brand, form the list of your own labels for share of shelf. Once at least one shelf product counts as own brand, the Own-brand labels setting on the Shelf Vision card is no longer read. A planogram that lists its own target brand labels still takes precedence for the outlets it matches. Changes apply from the next analysed photo. The delivered New form has no Name field, so a numbering setting or a Name field on the create layout is needed before new records can be saved.

Fields

FieldLabelTypeRequiredWhat it does
ClusterIdClusterLookup → ShelfProductClusterThe shelf product cluster this pack belongs to. If that cluster is marked Is Own Brand, the pack counts toward your share of shelf even when its own flag is clear.
DescriptionDescriptionMultiLineTextFree-text note about the pack.
DetectionLabelDetection LabelMultiLineText, uniqueYesThe recognition model's label for this pack, for example orchard-mango-500. Required and unique: only one shelf product per label. It must match the model's label exactly, apart from letter case. Read the labels from a shelf audit result's Share Of Shelf Brand Json.
IsOwnBrandIs Own BrandBooleanWhen ticked, this pack's detection label counts toward your share of shelf. Combined with the cluster's flag: the pack counts if either is set.
LabelLabelMultiLineTextA readable name for the pack. For reference only: shelf audit results show detection labels, not this name.

Actions

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