---
schema_version: "1"
id: e83497e36e341f0a758ed907d2aa2514683eb9324d55f83d2afa619483785ced
title: RetailStoreKpi
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/retail_api/sforce_api_objects_retailstorekpi.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_objects_retailstorekpi.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 82c48952730fd2c61519478b4a1692830359fc2116ab1969503a2b02f9f17416
description: Map store groups to assessment indicator definition, products, and in-store location categories and define targets. Targets are the expected compliance values for each assessment indicator definition, which is a parameter based on which markers of compliance are decided for a task. This object is available in API version 47.0 and later.
---
# RetailStoreKpi

Map store groups to assessment indicator definition, products, and in-store location categories and define targets. Targets are the expected compliance values for each assessment indicator definition, which is a parameter based on which markers of compliance are decided for a task. 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

### AssessmentIndDefinitionId

- **Type**: reference
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: ID of the assessment indicator definition to track, such as inventory or facings.

### 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.

### EndDate

- **Type**: date
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: Final date of the association between a store group and the assessment indicator definitions.

### InStoreLocationCategory

- **Type**: picklist
- **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
- **Description**: ID of the in-store location category.
- **Possible values**:
    - Aisle
    - Backroom
    - Endcap

### KpiType

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: Type of assessment indicator definition.
- **Possible values**:
    - Facing
    - ShareOfShelf
    - OutOfStock
    - Price
    - Revenue
    - ShareOfShelf

### 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 this association.

### OwnerId

- **Type**: reference
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: ID of the retail store assessment indicator definition record owner.

### PlanogramId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: ID of the planogram if the assessment task is planogram check.

### ProductCategoryId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: ID of the product category, if the promotion level is for a product category and the assessment task is a promotion check.

### ProductId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: 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 indicator definition is for a promotion check.

### RetailStoreGroupId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: ID of the retail store group for which the assessment indicator definition is defined.

### StartDate

- **Type**: date
- **Properties**: Create, Filter, Group, Sort, Update
- **Description**: Start date of the association between a store group and the assessment indicator definitions.

### TargetBooleanValue

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: The expected value among the two possible ones for the measuring parameter.
- **Possible values**:
    - False
    - True

### TargetDateTimeValue

- **Type**: dateTime
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: The expected date and time for the measuring parameter.

### TargetDecimalValue

- **Type**: double
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: The expected fractional value for the measuring parameter.

### TargetIntegerValue

- **Type**: int
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The target whole number value for the measuring parameter.

### TargetStringValue

- **Type**: textarea
- **Properties**: Create, Filter, Nillable, Sort, Update
- **Description**: The expected sequence of characters for the measuring parameter.

### UnitOfMeasure

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The unit used to measure the assessment indicator definition.
- **Possible values**:
    - %
    - Kilogram
    - Litre
    - Pack
    - USD
    - Unit

## Associated Objects

This object has the following associated objects. Unless noted, they’re available in the same API version as this object.

- **[RetailStoreKpiFeed](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 are available for the object.
- **[RetailStoreKpiHistory](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.
- **[RetailStoreKpiShare](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.")**: Sharing is available for the object.