Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Request Bodies
Response Bodies
Action Link Definition
Action Link Diagnostic
Action Link Group Definition
Activity Reminder
Activity Reminders Collection
Address
Adjust Order Summary Output
Alternative
Announcement
Announcement Page
Approval Capability
Approval Post Template Field
Approval Social Post Intent
Article Item
Article Recommendations Runtime Metric
Article Recommendations Runtime Metrics
Article Summary
Asset Action Output
Asset Action Source Output
Asset State Period Output
Asset Output
Asset Result Output
Asset File
Associated Actions Capability
Application Context
Async Query
Async Query Collection
Audience
Audience Collection
Audience Criteria Details
Audience Criterion Details
Audience Target
Audience Target Assignment
Authorization Gateway Response Output
Authorization Adjustment Output
Authorization Reversal Gateway Response Output
Authorization Reversal Output
Authorization Output
Available Location Output
Available Territory Slots
Available Territory Slots List
Available Territory Slots Output
Average Distance Result Output
AWS Inbound Network Connection Properties
AWS Outbound Network Connection Properties
Banner Capability
Banner Photo
Batch Result Item
Batch Results
Bookmark Summary
Bookmarks Capability
Call Collaboration Capability
Candidate Answers Status
Canvas Capability
Capacity Response Output
Cart Coupon
Cart Coupon Collection
Cart Coupon List
Cart Item
Cart Item Collection
Cart Item Product
Cart Item Promotion Collection
Cart Item Result
Cart Item Without Price
Cart Message
Cart Messages Summary
Cart Messages Visibility Result
Cart Product Attribute
Cart Promotion
Cart Promotion Collection
Cart Summary
Cart to Wishlist Result
Case Comment Capability
Capture Gateway Response Output
Capture Output
Change Item Output
Chatter Activity
Chatter Activity Summary
Chatter Directory
Chatter Influence
Chatter Likes Capability
Chatter Recommendation
Chatter Recommendations
Chatter Stream
Chatter Stream Collection
Checkout
Checkout Address
Checkout Error
Checkout Order
Checkout Payment
Clean Record Result
Clean Record Result Collection
Clean Rule Data Service
Clean Rule Data Service Collection
Clean Rule Data Service Metrics
Clean Rule Data Service Metrics Collection
Clean Rule Status
Clean Rule Status Collection
ClientInfo
Client-Side Payment Configuration
Close Capability
Comment
Comment Capabilities
Comment Page
Comment Summary
Comments Capability
Commerce Action Result
Commerce Address Collection
Commerce Address
Commerce Einstein Activity Export Job
Commerce Einstein Activity Purge Job
Commerce Einstein Configuration
Commerce Einstein Recommendation Results
Commerce Einstein Status
Commerce Search Index
Commerce Search Index Collection
Community
Community Create
Community Page
Community Publish
Community Summary
Community Template
Community Template Collection
Company Verify Summary
Confirm Held FO Capacity Output
Confirm Held FO Capacity Response Output
Connect Directory
Connectors Call Coaching Status
Connectors Call Coaching User Info
Connectors Voice Call List Result
Connectors Voice Call Result
Contact Information
Content
Content Capability
Conversation Bulk Upload
Conversation Bulk Uploads
Conversation Bulk Upload Status
Conversation Bulk Upload Statuses
Conversation Detail
Conversation Entries
Conversation Entries Update
Conversation Entry
Conversation Entry Update
Conversation Participant
Conversation Summary
Conversation Summary Collection
Conversation Unread Count
Coupon
Create Credit Memo Output
Create Order Payment Summary Output
Custom List Audience Criteria
Custom Recommendation Audience
Custom Recommendation Audience Collection
Custom Recommendation Definition
Custom Recommendation Definition Collection
Dashboard Component Snapshot
Dashboard Component Snapshot Capability
Data Integration Credit
Data Integration Credit Objects
Delete Intent
Delete Intents
Delete Social Post Intent
Delivery Group
Delivery Group Collection
Delivery Method
Digest Job
Direct Message Capability
Direct Message Member Collection
Direct Message Membership Activity
Direct Message Membership Activity Collection
Distance Calculation Output
Distinct Facet Value
Distinct Value Search Facet
Downvote Summary
Duplicate Directory
Duplicate Job
Duplicate Job Collection
Duplicate Job Definition
Duplicate Job Definition Collection
Edit Capability
Email Address
Email Attachment
Email Merge Field
Email Merge Field Collection
Email Message Capability
Emoji
Emoji Collection
Enhanced Link Capability
Ensure Funds Async Output
Ensure Refunds Async Output
Entity Label
Environment Hub My Domain Validation
Environment Hub OAuth URL
Environment Hub Sign-up Member Validation
Environment Hub SSO User Mapping Validation
Error Message
Error Response Output
Error with Output
Explanation Details
Explanation Summary
Extension
Extension Definition
Extension Definition Collection
Extensions Capability
External File Permission Information
External Managed Account Address Output
External Managed Account Collection Output
External Managed Account Output
Facetable Attribute
Facetable Attributes Collection
Favorite
Favorites Page
Features
Feed
Feed Directory
Feed Directory Item
Feed Element Capabilities
Feed Element Page
Feed Enabled Entity Summary
Feed Entity Is Editable
Feed Entity Not Available Summary
Feed Entity Read Summary
Feed Entity Share Capability
Feed Item
Feed Item Body
Feed Item Preamble Message Body
Feed Item Summary
Feed Modified Info
Feed Poll Choice
Feed Post Summary
Feed Read Summary
Feed Tracked Change
Field Value
File Detail
File Preview
File Preview Collection
File Preview URL
File Share Link
File Shares Page
File Summary
File Summary Page
Files Capability
Files Connect Allowed Item Type Collection
Files Connect Field Definition
Files Connect Item Type Detail
Files Connect Item Type Summary
Files Connect Permission
Files Connect Permission Collection
Files Connect Permission Type
Files Connect Provider Type
Files Connect Repository
Files Connect Repository Authentication
Files Connect Repository Collection
Files Connect Repository Features
Find Routes With Fewest Splits Output
Find Routes With Fewest Splits Using OCI Output
Find Routes With Fewest Splits With Inventory Output
Flat Feed
Flat Feed Item
Folder
Folder Item
Folder Item Page
Folder Path
Folder Share Link
Follow Social Persona Intent
Follow Social Persona Intents
Follower Page
Following Counts
Following Page
Forecasting Ancestors
Forecasting Manager
Forecasting Manager Ancestors
Forecasting My Forecasts
Forecasting My Forecasts Collection
Forecasting User
Forecasting User Access
Forecasting User Access Collection
Forecasting User Collection
Form
Form Field
Form Fields
Form Submission
Formula Scope
Fulfillment Group Output
Fulfillment Order Cancel Line Items Output
Fulfillment Order Invoice Output
Fulfillment Order Output
Gateway Log Output
Generic Bundle Capability
Generic Feed Element
Get FO Capacity Values Output
Group
Group Chatter Settings
Group Detail
Group Information
Group Member
Group Member Page
Group Membership Request
Group Membership Request Collection
Group Page
Group Record
Group Record Page
Hide Social Post Intent
Hold FO Capacity Output
Hold FO Capacity Response Output
Icon
Image File
Image File Detail
Inbound Network Connection AWS Topologies
Inbound Network Connection Topologies
Influence Thresholds
Interactions Capability
Invalid Parameter
Invite
Invite Collection
Knowledgeable People
Knowledgeable People Collection
Knowledge Article Version
Knowledge Article Version Collection
Lightning Extension Information
Like
Like Intent
Like Intents
Like Message Body
Like Page
Like Social Post Intent
Like Summary
Link Capability
Link Metadata
Link Metadata Collection
List Current Share Collection
List Share
List Share Category
List Share Collection
List View Column
List View Definition
List View Object
List View Record
List View Sort
Location Output
Location Capacity Output
Maintenance Information
Managed Content Associations
Managed Content Channel
Managed Content Channel Collection
Managed Content Channel Detail
Managed Content Channel Summary
Managed Content Channel Target Summary
Managed Content Date and Time Node Value
Managed Content Date Node Value
Managed Content Delivery Document
Managed Content Delivery Document Collection
Managed Content Delivery Document Summary
Managed Content Document
Managed Content Folder Summary
Managed Content Media Node Value
Managed Content Media Source Node Value
Managed Content Node Type
Managed Content Publish
Managed Content Reference
Managed Content Reference Summary
Managed Content Search Index
Managed Content Search Index Collection
Managed Content Search Result
Managed Content Search Result Collection
Managed Content Search Result Content Type
Managed Content Space
Managed Content Space Folder
Managed Content Space Folder Detail
Managed Content Space Summary
Managed Content Text Node Value
Managed Content Type
Managed Content Type Searchable
Managed Content Type Searchable Collection
Managed Content Type Summary
Managed Content Unpublish
Managed Content User Summary
Managed Content Variant
Managed Content Version
Managed Content Version Collection
Managed Social Account
Managed Social Account Setup
Managed Social Account Setup Authentication
Managed Social Accounts
Managed Social Accounts Setup
Managed Topic
Managed Topic Collection
Media Reference
Media Reference Capability
Mention Completion
Mention Completion Page
Mention Validation
Mention Validations
Message
Message Collection
Message Segment: Entity Link
Message Segment: Field Change
Message Segment: Field Change Name
Message Segment: Field Change Value
Message Segment: Hashtag
Message Segment: Inline Image
Message Segment: Link
Message Segment: Markup Begin
Message Segment: Markup End
Message Segment: Mention
Message Segment: More Changes
Message Segment: Resource Link
Message Segment: Text
Messaging Channel
Messaging Channels
Microbatching Error Record Info
Microbatching Error Record Info Collection
Microbatching Error Record Info Request Body
Microbatching Error Resubmission
Microbatching Ingestion Output
Moderation Audit Record Count
Moderation Capability
Moderation Flag Item
Moderation Flags
Moderation Flags Collection
Motif
Multiple FulfillmentOrder Invoices Output
Multiple Fulfillment Order Output
Mute Capability
Mute Summary
Navigation Menu Item
Navigation Menu Item Collection
Network Connection
New User Audience Criteria
Next Best Action Flow Action
Next Best Action Native Recommendation
Next Best Action Parameter
Next Best Action Recommendation
Next Best Action Recommendations
Notification
Notification App Setting
Notification App Settings Collection
Notification Collection
Notification Member
Notification Setting
Notification Settings Collection
Notification Status
OAuth Provider
OAuth User
OCI Create Reservation Error Output
OCI Create Reservation Output
OCI Create Reservation Single Output
OCI Fulfill Reservation Error Output
OCI Fulfill Reservation Output
OCI Fulfill Reservation Single Output
OCI Future Inventory Output
OCI Get Inventory Availability Output
OCI Inventory Record Output
OCI Location Availability Output
OCI Location Group Availability Output
OCI Publish Location Structure Output
OCI Publish Location Structure Status Output
OCI Release Reservation Error Output
OCI Release Reservation Output
OCI Release Reservation Single Output
OCI Transfer Reservation Error Output
OCI Transfer Reservation Output
OCI Transfer Reservation Single Output
OCI Upload Inventory Availability Output
OCI Upload Inventory Availability Status Output
Orchestration Instance
Orchestration Instance Collection
Orchestration Stage Instance
Orchestration Step Instance
Orchestration Work Item
Order Delivery Group Summary
Order Item Summary Product
Order Delivery Group Summary Collection
Order Item Summary
Order Item Summary Adjustment Aggregates
Order Item Summary Adjustment Collection
Order Item Summary Adjustment List
Order Item Summary Collection
Order Item Summary Output
Order Shipment
Order Shipment Collection
Order Shipment Item
Order Shipment Item Collection
Order Summary
Order Summary Adjustment
Order Summary Adjustment Aggregates
Order Summary Adjustment Aggregates Async Output
Order Summary Adjustment Collection
Order Summary Collection
Order Summary Output
Organization
Origin Capability
Out of Office
Outbound Network Connection AWS Topologies
Outbound Network Connection Topologies
Pardot Business Unit Context Item
Pardot Business Unit Context Output
Payment Authorization Output
Payment Group Output
Payment Method Output
Payment Output
Payment Method Tokenization Gateway Response Output
Payment Method Tokenization Output
Payment Token
Phone Number
Photo
Pin Capability
Pinned Feed Element Collection
Platform Action
Platform Action Group
Poll Capability
Post Auth Output
Post Auth Gateway Response
Preview Cancel Output
Preview Return Output
Price Adjustment Schedule
Price Adjustment Tier
Pricing Result
Pricing Result Line Item
Priming Record
Priming Record Collection
Priming Records Stats
Priming Rule Error
Product Attribute Info
Product Attribute Selection Info
Product Attribute Set
Product Attribute Set Info
Product Attribute Set Summary
Product Attribute Summary
Product Attributes to Product Entry
Product Category
Product Category Detail
Product Category Detail Collection
Product Category Media
Product Category Media Group
Product Category Path
Product Detail
Product Details Output
Product Entitlement
Product Image Output
Product Image Group Output
Product Import
Product Media
Product Media Group
Product Overview
Product Overview Collection
Product Price
Product Search Results
Product Search Suggestions Results
Product Summary
Product Summary Collection
Product Variant Output
Product Variation Attribute Output
Product Variation Attribute Value Output
Product Variation Info
Promotion
Promotion Association
Promotion Association Collection
Promotion Execution
Promotion Target
Promotion Target Line Item
Purchase Quantity Rule
Question and Answers Capability
Question and Answers Suggestion Collection
Quick Text Preview Body
Quick Text Preview Body Part
Quick Text Runtime Body
Quip Content Document Link
Quip Linked Entity
Quip Related Records
Rank Average Distance Output
Read By
Read By Capability
Read By Collection
Recommendation Object
Recommendation Reaction
Recommendation Reaction Collection
Recommendations Capability
Recommended Object
Record Capability
Record Field
Record Field: Blank
Record Field: Compound
Record Field: Currency
Record Field: Date
Record Field: Percent
Record Field: Picklist
Record Field: Reference
Record Field: Reference with Date
Record Snapshot
Record Snapshot Capability
Record Summary
Record Summary List
Record View
Record View Section
Recordset Filter Criteria
Recordset Filter Criteria Collection
Reference
Referenced Refund Service Output
Refund Gateway Response Output
Refund Output
Refund Service Output
Related Feed Post
Related Feed Post Collection
Related Question
Release Held FO Capacity Output
Release Held FO Capacity Response Output
Reply Recommendations Metric
Reply Recommendations Metrics
Reply Social Post Intent
Reply Social Post Intents
Repository Directory Entry Collection
Repository File Detail
Repository File Summary
Repository Folder Detail
Repository Folder Item
Repository Folder Items Collection
Repository Folder Summary
Repository Group Summary
Repository Permission Type Collection
Repository User Summary
Reputation
Reputation Level
Request Header
Return Items Output
Return Order Item Split Line Output
Return Order Output
Sale Gateway Response
Sale Output
Salesforce CDP Query Data Output
Salesforce CDP Query Metadata Item
Salesforce CDP Query Metadata Output
Salesforce CDP Query Output
Salesforce CDP Query Output V2
Salesforce CDP Query V2 Row
Salesforce CDP Segment Container Output
Salesforce CDP Segment Dbt Model
Salesforce CDP Segment Dbt Pipeline
Salesforce CDP Segment Output
Scheduled Custom Recommendation
Scheduled Custom Recommendation Collection
Scope
Searchable Attribute
Searchable Attributes Collection
Search Category
Search Product Setting Collection Output
Search Product Setting Output
Search Suggestion
Service Appointment Output
Service Appointment Result
Service Territories List Result
Service Territories Output
Service Territories Result
Session Context
Share Captured Activity Result
Shares
Shifts from Pattern
Shift Pattern Error
Site Search Item
Site Search Result
Social Account
Social Account Relationship
Social Customer Service Configuration
Social Customer Service Message Type Settings
Social Customer Service Provider Settings
Social Post Capability
Social Post Intents
Social Post Mass Approval
Social Post Status
Sort Rule
Sort Rules Collection
Stamp
Status Capability
Strategy Trace
Strategy Trace Node
Submit Cancel Output
Submit Return Output
Subscription
Subscription Page
Supported Emojis
Survey Email
Target
Target Collection
Terms of Service
Time Zone
Topic
Topic Collection
Topic Endorsement
Topic Endorsement Collection
Topic Endorsement Summary
Topic Images
Topic Opt Out
Topic Opt Out Collection
Topic Suggestion
Topic Suggestion Collection
Topic Summary
Topics Capability
Topics People Are Knowledgeable About
Topics People Are Knowledgeable About Collection
Tracked Change Bundle Capability
Tracked Changes Capability
Unauthenticated User
Up Down Vote Capability
Upvote Summary
User Activities Job
User Activity Collection
User Capabilities
User Chatter Settings
User Detail
User External Credential
User External Credential Auth URL
User Group Detail Collection
User Group Page
User Mission
User Mission Activities Job
User Mission Activity
User Mission Activity Collection
User Mission Activity Status
User Page
User Profile
User Profile Tab
User Reference Collection
User Settings
User Status
User Summary
Verified Capability
Vote
Vote Collection
Wishlist
Wishlist Item
Wishlist Item Collection
Wishlist Summaries
Wishlist Summary
Wishlist to Cart Result
Workspace Permission
Zone
Zone Page
Zone Search Page
Zone Search Result
Appendices
PDF

Newer Version Available

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

Session Context

Session context for a shopper using a Commerce store.
Property Name Type Description Filter Group and Version Available Version
guestUser Boolean Indicates if the session context is for a guest user (true) or not (false). Small, 54.0 54.0
userId String ID of the user. Small, 54.0 54.0
userName String Full name of the user. Small, 54.0 54.0