Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
Compression Namespace (Developer Preview)
ConnectApi Namespace
ActionLinks Class
Announcements Class
BotVersionActivation Class
CdpCalculatedInsight Class
CdpIdentityResolution Class
CdpQuery Class
CdpSegment Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
Clm Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommercePromotions Class
CommerceSearch Class
CommerceSearchConnectFamily Class
CommerceSearchSettings Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
ConversationApplicationDefinition Class
Datacloud Class
EinsteinLLM Class
EmailMergeFieldService Class
EmployeeProfiles Class
Exchanges Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FulfillmentOrder Class
Knowledge Class
LightningScheduler Class
ManagedContent Class
ManagedContentDelivery Class
ManagedTopics Class
MarketingIntegration Class
Mentions Class
Missions Class
NamedCredentials Class
NavigationMenu Class
NextBestAction Class
OmnichannelInventoryService Class
OMSAnalytics Class
Orchestration Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
PardotBusinessUnitContext Class
Payments Class
Personalization Class
PickTicket Class
QuestionAndAnswers Class
Recommendations Class
Records Class
RegisterGuestBuyer Class
Repricing Class
ReturnOrder Class
Routing Class
SalesforceInbox Class
Sites Class
SmartDataDiscovery Class
SocialEngagement Class
Surveys Class
TaxPlatform Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi.ActionLinkDefinitionInput
ConnectApi.ActionLinkGroupDefinitionInput
ConnectApi.ActionLinkTemplateBindingInput
ConnectApi.ActivitySharingInput
ConnectApi.AddressRequest
ConnectApi.AdjustItemInputRepresentation
ConnectApi.AdjustOrderItemSummaryInputRepresentation
ConnectApi.AlternativeInput
ConnectApi.AnnouncementInput
ConnectApi.ArticleTopicAssignmentJobInput
ConnectApi.AssociatedActionsCapabilityInput
ConnectApi.AssociateRecordsWithRecipientInput
ConnectApi.AudienceCriteriaInput
ConnectApi.AudienceCriterionInput
ConnectApi.AudienceCriterionValueInput
ConnectApi.AudienceInput
ConnectApi.AuditParamsRequest
ConnectApi.AuthApiPaymentMethodRequest
ConnectApi.AuthorizationReversalRequest
ConnectApi.AuthorizationRequest
ConnectApi.BannerPhotoInput
ConnectApi.BaseRequest
ConnectApi.BaseApiPaymentMethodRequest
ConnectApi.BatchInput
ConnectApi.BinaryInput
ConnectApi.BookmarksCapabilityInput
ConnectApi.BotVersionActivationInput
ConnectApi.CanvasCapabilityInput
ConnectApi.CapacityRequestInputRepresentation
ConnectApi.CaptureRequest
ConnectApi.AlternativePaymentMethod
ConnectApi.CardPaymentMethodRequest
ConnectApi.CartInput
ConnectApi.cartCouponInput
ConnectApi.CartInventoryReservationInputRepresentation (Pilot)
ConnectApi.CartItemInput
ConnectApi.CartItemPromotionCollectionInputRepresentation
ConnectApi.CartItemPromotionInputRepresentation
ConnectApi.CartMessagesVisibilityInput
ConnectApi.CartToWishlistInput
ConnectApi.CdpCalculatedInsightInput
ConnectApi.CdpIdentityResolutionConfigInput
ConnectApi.CdpIdentityResolutionConfigPatchInput
ConnectApi.CdpIdentityResolutionMatchCriterion
ConnectApi.CdpIdentityResolutionMatchCriterionPartyIdentificationInfo
ConnectApi.CdpIdentityResolutionMatchRule
ConnectApi.CdpIdentityResolutionReconciliationFieldRule
ConnectApi.CdpIdentityResolutionReconciliationRule
ConnectApi.CdpIdentityResolutionReconciliationSource
ConnectApi.CdpIdentityResolutionRunNowInput
ConnectApi.CdpQueryInput
ConnectApi.CdpSegmentDbtInput
ConnectApi.CdpSegmentDbtModelInput
ConnectApi.CdpSegmentInput
ConnectApi.ChangeInputRepresentation
ConnectApi.ChangeItemInputRepresentation
ConnectApi.ChangeItemFee​InputRepresentation
ConnectApi.ChatterGroupInput
ConnectApi.ChatterStreamInput
ConnectApi.CommentCapabilitiesInput
ConnectApi.CommentInput
ConnectApi.CommerceAddressInput
ConnectApi.CommerceAddressFieldInput
ConnectApi.ConfirmHeldFOCapacityInputRepresentation
ConnectApi.ConfirmHeldFOCapacityRequestInputRepresentation
ConnectApi.ContentCapabilityInput
ConnectApi.ContentHubFieldValueInput
ConnectApi.ContentHubItemInput
ConnectApi.ContractInputRepresentation
ConnectApi.CouponCodeRedemptionInput
ConnectApi.CouponCodeRedemptionInput
ConnectApi.CreateCreditMemoInputRepresentation
ConnectApi.CreateInvoiceFromChangeOrdersInputRepresentation
ConnectApi.CreateMultipleInvoicesFromChangeOrdersInputRepresentation
ConnectApi.CreateOrderPaymentSummaryInputRepresentation
ConnectApi.CreateServiceAppointmentInput
ConnectApi.CredentialInput
ConnectApi.CredentialCustomHeaderInput
ConnectApi.CredentialValueInput
ConnectApi.CustomListAudienceCriteriaInput
ConnectApi.DirectMessageCapabilityInput
ConnectApi.DistinctValueRefinementInput
ConnectApi.​EinsteinLlm​Additional​ConfigInput
ConnectApi.​EinsteinPrompt​Template​GenerationsInput
ConnectApi.EnsureFundsAsyncInputRepresentation
ConnectApi.EnsureRefundsAsyncInputRepresentation
ConnectApi.EntityLinkSegmentInput
ConnectApi.ExtendedFieldInput
ConnectApi.ExtensionInput
ConnectApi.ExtensionsCapabilityInput
ConnectApi.ExternalCredentialInput
ConnectApi.ExternalCredentialParameterInput
ConnectApi.ExternalCredentialPrincipalInput
ConnectApi.FeedElementCapabilitiesInput
ConnectApi.FeedElementCapabilityInput
ConnectApi.FeedElementInput
ConnectApi.FeedEntityShareCapabilityInput
ConnectApi.FeedItemInput
ConnectApi.FileIdInput
ConnectApi.FindRoutesWithFewestSplitsInputRepresentation
ConnectApi.FindRoutesWithFewestSplitsGroupUsingOCIInputRepresentation
ConnectApi.FindRoutesWithFewestSplitsUsingOCIInputRepresentation
ConnectApi.FindRoutesWithFewestSplitsUsingOCIItemInputRepresentation
ConnectApi.FilesCapabilityInput
ConnectApi.FormFieldInput
ConnectApi.FormInput
ConnectApi.FormSubmissionFieldInput
ConnectApi.FormSubmissionInput
ConnectApi.FulfillmentGroupInputRepresentation
ConnectApi.FulfillmentOrderInputRepresentation
ConnectApi.FulfillmentOrderInvoiceInputRepresentation
ConnectApi.FulfillmentOrderLineItemInputRepresentation
ConnectApi.FulfillmentOrderLineItemsToCancelInputRepresentation
ConnectApi.BaseRequest
ConnectApi.GetFOCapacityValuesRequestInputRepresentation
ConnectApi.GroupInformationInput
ConnectApi.HashtagSegmentInput
ConnectApi.HoldFOCapacityInputRepresentation
ConnectApi.HoldFOCapacityRequestInputRepresentation
ConnectApi.InlineImageSegmentInput
ConnectApi.InnerEnsureFundsAsyncInputRepresentation
ConnectApi.InviteInput
ConnectApi.InvoiceToPayInputRepresentation
ConnectApi.LeadInput
ConnectApi.LinkCapabilityInput
ConnectApi.LinkSegmentInput
ConnectApi.LocationInputRepresentation
ConnectApi.LocationAvailabilityInputRepresentation
ConnectApi.ManagedContentBodyInput
ConnectApi.ManagedContentDocumentCloneInput
ConnectApi.ManagedContentDocumentInput
ConnectApi.ManagedContentVariantUpdateInput
ConnectApi.ManagedContentPublishInput
ConnectApi.ManagedContentUnpublishInput
ConnectApi.ManagedTopicPositionCollectionInput
ConnectApi.ManagedTopicPositionInput
ConnectApi.MarkupBeginSegmentInput
ConnectApi.MarkupEndSegmentInput
ConnectApi.MentionSegmentInput
ConnectApi.MessageBodyInput
ConnectApi.MessageSegmentInput
ConnectApi.MultipleEnsureFundsAsyncInputRepresentation
ConnectApi.MultipleFulfillmentOrderInputRepresentation
ConnectApi.MultipleFulfillmentOrderInvoicesInputRepresentation
ConnectApi.MuteCapabilityInput
ConnectApi.NamedCredentialInput
ConnectApi.NamedCredentialCalloutOptionsInput
ConnectApi.NamedCredentialParameterInput
ConnectApi.NetworkConnectionInput
ConnectApi.NBAStrategyInput
ConnectApi.NewUserAudienceCriteriaInput
ConnectApi.OAuthCredentialAuthUrlInput
ConnectApi.OCICreateReservationInputRepresentation
ConnectApi.OCICreateReservationSingleInputRepresentation
ConnectApi.OCIFulfillReservationInputRepresentation
ConnectApi.OCIFulfillReservationSingleInputRepresentation
ConnectApi.OCIGetInventoryAvailabilityInputRepresentation
ConnectApi.OCIReleaseReservationInputRepresentation
ConnectApi.OCIReleaseReservationSingleInputRepresentation
ConnectApi.OCITransferReservationInputRepresentation
ConnectApi.OCITransferReservationSingleInputRepresentation
ConnectApi.OCIUpdateReservationInputRepresentation
ConnectApi.OCIUpdateReservationSingleInputRepresentation
ConnectApi.OrderItemSummaryInputRepresentation
ConnectApi.OrderItemSummaryAdjustmentInput
ConnectApi.OrderItemSummaryAdjustmentCollectionInput
ConnectApi.OrderSummaryInputRepresentation
ConnectApi.OrderSummaryAdjustmentAggregatesAsyncInput
ConnectApi.OrderSummaryLookupInput
ConnectApi.OrderSummaryVerificationInput
ConnectApi.OrderToCartInput
ConnectApi.PaymentGroupRequest
ConnectApi.PaymentInfoInputRepresentation
ConnectApi.PaymentMethodTokenizationRequest
ConnectApi.PhotoInput
ConnectApi.PinCapabilityInput
ConnectApi.PollCapabilityInput
ConnectApi.PostAuthRequest
ConnectApi.PostAuthApiPaymentMethodRequest
ConnectApi.PreviewCartToExchangeOrderInputRepresentation
ConnectApi.PricingInput
ConnectApi.PricingLineItemInput
ConnectApi.ProductSearchGroupingInput
ConnectApi.ProductSearchInput
ConnectApi.PromotionCartInput
ConnectApi.PromotionCartDeliveryGroupInput
ConnectApi.PromotionCartItemInput
ConnectApi.PromotionEvaluateInput
ConnectApi.PromotionParentProductsInput
ConnectApi.PromotionProductCategoriesInput
ConnectApi.QuantityWithSkuInputRepresentation
ConnectApi.QuestionAndAnswersCapabilityInput
ConnectApi.RankAverageDistanceInputRepresentation
ConnectApi.ReadByCapabilityInput
ConnectApi.SequenceOrderPaymentSummaryInputRepresentation
ConnectApi.sharedOrderPaymentSummarySequenceInputRepresentation
ConnectApi.SubmitCartToExchangeOrderInputRepresentation
ConnectApi.RecipientEngagementContextInput
ConnectApi.RecommendationAudienceInput
ConnectApi.RecommendationDefinitionInput
ConnectApi.RecommendationReactionInput
ConnectApi.RecordCapabilityInput
ConnectApi.RecordsetFilterCriteriaInput
ConnectApi.ReferencedRefundRequest
ConnectApi.RefinementInput
ConnectApi.RefundRequest
ConnectApi.ReleaseHeldFOCapacityInputRepresentation
ConnectApi.ReleaseHeldFOCapacityRequestInputRepresentation
ConnectApi.RequestHeaderInput
ConnectApi.ReturnItemsInputRepresentation
ConnectApi.ReturnOrderInputRepresentation
ConnectApi.ReturnOrderItemInputRepresentation
ConnectApi.ReturnOrderItemDeliveryChargeInputRepresentation
ConnectApi.ReturnOrderItemFeeInputRepresentation
ConnectApi.ReturnOrderLineItemInputRepresentation
ConnectApi.ReturnOrderLineItemFeeInputRepresentation
ConnectApi.SaleRequest
ConnectApi.SaleApiPaymentMethodRequest
ConnectApi.ScheduledRecommendationInput
ConnectApi.SellerDetailsRequest
ConnectApi.ServiceAppointmentInput
ConnectApi.ShiftsFromPatternInput
ConnectApi.SocialPostMassApprovalInput
ConnectApi.StatusCapabilityInput
ConnectApi.StreamSubscriptionInput
ConnectApi.SurveyInvitationEmailInput
ConnectApi.TargetCollectionInput
ConnectApi.TargetCollectionUpdateInput
ConnectApi.TargetLocationInputRepresentation
ConnectApi.TargetInput
ConnectApi.TargetUpdateInput
ConnectApi.CalculateTaxRequest
ConnectApi.TaxAddressRequest
ConnectApi.TaxAddressesRequest
ConnectApi.TaxCustomerDetailsRequest
ConnectApi.TaxLineItemRequest
ConnectApi.TaxTransactionRequest
ConnectApi.TextClassificationsInputRepresentation
ConnectApi.TextSegmentInput
ConnectApi.TopicInput
ConnectApi.TopicNamesInput
ConnectApi.TopicsCapabilityInput
ConnectApi.UpDownVoteCapabilityInput
ConnectApi.UpdateServiceAppointmentInput
ConnectApi.UserInput
ConnectApi.WishlistInput
ConnectApi.WishlistItemInput
ConnectApi.WishlistUpdateInput
ConnectApi.WrappedValue
Retired ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
ConnectApi Utilities
ConnectApi Release Notes
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace (Beta)
Functions Namespace
IndustriesDigitalLending Namespace
Invocable Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RichMessaging Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace (Developer Preview)
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ConnectApi.CouponCodeRedemptionInput

Input representation for coupon code redemption.
Property Type Description Required or Optional Available Version
buyer String ID of the buyer account or email address for a guest user. Required 60.0
couponCodes List<String> List of coupon codes. Required 58.0
effectiveAccountId String ID of the account. Required 58.0–59.0
transactionId String ID of the transaction, which must be a valid cart ID. Required 58.0