Apex Reference Guide
jSummer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Release Notes
CommerceOrders Namespace
ComplianceMgmt Namespace
SmartDataDiscovery Class
ConnectApi.AbstractCartItem
ConnectApi.AbstractContentHubItemType
ConnectApi.AbstractDirectoryEntrySummary
ConnectApi.AbstractExtensionInformation
ConnectApi.AbstractGatewayCommonResponse
ConnectApi.AbstractGatewayResponse
ConnectApi.AbstractManagedContentChannelRepresentation
ConnectApi.AbstractManagedContentDeliveryDocument
ConnectApi.AbstractManagedContentReference
ConnectApi.AbstractMessageBody
ConnectApi.AbstractNBAAction
ConnectApi.AbstractNBATarget
ConnectApi.AbstractRecommendation
ConnectApi.AbstractRecommendationExplanation
ConnectApi.AbstractRecordField
ConnectApi.AbstractRecordView
ConnectApi.AbstractRepositoryFile
ConnectApi.AbstractRepositoryFolder
ConnectApi.AbstractRepositoryItem
ConnectApi.AbstractUserMissionActivity
ConnectApi.ActionInfoOutputRepresentation
ConnectApi.ActionLinkDefinition
ConnectApi.ActionLinkDiagnosticInfo
ConnectApi.ActionLinkGroupDefinition
ConnectApi.ActivitySharingResult
ConnectApi.Activation
ConnectApi.ActivationAttribute
ConnectApi.ActivationAttributeConfig
ConnectApi.ActivationCollection
ConnectApi.ActivationContactPointFieldConfig
ConnectApi.ActivationContactPointsFieldConfig
ConnectApi.ActivationContactPointSourceConfig
ConnectApi.ActivationContactPointsSourceConfig
ConnectApi.ActivationDataSources
ConnectApi.ActivationDataSourceConfig
ConnectApi.ActivationTarget
ConnectApi.ActivationTargetSubject
ConnectApi.ActivitySharingResult
ConnectApi.Actor
ConnectApi.ActorWithId
ConnectApi.Address
ConnectApi.AdjustOrderSummaryOutputRepresentation
ConnectApi.Alternative
ConnectApi.AlternativePaymentMethodOutput
ConnectApi.Announcement
ConnectApi.AnnouncementPage
ConnectApi.SearchAppliedOrderBy
ConnectApi.ApprovalCapability
ConnectApi.ApprovalIntent
ConnectApi.ApprovalPostTemplateField
ConnectApi.ArticleItem
ConnectApi.ArticleSummary
ConnectApi.AssociatedActionsCapability
ConnectApi.AsyncOutputRepresentation
ConnectApi.AttributeFilter
ConnectApi.AttributeFilterExpression
ConnectApi.Audience
ConnectApi.AudienceCollection
ConnectApi.AudienceCriteria
ConnectApi.AudienceCriteriaDetail
ConnectApi.AudienceCriterionDetail
ConnectApi.AudienceTarget
ConnectApi.AudienceTargetAssignment
ConnectApi.AuthReversalGatewayResponse
ConnectApi.AuthorizationGatewayResponse
ConnectApi.AuthorizationResponse
ConnectApi.AuthorizationReversalResponse
ConnectApi.AvailableLocationOutputRepresentation
ConnectApi.AverageDistanceResultOutputRepresentation
ConnectApi.BalanceStatePreviewOutputRepresentation
ConnectApi.BannerCapability
ConnectApi.BannerPhoto
ConnectApi.BaseAsyncOutputRepresentation
ConnectApi.BaseComparison
ConnectApi.BaseInvoiceOutputRepresentation
ConnectApi.BaseManagedSocialAccount
ConnectApi.BaseOutputRepresentation
ConnectApi.BlankRecordField
ConnectApi.PromotionBonusProduct
ConnectApi.BookmarksCapability
ConnectApi.BookmarkSummary
ConnectApi.BotInfoRepresentation
ConnectApi.BotVersionActivationInfo
ConnectApi.BusObjAssociationsOutputRepresentation
ConnectApi.BusObjInsightsOutputRepresentation
ConnectApi.BusObjOutputRepresentation
ConnectApi.BusObjRecommendationsOutputRepresentation
ConnectApi.BusObjSummaryOutputRepresentation
ConnectApi.BusinessObjectivesOutputRepresentation
ConnectApi.BusinessObjectivesSummaryOutputRepresentation
ConnectApi.BundleCapability
ConnectApi.CalculateCartResult
ConnectApi.CalculateTaxResponse
ConnectApi.CallCollaborationCapability
ConnectApi.CancelAllOrderItemsAsyncOutputRepresentation
ConnectApi.CandidateAnswersStatus
ConnectApi.CanvasCapability
ConnectApi.CapacityResponseOutputRepresentation
ConnectApi.CaptureGatewayResponse
ConnectApi.CaptureResponse
ConnectApi.CardPaymentMethodOutput
ConnectApi.CartCoupon
ConnectApi.CartCouponCollection
ConnectApi.CartCouponList
ConnectApi.PromotionCartDeliveryGroupMethod
ConnectApi.PromotionCartDeliveryGroup
ConnectApi.CartInventoryItemReservationOutputRepresentation (Pilot)
ConnectApi.CartInventoryReservationOutputRepresentation (Pilot)
ConnectApi.CartItem
ConnectApi.CartItemBasic
ConnectApi.CartItemBasicResult
ConnectApi.CartItemCollection
ConnectApi.PromotionCartItemKey
ConnectApi.CartItemProduct
ConnectApi.CartItemPromotionCollectionOutputRepresentation
ConnectApi.CartItemResult
ConnectApi.CartItemWithoutPrice
ConnectApi.CartMessage
ConnectApi.CartMessagesSummary
ConnectApi.CartMessagesVisibilityResult
ConnectApi.CartProductAttribute
ConnectApi.CartPromotionCollection
ConnectApi.CartPromotionList
ConnectApi.CartPromotionOutputRepresentation
ConnectApi.CartSummary
ConnectApi.CartToWishlistResult
ConnectApi.CaseCommentCapability
ConnectApi.CdpActionResponse
ConnectApi.CdpCalculatedInsightDataSource
ConnectApi.CdpCalculatedInsightDimension
ConnectApi.CdpCalculatedInsightMeasure
ConnectApi.CdpCalculatedInsightOutput
ConnectApi.CdpCalculatedInsightPage
ConnectApi.CdpCalculatedInsightPageData
ConnectApi.CdpCalculatedInsightStandardActionResponseRepresentation
ConnectApi.CdpErrorResponse
ConnectApi.CdpIdentityResolutionMatchCriterionOutput
ConnectApi.CdpIdentityResolutionMatchCriterionPartyIdentificationInfoOutput
ConnectApi.CdpIdentityResolutionMatchRuleOutput
ConnectApi.CdpIdentityResolutionOutput
ConnectApi.CdpIdentityResolutionReconciliationFieldRuleOutput
ConnectApi.CdpIdentityResolutionReconciliationRuleOutput
ConnectApi.CdpIdentityResolutionReconciliationSourceOutput
ConnectApi.CdpIdentityResolutionRunNowOutput
ConnectApi.CdpIdentityResolutionsOutput
ConnectApi.CdpQueryDataOutput
ConnectApi.CdpQueryMetadataItem
ConnectApi.CdpQueryMetadataOutput
ConnectApi.CdpQueryOutput
ConnectApi.CdpQueryOutputV2
ConnectApi.CdpQueryV2Row
ConnectApi.CdpSegmentActionOutput
ConnectApi.CdpSegmentContainerOutput
ConnectApi.CdpSegmentDbtModel
ConnectApi.CdpSegmentDbtPipeline
ConnectApi.CdpSegmentMemberOutput
ConnectApi.CdpSegmentMemberRowOutput
ConnectApi.CdpSegmentMembershipTableOutput
ConnectApi.CdpSegmentOutput
ConnectApi.ChangeItemOutputRepresentation
ConnectApi.ChangeOrdersInvoiceOutputRepresentation
ConnectApi.ChatterActivity
ConnectApi.ChatterActivitySummary
ConnectApi.ChatterConversation
ConnectApi.ChatterConversationPage
ConnectApi.ChatterConversationSummary
ConnectApi.ChatterGroup
ConnectApi.ChatterGroupDetail
ConnectApi.ChatterGroupPage
ConnectApi.ChatterGroupSummary
ConnectApi.ChatterGroupSummaryPage
ConnectApi.ChatterLike
ConnectApi.ChatterLikePage
ConnectApi.ChatterLikesCapability
ConnectApi.ChatterMessage
ConnectApi.ChatterMessagePage
ConnectApi.ChatterStream
ConnectApi.ChatterStreamPage
ConnectApi.ClientInfo
ConnectApi.CloseCapability
ConnectApi.Comment
ConnectApi.CommentCapabilities
ConnectApi.CommentPage
ConnectApi.CommentSummary
ConnectApi.CommentsCapability
ConnectApi.CommerceActionResult
ConnectApi.CommerceAddressCollection
ConnectApi.CommerceAddressOutput
ConnectApi.CommerceProductSearchResults
ConnectApi.CommerceProductSellingModel
ConnectApi.CommerceProductSummary
ConnectApi.CommerceProductSummaryPage
ConnectApi.CommerceResultRepresentationBase
ConnectApi.CommerceSearchIndex
ConnectApi.CommerceSearchIndexCollection
ConnectApi.CommerceSearchIndexLog
ConnectApi.CommerceSearchIndexLogCollection
ConnectApi.Community
ConnectApi.CommunityPage
ConnectApi.CommunitySummary
ConnectApi.CompanyVerifySummary
ConnectApi.ComplexSegment
ConnectApi.CompositeCommerceProductOutputRepresentation
ConnectApi.CompositeCommerceVariationOutputRepresentation
ConnectApi.CompoundRecordField
ConnectApi.ConfirmHeldFOCapacityOutputRepresentation
ConnectApi.ConfirmHeldFOCapacityResponseOutputRepresentation
ConnectApi.ContactPointConfig
ConnectApi.ContactPointFilterExpression
ConnectApi.ContactPointsConfig
ConnectApi.Content
ConnectApi.ContentCapability
ConnectApi.ContentHubAllowedItemTypeCollection
ConnectApi.ContentHubFieldDefinition
ConnectApi.ContentHubItemTypeDetail
ConnectApi.ContentHubItemTypeSummary
ConnectApi.ContentHubPermissionType
ConnectApi.ContentHubProviderType
ConnectApi.ContentHubRepository
ConnectApi.ContentHubRepositoryAuthentication
ConnectApi.ContentHubRepositoryCollection
ConnectApi.ContentHubRepositoryFeatures
ConnectApi.ContentImageFileDetails
ConnectApi.ContractOutputRepresentation
ConnectApi.ConversationApplicationDefinitionDetailRespresentation
ConnectApi.CouponCodeRedemptionCollection
ConnectApi.CouponCodeRedemptionResult
ConnectApi.CreateCreditMemoOutputRepresentation
ConnectApi.CreateMultipleInvoicesFromChangeOrdersOutputRepresentation
ConnectApi.CreateOrderPaymentSummaryOutputRepresentation
ConnectApi.CreateSocialNamedCredential
ConnectApi.CreateWebStoreMetaConfiguration
ConnectApi.Credential
ConnectApi.CredentialCustomHeader
ConnectApi.CredentialValue
ConnectApi.CurrencyRecordField
ConnectApi.CustomListAudienceCriteria
ConnectApi.DashboardComponentSnapshot
ConnectApi.DashboardComponentSnapshotCapability
ConnectApi.DataCategoryMetadata
ConnectApi.DataCategoryValueMetadata
ConnectApi.DataConnector
ConnectApi.DataStreamActionResponseOutput
ConnectApi.DateEstimationOutputRepresentation
ConnectApi.DateRecordField
ConnectApi.DeleteIntent
ConnectApi.DeleteIntents
ConnectApi.DeleteSocialPostIntent
ConnectApi.DeliveryEstimateOutputRepresentation
ConnectApi.DeliveryEstimationErrorOutputRepresentation
ConnectApi.DigestJob
ConnectApi.DirectMessageCapability
ConnectApi.DirectMessageMemberActivity
ConnectApi.DirectMessageMemberActivityPage
ConnectApi.DirectMessageMemberPage
ConnectApi.DistanceCalculationOutputRepresentation
ConnectApi.DistinctFacetValue
ConnectApi.DistinctFacetValueDisplayMetadataRepresentation
ConnectApi.DistinctValueSearchFacet
ConnectApi.DistributePickedQuantitiesOutputRepresentation
ConnectApi.DmoFilter
ConnectApi.DmoFilterLimit
ConnectApi.DmoFilterConfig
ConnectApi.DownVoteSummary
ConnectApi.EditCapability
ConnectApi.EinsteinLlmGenAiSourceReference
ConnectApi.EinsteinLlmGenerationCitationOutput
ConnectApi.EinsteinLlmGenerationContentQualityOutput
ConnectApi.EinsteinLlmGenerationGenAiCitedReference
ConnectApi.EinsteinLlmGenerationGenAiSourceContentInfo
ConnectApi.EinsteinLlmGenerationGenAiSourceReferenceInfo
ConnectApi.EinsteinLLMGenerationItemOutput
ConnectApi.EinsteinLlmGenerationSafetyScoreOutput
ConnectApi.EinsteinPromptRecordCollectionOutputRepresentation
ConnectApi.EinsteinPromptRecordFieldRepresentation
ConnectApi.EinsteinPromptRecordRepresentation
ConnectApi.EinsteinPromptTemplateAttachment
ConnectApi.EinsteinPromptTemplateGenerationsError
ConnectApi.EinsteinPromptTemplateGenerationsRepresentation
ConnectApi.EinsteinPromptTemplateMaskContentRepresentation
ConnectApi.EinsteinPromptTemplateMaskDataRepresentation
ConnectApi.EinsteinPromptTemplateMaskSettingsRepresentation
ConnectApi.EmailAddress
ConnectApi.EmailAttachment
ConnectApi.EmailMergeFieldCollectionInfo
ConnectApi.EmailMergeFieldInfo
ConnectApi.EmailMessageCapability
ConnectApi.Emoji
ConnectApi.EmojiCollection
ConnectApi.EnhancedLinkCapability
ConnectApi.EnsureFundsAsyncOutputRepresentation
ConnectApi.EnsureRefundsAsyncOutputRepresentation
ConnectApi.EntityLabel
ConnectApi.EntityLinkSegment
ConnectApi.EntityRecommendation
ConnectApi.ErrorResponse
ConnectApi.EstimateDeliveryDateOutputRepresentation
ConnectApi.Extension
ConnectApi.ExtensionDefinition
ConnectApi.ExtensionDefinitions
ConnectApi.ExtensionsCapability
ConnectApi.ExternalAuthIdentityProvider
ConnectApi.ExternalAuthIdentityProviderCredential
ConnectApi.ExternalAuthIdentityProviderCredentials
ConnectApi.ExternalAuthIdentityProviderList
ConnectApi.ExternalAuthIdentityProviderParameter
ConnectApi.ExternalCredential
ConnectApi.ExternalCredentialList
ConnectApi.ExternalCredentialParameter
ConnectApi.ExternalCredentialPrincipal
ConnectApi.ExternalCredentialPrincipalAccess
ConnectApi.ExternalFilePermissionInformation
ConnectApi.ExternalManagedAccountAddressOutput
ConnectApi.ExternalManagedAccountCollectionOutput
ConnectApi.ExternalManagedAccountOutput
ConnectApi.FacetValue
ConnectApi.Features
ConnectApi.Feed
ConnectApi.FeedBody
ConnectApi.FeedDirectory
ConnectApi.FeedDirectoryItem
ConnectApi.FeedElement
ConnectApi.FeedElementCapabilities
ConnectApi.FeedElementCapability
ConnectApi.FeedElementPage
ConnectApi.FeedEnabledEntity
ConnectApi.FeedEntityIsEditable
ConnectApi.FeedEntityNotAvailableSummary
ConnectApi.FeedEntityReadSummary
ConnectApi.FeedEntityShareCapability
ConnectApi.FeedEntitySummary
ConnectApi.FeedFavorite
ConnectApi.FeedFavorites
ConnectApi.FeedItem
ConnectApi.FeedItemSummary
ConnectApi.FeedModifiedInfo
ConnectApi.FeedPollChoice
ConnectApi.FeedPostSummary
ConnectApi.FeedReadSummary
ConnectApi.FieldChangeNameSegment
ConnectApi.FieldChangeSegment
ConnectApi.FieldChangeValueSegment
ConnectApi.FieldMetadata
ConnectApi.FieldValue
ConnectApi.File
ConnectApi.FileAsset
ConnectApi.FilePreview
ConnectApi.FilePreviewCollection
ConnectApi.FilePreviewUrl
ConnectApi.FilesCapability
ConnectApi.FileSummary
ConnectApi.FindRoutesWithFewestSplitsOutputRepresentation
ConnectApi.FindRoutesWithFewestSplitsUsingOCIOutputRepresentation
ConnectApi.FindRoutesWithFewestSplitsWithInventoryOutputRepresentation
ConnectApi.FollowerPage
ConnectApi.FollowingCounts
ConnectApi.FollowingPage
ConnectApi.FollowIntents
ConnectApi.FollowSocialPersonaIntent
ConnectApi.Form
ConnectApi.FormField
ConnectApi.FormFields
ConnectApi.FormSubmission
ConnectApi.FormulaScope
ConnectApi.FulfillmentGroupOutputRepresentation
ConnectApi.FulfillmentOrderCancelLineItemsOutputRepresentation
ConnectApi.FulfillmentOrderInvoiceOutputRepresentation
ConnectApi.FulfillmentOrderOutputRepresentation
ConnectApi.GatewayLogResponse
ConnectApi.GenericBundleCapability
ConnectApi.GenericFeedElement
ConnectApi.GetFOCapacityValuesOutputRepresentation
ConnectApi.GlobalInfluence
ConnectApi.GroupChatterSettings
ConnectApi.GroupInformation
ConnectApi.GroupMember
ConnectApi.GroupMemberPage
ConnectApi.GroupMembershipRequest
ConnectApi.GroupMembershipRequests
ConnectApi.GroupRecord
ConnectApi.GroupRecordPage
ConnectApi.HashtagSegment
ConnectApi.HideSocialPostIntent
ConnectApi.HoldFOCapacityOutputRepresentation
ConnectApi.HoldFOCapacityResponseOutputRepresentation
ConnectApi.HttpHeaderOutputRepresentation
ConnectApi.Icon
ConnectApi.InlineImageSegment
ConnectApi.InsightValuesOutputRepresentation
ConnectApi.InsightsOutputRepresentation
ConnectApi.InteractionsCapability
ConnectApi.Invitation
ConnectApi.Invitations
ConnectApi.ItemQuantityOutputRepresentation
ConnectApi.KnowledgeArticleVersion
ConnectApi.KnowledgeArticleVersionCollection
ConnectApi.LabeledRecordField
ConnectApi.LightningExtensionInformation
ConnectApi.LikeIntent
ConnectApi.LikeIntents
ConnectApi.LikeSocialPostIntent
ConnectApi.LikeSummary
ConnectApi.LineItemResponse
ConnectApi.LinkCapability
ConnectApi.LinkMetadata
ConnectApi.LinkMetadataCollection
ConnectApi.LinkSegment
ConnectApi.LocationCapacityOutputRepresentation
ConnectApi.LocationOutputRepresentation
ConnectApi.MaintenanceInfo
ConnectApi.ManagedContentAssociations
ConnectApi.ManagedContentChannel
ConnectApi.ManagedContentChannelCollection
ConnectApi.ManagedContentChannelDetail
ConnectApi.ManagedContentChannelDomainRepresentation
ConnectApi.ManagedContentChannelsRepresentation
ConnectApi.ManagedContentChannelSummary
ConnectApi.ManagedContentChannelTargetSummary
ConnectApi.ManagedContentCloneStatus
ConnectApi.ManagedContentClonedVariants
ConnectApi.ManagedContentCollectionItem
ConnectApi.ManagedContentCollectionItems
ConnectApi.ManagedContentCollectionItemTypeSummary
ConnectApi.ManagedContentDateAndTimeNodeValue
ConnectApi.ManagedContentDateNodeValue
ConnectApi.ManagedContentDeliveryChannelRepresentation
ConnectApi.ManagedContentDeliveryChannelsRepresentation
ConnectApi.ManagedContentDeliveryChannelSummaryRepresentation
ConnectApi.ManagedContentDeliveryDocument
ConnectApi.ManagedContentDeliveryDocumentCollection
ConnectApi.ManagedContentDeliveryDocumentSummary
ConnectApi.ManagedContentDocument
ConnectApi.ManagedContentDocumentClone
ConnectApi.ManagedContentFailedVariants
ConnectApi.ManagedContentFolderSummary
ConnectApi.ManagedContentMediaNodeValue
ConnectApi.ManagedContentMediaSourceNodeValue
ConnectApi.ManagedContentNodeType
ConnectApi.ManagedContentNodeValue
ConnectApi.ManagedContentPublishOutput
ConnectApi.ManagedContentReference
ConnectApi.ManagedContentReferenceSummary
ConnectApi.ManagedContentSpace
ConnectApi.ManagedContentSpaceBaseType
ConnectApi.ManagedContentSpaceChannelRepresentation
ConnectApi.ManagedContentSpaceChannelsRepresentation
ConnectApi.ManagedContentSpaceCollectionRepresentation
ConnectApi.ManagedContentSpaceSummary
ConnectApi.ManagedContentTextNodeValue
ConnectApi.ManagedContentType
ConnectApi.ManagedContentTypeSummary
ConnectApi.ManagedContentUnpublishOutput
ConnectApi.ManagedContentUserSummary
ConnectApi.ManagedContentVariant
ConnectApi.ManagedContentVariantStatusOutput
ConnectApi.ManagedContentVersion
ConnectApi.ManagedContentVersionCollection
ConnectApi.ManagedSocialAccount
ConnectApi.ManagedSocialAccounts
ConnectApi.ManagedTopic
ConnectApi.ManagedTopicCollection
ConnectApi.MarkupBeginSegment
ConnectApi.MarkupEndSegment
ConnectApi.MatchInfo
ConnectApi.MCSFolderShare
ConnectApi.MCSFolderShareCollection
ConnectApi.MCSFolderShareTarget
ConnectApi.MCSFolderShareTargetCollection
ConnectApi.MediaReference
ConnectApi.MediaReferenceCapability
ConnectApi.MentionCompletion
ConnectApi.MentionCompletionPage
ConnectApi.MentionSegment
ConnectApi.MentionValidation
ConnectApi.MentionValidations
ConnectApi.MessageBody
ConnectApi.MessageSegment
ConnectApi.ModerationCapability
ConnectApi.ModerationFlagItemDetail
ConnectApi.ModerationFlags
ConnectApi.ModerationFlagsCollection
ConnectApi.MoreChangesSegment
ConnectApi.Motif
ConnectApi.MultipleAsyncOutputRepresentation
ConnectApi.MultipleFulfillmentOrderInvoicesOutputRepresentation
ConnectApi.MultipleFulfillmentOrderOutputRepresentation
ConnectApi.MuteCapability
ConnectApi.MuteSummary
ConnectApi.NamedCredential
ConnectApi.NamedCredentialCalloutOptions
ConnectApi.NamedCredentialList
ConnectApi.NamedCredentialParameter
ConnectApi.NavigationMenuItem
ConnectApi.NavigationMenuItemCollection
ConnectApi.NavigationMenuPageReference
ConnectApi.NBAActionParameter
ConnectApi.NBAFlowAction
ConnectApi.NBANativeRecommendation
ConnectApi.NBARecommendation
ConnectApi.NBARecommendations
ConnectApi.NetworkConnection
ConnectApi.NewUserAudienceCriteria
ConnectApi.OAuthCredentialAuthUrl
ConnectApi.OauthProviderInfo
ConnectApi.ObjectMetadata
ConnectApi.ObjectQueryInfo
ConnectApi.OCIBaseOutputRepresentation
ConnectApi.OCICreateReservationErrorOutputRepresentation
ConnectApi.OCICreateReservationOutputRepresentation
ConnectApi.OCICreateReservationSingleOutputRepresentation
ConnectApi.OCIFulfillReservationErrorOutputRepresentation
ConnectApi.OCIFulfillReservationOutputRepresentation
ConnectApi.OCIFulfillReservationSingleOutputRepresentation
ConnectApi.OCIFutureInventoryOutputRepresentation
ConnectApi.OCIGetInventoryAvailabilityOutputRepresentation
ConnectApi.OCIInventoryRecordOutputRepresentation
ConnectApi.OCILocationAvailabilityOutputRepresentation
ConnectApi.OCILocationGroupAvailabilityOutputRepresentation
ConnectApi.OCIPublishLocationStructureOutputRepresentation
ConnectApi.OCIPublishLocationStructureStatusOutputRepresentation
ConnectApi.OCIReleaseReservationErrorOutputRepresentation
ConnectApi.OCIReleaseReservationOutputRepresentation
ConnectApi.OCIReleaseReservationSingleOutputRepresentation
ConnectApi.OCITransferReservationErrorOutputRepresentation
ConnectApi.OCITransferReservationOutputRepresentation
ConnectApi.OCITransferReservationSingleOutputRepresentation
ConnectApi.OCIUpdateReservationErrorOutputRepresentation
ConnectApi.OCIUpdateReservationOutputRepresentation
ConnectApi.OCIUpdateReservationSingleOutputRepresentation
ConnectApi.OCIUploadInventoryAvailabilityOutputRepresentation
ConnectApi.OCIUploadInventoryAvailabilityStatusOutputRepresentation
ConnectApi.OrchestrationInstance
ConnectApi.OrchestrationInstanceCollection
ConnectApi.OrchestrationStageInstance
ConnectApi.OrchestrationStepInstance
ConnectApi.OrchestrationWorkItem
ConnectApi.OrderDeliveryGroupSummary
ConnectApi.OrderDeliveryGroupSummaryCollection
ConnectApi.OrderDeliveryGroupSummaryLookupOutput
ConnectApi.OrderDeliveryMethodLookupOutput
ConnectApi.OrderItemSummary
ConnectApi.OrderItemSummaryAdjustmentAggregates
ConnectApi.OrderItemSummaryAdjustmentCollection
ConnectApi.OrderItemSummaryAdjustmentList
ConnectApi.OrderItemSummaryCollection
ConnectApi.OrderItemSummaryLookupOutput
ConnectApi.OrderItemSummaryOutputRepresentation
ConnectApi.OrderItemSummaryProduct
ConnectApi.OrderQuantitiesOutputRepresentation
ConnectApi.OrderShipment
ConnectApi.OrderShipmentCollection
ConnectApi.OrderShipmentItem
ConnectApi.OrderShipmentItemCollection
ConnectApi.OrderSummaryAdjustment
ConnectApi.OrderSummaryAdjustmentAggregates
ConnectApi.OrderSummaryAdjustmentAggregatesAsyncOutput
ConnectApi.OrderSummaryAdjustmentCollection
ConnectApi.OrderSummaryCollectionRepresentation
ConnectApi.OrderSummaryLookupOutput
ConnectApi.OrderSummaryOutputRepresentation
ConnectApi.OrderSummaryProductLookupOutput
ConnectApi.OrderSummaryRepresentation
ConnectApi.OrderSummaryProductAttribute
ConnectApi.OrderToCartFailedProduct
ConnectApi.OrderToCartResult
ConnectApi.OrganizationSettings
ConnectApi.OriginCapability
ConnectApi.OutOfOffice
ConnectApi.PageInfo
ConnectApi.PardotBusinessUnitContextItem
ConnectApi.PardotBusinessUnitContextOutput
ConnectApi.PaymentAuthAdjustmentResponse
ConnectApi.PaymentAuthorizationResponse
ConnectApi.PaymentGroupResponse
ConnectApi.PaymentMethodDetails
ConnectApi.PaymentMethodResponse
ConnectApi.PaymentMethodTokenizationGatewayResponse
ConnectApi.PaymentMethodTokenizationResponse
ConnectApi.PaymentResponse
ConnectApi.PercentRecordField
ConnectApi.PhoneNumber
ConnectApi.Photo
ConnectApi.PicklistRecordField
ConnectApi.PinCapability
ConnectApi.PinnedFeedElements
ConnectApi.PlatformAction
ConnectApi.PlatformActionGroup
ConnectApi.PollCapability
ConnectApi.PostAuthGatewayResponse
ConnectApi.PostAuthorizationResponse
ConnectApi.PreserveCart
ConnectApi.PreviewCancelOutputRepresentation
ConnectApi.PreviewCartToExchangeOrderOutputRepresentation
ConnectApi.PreviewReturnOutputRepresentation
ConnectApi.PriceAdjustmentSchedule
ConnectApi.PriceAdjustmentTier
ConnectApi.PricingResult
ConnectApi.PricingResultLineItem
ConnectApi.ProductAttributeInfo
ConnectApi.ProductAttributeSelectionInfo
ConnectApi.ProductAttributeSet
ConnectApi.ProductAttributeSetInfo
ConnectApi.ProductAttributeSetSummary
ConnectApi.ProductAttributeSummary
ConnectApi.ProductAttributesToProductEntry
ConnectApi.ProductAttributeValueMetadataRepresentation
ConnectApi.ProductCartItem
ConnectApi.ProductCartItemCollection
ConnectApi.ProductCategoryData
ConnectApi.ProductCategoryDetail
ConnectApi.ProductCategoryDetailCollection
ConnectApi.ProductCategoryMedia
ConnectApi.ProductCategoryMediaGroup
ConnectApi.ProductCategoryPath
ConnectApi.ProductChild
ConnectApi.ProductChildCollection
ConnectApi.ProductDeliverEstimationOutputRepresentation
ConnectApi.ProductDetail
ConnectApi.ProductDetailsOutputRepresentation
ConnectApi.ProductEntitlement
ConnectApi.ProductExpandOutputRepresentation
ConnectApi.ProductImageGroupOutputRepresentation
ConnectApi.ProductImageOutputRepresentation
ConnectApi.ProductsListOutputRepresentation
ConnectApi.ProductMedia
ConnectApi.ProductMediaGroup
ConnectApi.ProductOutputRepresentation
ConnectApi.ProductOverview
ConnectApi.ProductOverviewCollection
ConnectApi.ProductPrice
ConnectApi.ProductPriceEntry
ConnectApi.ProductReturnRateListOutputRepresentation
ConnectApi.ProductReturnRateOutputRepresentation
ConnectApi.ProductSearchFacetOutputRepresentation
ConnectApi.ProductSearchFacetValueOutputRepresentation
ConnectApi.ProductSearchImageOutputRepresentation
ConnectApi.ProductSearchOutputRepresentation
ConnectApi.ProductSearchProductOutputRepresentation
ConnectApi.ProductSearchResults
ConnectApi.ProductSearchSuggestionsResults
ConnectApi.ProductSellingModel
ConnectApi.ProductSummary
ConnectApi.ProductSummaryPage
ConnectApi.ProductVariantOutputRepresentation
ConnectApi.ProductVariationAttributeOutputRepresentation
ConnectApi.ProductVariationAttributeValueOutputRepresentation
ConnectApi.ProductVariationInfo
ConnectApi.PromotionApproachingDiscount
ConnectApi.PromotionCart
ConnectApi.PromotionCartAdjustmentGroup
ConnectApi.PromotionCartDeliveryMethodAdjustment
ConnectApi.PromotionCartItem
ConnectApi.PromotionCartItemPriceAdjustment
ConnectApi.PromotionCoupon
ConnectApi.PromotionEvaluation
ConnectApi.PurchaseQuantityRule
ConnectApi.QueryInfo
ConnectApi.QuestionAndAnswersCapability
ConnectApi.QuestionAndAnswersSuggestions
ConnectApi.QueryPath
ConnectApi.QueryPathConfig
ConnectApi.QueryPathConfigList
ConnectApi.RangeFacetDisplayMetadataRepresentation
ConnectApi.RangeSearchFacet
ConnectApi.RankAverageDistanceOutputRepresentation
ConnectApi.ReadBy
ConnectApi.ReadByCapability
ConnectApi.ReadByPage
ConnectApi.RecRepresentation
ConnectApi.Recommendation
ConnectApi.RecommendationsOutputRepresentation
ConnectApi.RecommendationAudience
ConnectApi.RecommendationAudiencePage
ConnectApi.RecommendationCollection
ConnectApi.RecommendationDefinition
ConnectApi.RecommendationDefinitionPage
ConnectApi.RecommendationExplanation
ConnectApi.RecommendationReaction
ConnectApi.RecommendationReactions
ConnectApi.RecommendationsCapability
ConnectApi.RecommendedObject
ConnectApi.RecordCapability
ConnectApi.RecordField
ConnectApi.RecordFieldValue
ConnectApi.RecordSnapshot
ConnectApi.RecordSnapshotCapability
ConnectApi.RecordSummary
ConnectApi.RecordSummaryList
ConnectApi.RecordView
ConnectApi.RecordViewSection
ConnectApi.RecordsetFilterCriteria
ConnectApi.RecordsetFilterCriteriaCollection
ConnectApi.Reference
ConnectApi.ReferenceRecordField
ConnectApi.ReferencedRefundResponse
ConnectApi.ReferenceWithDateRecordField
ConnectApi.RefundGatewayResponse
ConnectApi.RefundResponse
ConnectApi.RegisterGuestBuyerOutputRepresentation
ConnectApi.RelatedFeedPost
ConnectApi.RelatedFeedPosts
ConnectApi.RelatedQuestion
ConnectApi.ReleaseHeldFOCapacityOutputRepresentation
ConnectApi.ReleaseHeldFOCapacityResponseOutputRepresentation
ConnectApi.ReplyIntent
ConnectApi.ReplyIntents
ConnectApi.RepositoryFileDetail
ConnectApi.RepositoryFileSummary
ConnectApi.RepositoryFolderDetail
ConnectApi.RepositoryFolderItem
ConnectApi.RepositoryFolderItemsCollection
ConnectApi.RepositoryFolderSummary
ConnectApi.RepositoryGroupSummary
ConnectApi.RepositoryUserSummary
ConnectApi.Reputation
ConnectApi.ReputationLevel
ConnectApi.RequestHeader
ConnectApi.ResourceLinkSegment
ConnectApi.ReturnItemsOutputRepresentation
ConnectApi.ReturnOrderItemSplitLineOutputRepresentation
ConnectApi.ReturnOrderOutputRepresentation
ConnectApi.SaleGatewayResponse
ConnectApi.SaleResponse
ConnectApi.ScheduledRecommendation
ConnectApi.ScheduledRecommendationPage
ConnectApi.Scope
ConnectApi.ScopedSearchResults
ConnectApi.SearchAnswer
ConnectApi.SearchCategory
ConnectApi.SearchFacet
ConnectApi.SearchObject
ConnectApi.SearchResult
ConnectApi.SearchResultGroup
ConnectApi.SearchResultGroups
ConnectApi.SearchStatus
ConnectApi.SearchSuggestion
ConnectApi.ServiceAppointmentOutput
ConnectApi.ServiceAppointmentResult
ConnectApi.ShiftsFromPattern
ConnectApi.ShiftsFromPatternError
ConnectApi.SiteSearchItem
ConnectApi.SiteSearchResult
ConnectApi.SocialAccount
ConnectApi.SocialAccountRelationship
ConnectApi.SocialPostCapability
ConnectApi.SocialPostIntents
ConnectApi.SocialPostMassApprovalOutput
ConnectApi.SocialPostStatus
ConnectApi.SocialStatusRepresentation
ConnectApi.SortRule
ConnectApi.SortRulesCollection
ConnectApi.SpellCorrectionInfo
ConnectApi.Stamp
ConnectApi.StaticData
ConnectApi.StaticDataConfig
ConnectApi.StatusCapability
ConnectApi.StrategyTrace
ConnectApi.StrategyTraceNode
ConnectApi.SubmitCancelOutputRepresentation
ConnectApi.SubmitCartToExchangeOrderOutputRepresentation
ConnectApi.SubmitReturnOutputRepresentation
ConnectApi.Subscription
ConnectApi.SubscriptionTermRule
ConnectApi.SupportedEmojis
ConnectApi.SurveyInvitationEmailOutput
ConnectApi.Target
ConnectApi.TargetCollection
ConnectApi.TaxAddressesResponse
ConnectApi.TaxAddressResponse
ConnectApi.TaxAmountDetailsResponse
ConnectApi.TaxDetailsResponse
ConnectApi.TaxEngineLogResponse
ConnectApi.TaxImpositionResponse
ConnectApi.TaxJurisdictionResponse
ConnectApi.TaxTransactionResponse
ConnectApi.TextClassificationsBulkResultsOutputRepresentation
ConnectApi.TextClassificationsOutputRepresentation
ConnectApi.TextClassificationsResultOutputRepresentation
ConnectApi.TextClassificationsResultWithIdOutputRepresentation
ConnectApi.TextSegment
ConnectApi.ThemeInfo
ConnectApi.TimeZone
ConnectApi.Topic
ConnectApi.TopicEndorsement
ConnectApi.TopicEndorsementCollection
ConnectApi.TopicEndorsementSummary
ConnectApi.TopicImages
ConnectApi.TopicPage
ConnectApi.TopicsCapability
ConnectApi.TopicSuggestion
ConnectApi.TopicSuggestionPage
ConnectApi.TopicSummary
ConnectApi.TrackedChangeBundleCapability
ConnectApi.TrackedChangeItem
ConnectApi.TrackedChangesCapability
ConnectApi.TypeAndFilter
ConnectApi.UnauthenticatedUser
ConnectApi.UnreadConversationCount
ConnectApi.UpDownVoteCapability
ConnectApi.UpVoteSummary
ConnectApi.User
ConnectApi.UserActivitiesJob
ConnectApi.UserActivityCollection
ConnectApi.UserActivitySummary
ConnectApi.UserCapabilities
ConnectApi.UserChatterSettings
ConnectApi.UserDetail
ConnectApi.UserFeedEntityActivitySummary
ConnectApi.UserGroupDetailPage
ConnectApi.UserGroupPage
ConnectApi.UserMission
ConnectApi.UserMissionActivitiesJob
ConnectApi.UserMissionActivity
ConnectApi.UserMissionActivityCollection
ConnectApi.UserMissionActivityStatus
ConnectApi.UserOauthInfo
ConnectApi.UserPage
ConnectApi.UserProfile
ConnectApi.UserProfileTab
ConnectApi.UserReferencePage
ConnectApi.UserSettings
ConnectApi.UserSummary
ConnectApi.VerifiedCapability
ConnectApi.Vote
ConnectApi.VotePage
ConnectApi.WebStoreMetaConfig
ConnectApi.WebStoreMetaConfigurations
ConnectApi.Wishlist
ConnectApi.WishlistItem
ConnectApi.WishlistItemCollection
ConnectApi.WishlistsSummary
ConnectApi.WishlistSummary
ConnectApi.WishlistToCartResult
ConnectApi.WrappedMapObject
ConnectApi.Zone
ConnectApi.ZonePage
ConnectApi.ZoneSearchPage
ConnectApi.ZoneSearchResult
ConnectApi Enums
ConnectApi Exceptions
ConnectApi Utilities
ConnectApi Release Notes
Context Namespace
DataRetrieval Namespace
ExternalService Namespace
Flowtesting Namespace
IndustriesDigitalLending Namespace
InvoiceWriteOff Namespace
PlaceQuote Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
Slack Namespace
ConnectApi.ProductOverview
Overview of a product, with summary information about prices, selected
fields, and the product’s default image.
| Property Name | Type | Description | Available Version |
|---|---|---|---|
| defaultImage | ConnectApi.ProductMedia | Media representation of the product's default image. | 54.0 |
| error | ConnectApi.ErrorResponse | Error code and error message. | 54.0 |
| fields | Map<String, String> | Map of fields belonging to the product. | 54.0 |
| id | String | ID of the product. | 54.0 |
| prices | ConnectApi.PricingResultLineItem |
Price of the product.
To get pricing information for products in version 58 and later, use the CommerceStorePricing Class. |
54.0–57.0 |
| sku | String | SKU of the product. | 54.0 |
| success | Boolean | Represents whether execution was successful and product overview information was retrieved without error. | 54.0 |