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.

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

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

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

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

• 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

• 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

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The most recent date on which a user referenced this record.

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The most recent date on which a user viewed this record.

• Type: string
• Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
• Description: Unique identifier for this association.

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

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

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

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Product for which the assessment indicator definition is tracked.

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: ID of the promotion if the assessment indicator definition is for a promotion check.

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

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

• 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

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

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

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

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

• 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

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

• RetailStoreKpiFeed: Feed are available for the object.
• RetailStoreKpiHistory: History is available for the object.
• RetailStoreKpiShare: Sharing is available for the object.

j

Get Started with Consumer Goods Cloud

Retail Execution

Standard Objects for Retail Execution

Account

Asset

AssessmentIndicatorDefinition

AssessmentIndDefinedValue

AssessmentIndValue

AssessmentTask

AssessmentTaskContentDocument

AssessmentTaskDefinition

AssessmentTaskIndDefinition

AssessmentTaskOrder

Assortment

AssortmentProduct

DeliveryTask

InStoreLocation

Operatinghours

OtherComponentTask

Product2

Promotion

PromotionChannel

PromotionProduct

PromotionProductCategory

RetailLocationGroup

RetailStore

RetailStoreGroupAssignment

RetailStoreKpi

RetailVisitKpi

SignatureTask

SignatureTaskLineItem

StoreActionPlanTemplate

StoreAssortment

StoreProduct

Task

User

VehicleUserAssignment

Visit

Visitor

VisitedParty

Associated Objects for Retail Execution

Custom Objects for Retail Execution

Standard DLO to DMO Mappings

Retail Execution Standard Metadata APIs

Retail Order Customization

Sync Management

Direct Store Delivery

Einstein Visit and Activity Recommendation

Trade Promotion Management

Custom Objects for Retail Execution and Trade Promotion Management

Standard and Custom Objects for Future Use

API End-of-Life Policy

Previous Versions