StoreProduct

Associate a product to a retail store or to a specific in-store location. 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

AccountId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The account associated with the record. This field is available in API versions 52.0 and later.

    This is a relationship field.

  • Relationship Name: Account
  • Relationship Type: Lookup
  • Refers To: Account

DefaultOrderQuantity

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Default quantity to order.

DisplayOrder

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Sequence in which a product must be displayed for a retail store. This field is available in API version 53.0 and later.

EndDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Final date when the association of product to an in-store location, store, store group, or account is applicable.

InStoreLocationId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: ID of the in-store location to which the product is associated.

IsFavorite

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicator for top-selling products.

LastReferencedDate

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

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: 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 association of a store and product.

OwnerId

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

ProductId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: ID of the product associated with the retail store.

RetailStoreId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: ID of the retail store with which the product is associated.

StartDate

  • Type: date
  • Properties: Create, Filter, Group, Sort, Update
  • Description: First date that the association of product to an in-store location, store, store group, or account is applicable.

Associated Objects

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