RetailVisitKpi

Capture the actual information during a visit against the defined assessment indicator definition and target values. This object is available in API version 47.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field	Details
ActualBooleanValue	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The actual one of two possible values for an assessment indicator definition that the sales rep can capture during the store visit audit. Possible values are: `False` `True`
ActualDateTimeValue	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The actual date and time for an assessment indicator definition that the sales rep can capture during the store visit audit.
ActualDecimalValue	Type double Properties Create, Filter, Nillable, Sort, Update Description The actual fractional value for an assessment indicator definition that the sales rep can capture during the store visit audit.
ActualIntegerValue	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The actual whole number value for an assessment indicator definition that the sales rep can capture during the store visit audit.
ActualStringValue	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The actual sequence of characters for an assessment indicator definition that the sales rep can capture during the store visit audit.
AssessmentIndDefinitionId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The assessment indicator definition ID that indicates the kind of parameter that is audited. Values can include: Inventory, Facings, Competitor Facings, Share of Shelf.
AssessmentTaskId	Type reference Properties Create, Filter, Group, Sort Description ID of the assessment task against which the actual data is captured.
CustomContextId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the custom object if the assessment indicator definition is associated for a custom task.
InStoreLocationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the in-store location that is associated with the assessment indicator definition.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Unique identifier for the visit KPI.
PlanogramId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the planogram.
ProductCategoryId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the product category for which audit is done.
ProductId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the product for which the assessment indicator definition is tracked.
PromotionId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the promotion if the assessment task is a promotion check.
TargetBooleanValue	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The expected value among the two possible ones for an assessment indicator definition against which the actual value is captured. Possible values are: `False` `True`
TargetDateTimeValue	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The expected date and time for an assessment indicator definition against which the actual value is captured.
TargetDecimalValue	Type double Properties Create, Filter, Nillable, Sort, Update Description The expected fractional for an assessment indicator definition against which the actual value is captured.
TargetIntegerValue	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The expected whole number value for an assessment indicator definition against which the actual value is captured.
TargetStringValue	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The expected sequence of characters for an assessment indicator definition against which the actual value is captured.
Type	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Type of the assessment indicator definition. Possible values are: `Facing` `ShareOfShelf`
UnitOfMeasure	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit of measure for the combination of assessment indicator definition type and target value. Possible values are: `Kilogram` `Litre` `Pack` `Unit`

Consumer Goods Cloud Developer Guide

RetailVisitKpi

Supported Calls

Fields