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/Planogram — entity reference
REFERENCE · Last reviewed

Planogram — entity reference

A shelf-layout definition that merchandising audits are judged against: layoutJson holds the structured expectation (shelves, positions, product and expected facings) the compliance calculator consumes, and an optional reference photo rides the generic file-asset pipeline. Scope is one outlet (accountId), a class of outlets (accountType, matched against Account.Type), or tenant-wide when both are empty; the applicable planogram for an audit is resolved by effective window with narrowest scope winning, and only Active rows are considered.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → Account
AccountTypeAccount TypeMultiLineTextOutlet-class scope matched verbatim against Account.Type (for example a store-format value). Narrower than tenant-wide, wider than the single-outlet accountId scope; narrowest applicable scope wins at resolution.
DescriptionDescriptionMultiLineText
EffectiveFromEffective FromDateAndTime
EffectiveToEffective ToDateAndTime
LabelLabelMultiLineText
LayoutJsonLayout JsonMultiLineTextThe structured shelf expectation the compliance calculator consumes: shelves, positions, product/brand and expected facings. This JSON is the judgment source; the optional reference photo is only illustrative.
StatusStatusPickListValues: Draft, Active, Retired.

Actions

ActionLabelTypeWhat it does
DeleteEntityDeleteDeleteDeleteEntity
DeleteHeaderDeleteDeleteDelete Header
EditEntityDetailEditEditEditEntityDetail
EditInLineEntityEditEditInlineEditInLineEntity
EditInLineHeaderEditEditInlineEdit In Line Header
NewHeaderNewNewNewHeader