Defines a reusable template or specification for generating Assortment records — including the assortment type, usage type, and account-assignment rule — used by assortment planning and generation processes. This object is available in API version 68.0 and later.
Supported Calls
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()
Special Access Rules
Available only in orgs with Consumer Goods Cloud or Retail Execution features enabled.
Fields
AccountAssignment
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies how many accounts must be assigned when this specification is used. Possible values are ExactlyOne, No, OneOrMore, and ZeroOrMore.
AssortmentType
Type: picklist
Properties: Create, Filter, Group, Restricted picklist, Sort, Update
Description: The category of assortment this specification generates. Possible values are AuthorizationList, CustomerSellingAssortment, LocationAuthorizationList, OrderSpecification, PlanningAssortment, and VisitSpecification.
CurrencyIsoCode
Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: ISO code for the currency of this record. Possible values are: AED (UAE Dirham), USD (U.S. Dollar), and every other active currency ISO code configured for the org. The default value is USD.
Description
Type: textarea
Properties: Create, Filter, Nillable, Sort, Update
Description: A free-text description of the purpose of this assortment specification.
InternalOrganizationUnitId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the InternalOrganizationUnit record this specification applies to. This field is a relationship field.
Relationship Name: InternalOrganizationUnit
Refers To: InternalOrganizationUnit
IsActive
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether this specification is currently active and available for use. The default value is false.
LastReferencedDate
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last accessed a record related to this specification.
LastViewedDate
Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed this record.
Name
Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: The name of the assortment specification.
OwnerId
Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the user or queue that owns this specification record. This field is a polymorphic relationship field.
Relationship Name: Owner
Refers To: Group, User
UsageType
Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description: Categorizes the usage context of this specification. The only possible value is Retail. The default value is Retail.
Associated Objects
This object has the following associated objects. If the API version isn't specified, they're available in the same API versions as this object. Otherwise, they're available in the specified API version and later.
- AssortmentSpecChangeEvent: Change events are available for the object.
- AssortmentSpecFeed: Feed tracking is available for the object.
- AssortmentSpecHistory: History is available for tracked fields of the object.
- AssortmentSpecOwnerSharingRule: Sharing rules are available for the object.
- AssortmentSpecShare: Sharing is available for the object.