Represents a defined collection or grouping of products — such as a customer selling assortment, authorization list, or planning assortment — used to control which products are available, orderable, or assigned to a given context (account, location, or catalog) over a specified date range. 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
AssortmentSpecId
Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the AssortmentSpec record that defines the template/specification this assortment was generated from.
Relationship Name: AssortmentSpec
Refers To: AssortmentSpec
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 or contents of this assortment.
EndDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date on which this assortment stops being active.
IsClosedAssortment
Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether the assortment is closed (true), meaning only the explicitly listed products are allowed, versus open. 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 assortment.
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.
OwnerId
Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The ID of the user or queue that owns this assortment record.
Relationship Name: Owner
Refers To: Group, User
StartDate
Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The date on which this assortment becomes active.
Type
Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The category of assortment. Possible values are AuthorizationList, CustomerSellingAssortment, LocationAuthorizationList, OrderSpecification, PlanningAssortment, and VisitSpecification.
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.
- AssortmentChangeEvent: Change events are available for the object.
- AssortmentFeed: Feed tracking is available for the object.
- AssortmentHistory: History is available for tracked fields of the object.
- AssortmentOwnerSharingRule: Sharing rules are available for the object.
- AssortmentShare: Sharing is available for the object.