--- schema_version: "1" id: 3ff8176efd4bf5b9a30ab0360d8448a5d4bf100d8e4f707eec8c3ce2711dbf5e title: RetailVisitKpi collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/retail_api/sforce_api_objects_retailvisitkpi.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_retailvisitkpi.htm source_site: developer.salesforce.com content_type: documentation content_hash: 9e4f072c35619c9a56c8b9286bcf4c7ff653c7afe832e78855c6ab7a0837962e description: 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. --- # 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 ### 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**: - 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. ### DisplayOrder - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Sequence in which the retail visit KPI must be displayed. This field is available in API version 51.0 and later. ### 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. ### PrimaryDisplayOrder - **Type**: int - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: Sequence in which products, product categories, promotions, or other contexts are displayed for an assessment task. This field is available in API version 53.0 and later. ### 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. ### RecordTypeId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the record type. ### 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**: - 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**: - Facing - Inventory - OutOfStock - Price - Revenue - 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**: - Kilogram - Litre - Pack - Unit ### VisitId - **Type**: reference - **Properties**: Create, Filter, Group, Nillable, Sort, Update - **Description**: ID of the associated visit. ## Associated Objects This object has the following associated objects. Unless noted, they available in the same API version as this object. - **[RetailVisitKpiFeed](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.")**: Feed is available for the object. - **[RetailVisitKpiHistory](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.")**: History is available for the object. This object is available in API version 51.0 and later.