Consumer Goods Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
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
StoreActionPlanTemplate
StoreAssortment
StoreProduct
Task
User
VehicleUserAssignment
Visit
Visitor
VisitedParty
Associated Objects for Retail Execution
Custom Objects for Retail Execution
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
Custom Objects for Future Use
API End-of-Life Policy
PDF

Asset

Standard and custom fields extend the standard Asset object in Consumer Goods Cloud to represent an item of commercial value, such as a product sold by your company or a competitor, that a customer has purchased. This object is available in API version 55.0 and later.

Supported Calls

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

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Required. ID of the Account related to the asset. Must be a valid account ID.
This field is a relationship field.
Relationship Name
Account
Relationship Type
Lookup
Refers To
Account
Address
Type
address
Properties
Filter, Nillable
Description
The compound form of the Asset address
AssetLevel
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Asset’s position in the asset hierarchy: Assets that have no parent or child assets, or that belong to a hierarchy have a level of 1 for the root asset. Child assets of the root asset have a level of 2, the children of level 2 assets have a level of 3, and so on.

The asset level of assets created before the introduction of this field defaults to –1. After the asset record is updated, the asset level is calculated and automatically updated.

Note
AssetProvidedById
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Account that provided the asset, typically a manufacturer.
This field is a relationship field.
Relationship Name
AssetProvidedBy
Relationship Type
Lookup
Refers To
Account
AssetServicedById
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Account in charge of servicing the asset.
This field is a relationship field.
Relationship Name
AssetServicedBy
Relationship Type
Lookup
Refers To
Account
City
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
City in the address.
ContactId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the related contact record.
This field is a relationship field.
Relationship Name
Contact
Relationship Type
Lookup
Refers To
Contact
Country
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Country in the address.
CurrentAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Reserved for future use.
Available when CPQ Plus, Salesforce Billing, or Subscription Management is enabled.
CurrentLifecycleEndDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
End of the period shown as current. Auto-populated field inherited from the end date of the current asset state period. If the field is empty, as with an evergreen subscription, the Current Lifecycle End Date field is empty.
CurrentMrr
Type
currency
Properties
Filter, Nillable, Sort
Description
Asset’s monthly recurring revenue during the current asset state period. Auto-populated field inherited from the monthly recurring revenue on the current asset state period. If no asset state period is current, the value is 0. Label is Current Monthly Recurring Revenue.
CurrentQuantity
Type
double
Properties
Filter, Nillable, Sort
Description
Asset’s quantity during the current asset state period. Auto-populated field inherited from the quantity on the current asset state period. If no asset state period is current, the value is 0.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
Description of the asset.
GeocodeAccuracy
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Shipping geocode accuracy:
Possible values are:
  • Address
  • Block
  • City
  • County
  • ExtendedZip
  • NearAddress
  • Neighborhood
  • State
  • Street
  • Unknown
  • Zip
HasLifecycleManagement
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether this asset is lifecycle-managed (true) or not (false). After setting this value, the value can’t be changed. Auto-populated field.
The default value is false.
InstallDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Date when the asset was installed.
IsCompetitorProduct
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the asset represents a product sold by a competitor (true) or not (false).
The default value is false.
IsInternal
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the asset is produced or used internally (true) or not (false).
The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and time that the asset was last modified.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Date and time that the asset was last viewed.
Latitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Latitude of the asset.
LifecycleEndDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
End of the asset’s lifecycle. Auto-populated field inherited from the end date of the final asset state period. If the field is empty, as with an evergreen subscription, the lifecycle has no end date. This field is available when CPQ Plus, Salesforce Billing, or Subscription Management is enabled.
LifecycleStartDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Beginning of the asset’s lifecycle. Auto-populated field inherited from the start date of the earliest asset state period. This field can’t be edited. When a new asset action affects the start date of an asset state period, a new period is generated. This field is available when CPQ Plus, Salesforce Billing, or Subscription Management is enabled.
LocationId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the GPS coordinates of the asset.
Relationship field.
Relationship Name
Location
Relationship Type
Lookup
Refers To
Location
Longitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Asset’s location. Typically, this location is the place where the asset is stored, such as a warehouse or van.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. Name of the asset.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Asset’s owner. By default, the asset owner is the user who created the asset record.
This field is a relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
User
ParentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Asset’s parent asset.
This field is a relationship field.
Relationship Name
Parent
Relationship Type
Lookup
Refers To
Asset
PostalCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Postal code in the asset address.
Price
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Pricing information for an asset.
Product2Id
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Optional. ID of Product2 related to this asset. Must be a valid Product2 ID.
This field is a relationship field.
Relationship Name
Product2
Relationship Type
Lookup
Refers To
Product2
ProductCode
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Product code of the related product.
PurchaseDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Date on which this asset was purchased.
Quantity
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Asset quantity purchased or installed.
RecordTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of the record type.
This field is a relationship field.
Relationship Name
RecordType
Relationship Type
Lookup
Refers To
RecordType
RootAssetId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
Read-only. The top-level asset in an asset hierarchy. Depending on where an asset lies in the hierarchy, the asset’s root can be the same as the parent.
This field is a relationship field.
Relationship Name
RootAsset
Relationship Type
Lookup
Refers To
Asset
SerialNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Serial number of the asset.
State
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
State in the asset address.
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Indicates asset’s status:
Possible values are:
  • Active
  • Damaged
  • Inactive
Customizable picklist.
StockKeepingUnit
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Stock keeping unit assigned to the related product.
Street
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Street name in the asset address.
TotalLifecycleAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Total amount of revenue for the asset, including revenue from each stage in the asset lifecycle. The field is available when CPQ Plus, Salesforce Billing, or Subscription Management is enabled.
UsageEndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
End date or expiry date for asset use.
cgcloud_Asset_Template__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References to the asset template.
This field is a relationship field.
Relationship Name
cgcloud_dev__Asset_Template__r
Relationship Type
Lookup
Refers To
cgcloud_dev__Asset_Template__c
cgcloud_Asset_Type__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Type of asset.
This field is a relationship field.
Relationship Name
cgcloud_dev__Asset_Type__r
Relationship Type
Lookup
Refers To
Product2
cgcloud_Brand__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References to the brand of the child product.
cgcloud_Description_Language_1__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the description of language 1.
cgcloud_Description_Language_2__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the description of language 2.
cgcloud_Description_Language_3__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the description of language 3.
cgcloud_dev__Description_Language_4__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Stores the description of language 4.
cgcloud_Description__c
Type
string
Properties
Filter, Nillable, Sort
Description
Description based on the user-specified language.
This field is a calculated field.
Formula
CASE($User.cgcloud_dev__Language_Postfix__c,
"Language1", cgcloud_dev__Description_Language_1__c,
"Language2", BLANKVALUE(cgcloud_dev__Description_Language_2__c,cgcloud_dev__Description_Language_1__c),
"Language3", BLANKVALUE(cgcloud_dev__Description_Language_3__c,cgcloud_dev__Description_Language_1__c),
"Language4", BLANKVALUE(cgcloud_dev__Description_Language_4__c,cgcloud_dev__Description_Language_1__c),
cgcloud_dev__Description_Language_1__c)
cgcloud_ERP_Asset_Number__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Holds the asset number assigned by the ERP.
cgcloud_Manufacturer_Serial_Number__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Serial number given by the manufacturer.
cgcloud_Note__c
Type
textarea
Properties
Create, Nillable, Update
Description
General note about the asset.
cgcloud_Ownership_Type__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Indicates the ownership type of the asset:
Possible values are:
  • Leased
  • Owned
cgcloud_POS__c
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
References to Point of Sale(POS).
This field is a relationship field.
Relationship Name
cgcloud_dev__POS__r
Relationship Type
Lookup
Refers To
cgcloud_dev__POS__c
cgcloud_Production_Year__c
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Holds the production year of the asset.
cgcloud_Sales_Org__c
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Sales org of the template:
Possible values are:
  • 0000
  • 0001
  • 0002
  • 0003
cgcloud_Service_Phone_Number__c
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Phone number from the service support of the asset.
cgcloud_Valid_From__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Date from which the asset is valid.
cgcloud_Valid_Thru__c
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Date until which the asset is valid.