Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
Quick Start
Work with Features
Resources
Chatter Resources
Request Bodies
Action Info Input
Action Link Definition Input
Action Link Group Definition Input
Action Link Input
Action Link Template Binding Input
Activity Reminder Input
Add Order To Cart Input
Address Input
Adjust Item Input
Adjust Order Item Summary Input
Alternative Input
Alternative Payment Method Input
Announcement Input
Article Topic Assignment Job Input
Asset Action Input
Asset Action Source Input
Fetch Files Input
Asset File Input
Asset State Period Input
Assigned Resource Input
Associated Actions Capability Input
Audience Criterion Input
Audience Criterion Value Input
Audience Input
Authorization API Payment Method Input
Authorization Input
Authorization Reversal Input
Available Territory Slots Input
Banner Photo Input
Batch Collection Input
Batch Input
Bookmarks Capability Input
Boolean List Input
Boost and Bury Rule Condition Input
Boost and Bury Rule Input
Boost and Bury Rule Target Expression Input
Bot Utterance Collection Prediction From Set Input
Bot Utterance Collection Prediction Input
Bot Version Activation Input
Business Objective Association Input
Business Objective Input
Business Objective Insights Input
Business Objective Recommendation Input
Business Objective Details Input
Buyer Profile Input
Buyer Profile Initiate OTP Input
Buyer Profile Verification Input
Buyer Profile Verify Input
Buyer Registration Input
Calculate Taxes Input
Calculate Taxes Item Group Input
Calculate Taxes Line Item Input
Cancel All Order Items Input
Cancel Asset Input
Canvas Capability Input
Capacity Request Input
Capture Input
Card Payment Method Input
Card Payment Method Tokenization Input
Cart Coupon Input
Cart Input
Cart Inventory Reservation Input (Pilot)
Cart Item Input
Cart Item Promotion Collection Input
Cart Item Promotion Input
Cart Messages Visibility Input
Cart to Wishlist Input
Category Import Abort Input
Category Import Input
Category Settings Input
Change Asset Input
Change Input
Change Item Fee Input
Change Item Fee Tax Input
Change Item Fee With Tax Input
Change Item Input
Change Order Adjustment Group Summary Input
Change Order Delivery Group Summary Input
Change Order Item Adjustment Line Summary Input
Change Order Item Summary Input
Change Order Item Tax Line Item Summary Input
Change Order Summary Input
Chatter Stream Input
Checkout Address Input
Checkout Coupon Input
Checkout Input
Checkout Order Action Input
Checkout Order Action List Input
Checkout Order Action Parameters Input
Checkout Payment Input
Checkout Start Address Input
Checkout Start Input
Clean Input
Close Capability Input
Comment Capabilities Input
Comment Input
Commerce Address Field Input
Commerce Address Input
Commerce Einstein Activity Job Input
Commerce Extension Provider Apex Class Input
Commerce Extension Provider Input
Commerce Extension Provider Mapping Input
Commerce Subscription Cancel Input
Commerce Subscription Amend Input
Commerce Subscription Renew Input
Commerce Subscription Renewal Price Forecast Input
Commerce Subscription IDs List Input
Commerce Subscription Saved Payment Method Input
Community Input
Composite Commerce Variation Input
Composite Promotion Qualifier Input
Composite Promotion Segment Input
Composite Promotion Target Input
Composite Promotion Translation Input
Composite Product Input
Composite Promotion Input
Confirm Held FO Capacity Input
Confirm Held FO Capacity Request Input
Connectors Call Input
Connectors Call List Input
Contact Information Input
Content Capability Input
Content Taxonomy Term Input
Conversation Entries Update Input
Conversation Entry Update Input
Coupon Code Redemption Input
Create Credit Memo Input
Create Invoice From Change Orders Input
Create Multiple Invoices From Change Orders Input
Create Order Payment Summary Input
Credit Memo Input
Credential Custom Header Input
Credential Input
Credential Value Input
Custom List Audience Criteria Input
Custom Recommendation Audience Input
Custom Recommendation Definition Input
Dashboard Component Snapshot Input
Data Category Group Collection Input
Data Category Group Input
Data Category Input
Delivery Address Input
Delivery Estimation Product Input
Delivery Group Input
Delivery Routing Engine Input
Digest Job Input
Direct Message Capability Input
Distinct Value Refinement Input
Distribute Picked Quantities Input
Distribute To Orders Input
Double List Input
Duplicate Job Input
Duplicate Job Status Input
Einstein LLM Additional Configuration Input
Einstein Prompt Record Input Representation
Einstein Prompt Template Generations Input
Engagement Signal Compound Metric
Engagement Signal Field Input
Engagement Signal Filter Group Collection Input
Engagement Signal Filter Group Input
Engagement Signal Filter Input
Engagement Signal
Engagement Signal Metric Collection Input
Engagement Signal Metric Field Input
Engagement Signal Metric Input
Engagement Signal Parameter Collection Input
Engagement Signal Parameter Input
Ensure Funds Async Input
Ensure Payment Credit Input
Ensure Refunds Async Input
Entitlement Settings Input
Environment Hub SSO User Mapping Input
Estimate Delivery Date Input
Estimated Wait Time Input
Extended Fields Input
Extension Input
Extensions Capability Input
External Auth Identity Provider Credential Input
External Auth Identity Provider Credentials Input
External Auth Identity Provider Input
External Auth Identity Provider Parameter Input
External Credential Input
External Credential Parameter Input
External Credential Principal Input
Facetable Attributes Collection Input
Facetable Attribute Input
Feed Element Capabilities Input
Feed Entity Share Capability Input
Feed Favorite Input
Feed Item Input
Feed Item Topic Input
File ID Input
File Input
File Share Link Input
File Shares Input
Files Capability Input
Files Connect Field Value Input
Files Connect Item Input
Files Connect Permission Collection Input
Files Connect Permission Input
Filter Input
Find Routes With Fewest Splits Group Using OCI Input
Find Routes With Fewest Splits Input
Find Routes With Fewest Splits Using OCI Input
Find Routes With Fewest Splits Using OCI Item Input
Folder Input
Folder Item Input
Following Input
Form Field Input
Form Input
Form Submission Field Input
Form Submission Input
Fulfillment Group Input
Fulfillment Order Input
Fulfillment Order Invoice Input
Fulfillment Order Line Item Input
Fulfillment Order Line Items To Cancel Input
Generate Asset Input
Generic Batch Collection Input
Generic Batch Input
Get FO Capacity Values Request Input
Global Product Import Input
Group Appointments Input
Group Chatter Settings Input
Group Information Input
Group Input
Group Member Input
Group Membership Request Update
Group Record Input
Hold FO Capacity Input
Hold FO Capacity Request Input
Import Configuration Input
Import Settings Input
Import Source Input
Include Search Rule Collection Input
Search Results Rules Collection Input
Include Search Rule Input
Inner Ensure Funds Async Input
Invite Collection Input
Invoice Configuration Override Input
Invoice Input
Invoice To Pay Input
Item Arrange Input
Item Arrangements Input
Item Quantity Input
Item Reference Input
Knowledge Article View Stat Input
Lead Input
Lightning Model Editor Config Input
Lightning Model Renderer Config Input
Lightning Model Schema Config Input
Lightning Model Types Config Input
Lightning Model Types Input
Line Adjustment Input
Link Capability Input
List Current Share Collection Input
Location Availability Input
Location Input
Location List Input
Long List Input
Managed Content Body Input
Managed Content Channel Create
Managed Content Channel Update
Managed Content Delivery Search Filters Input
Managed Content Delivery Search Input
Managed Content Delivery Search Taxonomy Query Input
Managed Content Document Clone Input
Managed Content Input
Managed Content Provider Instance Input
Managed Content Publish Input
Managed Content Space Channel Input
Managed Content Space Channels Input
Managed Content Space Input
Managed Content Space Update Input
Managed Content Taxonomy Terms Input
Managed Content Type Searchable Input
Managed Content Unpublish Input
Managed Content Variant Input
Managed Content Variant Update Input
Managed Social Account Setup Input
Managed Topic Input
Managed Topic Position Collection Input
Managed Topic Position Input
MCS Folder Share Collection Update Input
MCS Folder Share Input
Media Settings Input
Message Body Input
Message Segment Input: Entity Link
Message Segment Input: Hash Tag
Message Segment Input: Inline Image
Message Segment Input: Link
Message Segment Input: Markup Begin
Message Segment Input: Markup End
Message Segment Input: Mention
Message Segment Input: Text
Messaging Channel Input
Microbatching Ingestion Input
Moderation Flag Input
Multiple Ensure Funds Async Input
Multiple Fulfillment Order Input
Multiple Fulfillment Order Invoices Input
Mute Capability Input
Named Credential Callout Options Input
Named Credential Input
Named Credential Parameter Input
Network Connection Input
New User Audience Criteria Input
Next Best Action Strategy Input
Notification App Setting Input
Notification Collection Input
Notification Input
Notification Member Input
Notification Setting Input
OAuth Credential Auth URL Input
Object Input
OCI Attribute Set Input
OCI Batch Update Input
OCI Batch Update Single Input
OCI Create Reservation Input
OCI Create Reservation Single Input
OCI Fulfill Reservation Input
OCI Fulfill Reservation Single Input
OCI Future Stock Single Input
OCI Get Inventory Availability Input
OCI Inventory Check Availability Input
OCI Location Check Availability Input
OCI Location Group Check Availability Input
OCI Product Check Availability Input
OCI Release Reservation Input
OCI Release Reservation Single Input
OCI Transfer Reservation Input
OCI Transfer Reservation Single Input
OCI Update Reservation Input
OCI Update Reservation Single Input
Order By Input
Order Item Summary Adjustment Collection Input
Order Item Summary Adjustment Input
Order Item Summary Input
Order Summary Adjustment Aggregates Async Input
Order Summary Authorization Input
Order Summary Graph Input
Order Summary Graphs Input
Order Summary Input
Order Summary Lookup Input
Order Summary Verification Input
Order to Cart Input
Payment Credit Sequence Input
Payment Credit Sequence Item Input
Payment Group Input
Payment Info
Payment Intents Input
Payment Link To Order Input
Payment Method Input
Payment Method Tokenization Input
Payment Token Input
Personalization Experiment Attribute Value Input
Personalization Experiment Base Input
Personalization Experiment Cohort Input
Personalization Experiment Input
Personalization Experiment Metric Reference Input
Personalization Experiment Parameter Base Input
Personalization Experiment Parameter Value Reference Input
Personalization Experiment Primary Metric Reference Input
Personalization Recommender Abstract Field Rule Input
Personalization Recommender Base Input
Personalization Recommender Base Patch Input
Personalization Recommender Base Predicate Input
Personalization Recommender Base Rule Input
Personalization Recommender Boolean Predicate Input
Personalization Recommender Calculated Insight Predicate Input
Personalization Recommender Calculated Insight Rule Input
Personalization Recommender Date Only Predicate Input
Personalization Recommender Field Predicate Input
Personalization Recommender Field Rule Input
Personalization Recommender Number Predicate Input
Personalization Recommender Patch Input
Personalization Recommender Input
Personalization Recommender Related Field Predicate Input
Personalization Recommender Related Field Rule Input
Personalization Recommender Relative To Now Predicate Input
Personalization Recommender Rule Group Input
Personalization Recommender Segment Membership Predicate Input
Personalization Recommender Sort Criteria Input
Personalization Recommender Text Predicate Input
Personalization Transformer Substitution Variable Input
Personalization Transformer Input
Personalization Transformer Type Details Input
Photo Input
Pin Capability Input
Poll Capability Input
Post Auth Input
Post Authorization API Payment Method Input
Preview Cart to Exchange Order Input
Price Settings Input
Pricing Input
Pricing Line Item Input
Product Attribute Set Input
Product Import Cancel Input
Product Media Input
Product Pricing Input
Product Search Grouping Input
Product Search Input
Product Variation Input
Program Application File Input
Program Application Input
Program Application Item Input
Promotion Cart Adjustment Group Input
Promotion Cart Delivery Group Input
Promotion Cart Delivery Group Method Input
Promotion Cart Input
Promotion Cart Item Input
Promotion Coupon Input
Promotion Evaluation Input
Promotion Parent Products Input
Promotion Product Categories Input
Promotion Product Evaluation Input
Promotion Product Input
Push Notification Input
Quantity With SKU Input
Question and Answers Capability Input
Range Refinement Input
Rank Average Distance Input
Read By Capability Input
Recommendation Reaction Input
Record Capability Input
Recordset Filter Criteria Input
Referenced Refund Input
Refund Instructions Hint Input
Refund Sequence Item Input
Release Held FO Capacity Input
Release Held FO Capacity Request Input
Request Header Input
Return Items Input
Return Order Input
Return Order Item Delivery Charge Input
Return Order Item Fee Input
Return Order Item Input
Return Order Line Item Fee Input
Return Order Line Item Input
Routing Product Input
Sale API Payment Method Input
Sale Input
Saved Payment Method Input
Scheduled Custom Recommendation Input
Searchable Attribute Input
Searchable Attributes Collection Input
Search Data Category Input
Search Product Setting Collection Input
Search Product Setting Input
Search Request Input
Sequence Order Payment Summary Input
Service Appointment Input
Service Appointment Update Input
Service Appointments Create Input
Share Captured Activity Input
Share Input
Shared Order Payment Summary Sequence
Shifts from Pattern Input
Ship to Address Input
Shipping Carrier Input
Shipping Carrier Method
Skill Requirement Input
sObject Attributes Input
Sort Rule Input
Sort Rules Collection Input
Staged Credentials Input
Status Capability Input
Stream Subscription Input
String List Input
Submit Cart to Exchange Order Input
Survey Description Input
Survey Email Input
Survey Integer Question Response Input
Survey Invitation Settings Input
Survey Page Response Input
Survey Question Response Input
Survey Recipient Engagement Context Input
Survey Recipient Survey Subjects Input
Survey Response Input
Survey Selection Question Choice Input
Survey Selection Question Response Input
Survey Text Question Response Input
Target Collection Input
Target Collection Update Input
Target Input
Target Location Input
Target Update Input
Text Classification Input
Topic Assignment Input
Topic Endorsement Input
Topic Input
Topic Names Input
Topics Capability Input
Translation Workbench Export Filters Input
Translation Workbench Export Input
Translation Workbench Time Range Filter Input
Up Down Vote Capability Input
User Chatter Settings Input
User ID Collection Input
User Input
User Message
User Message Recipient Input
User Message Recipient List Input
User Mission Activity Input
User Status Input
User Stream (Conversation) Input
Utterance Prediction Input
Verified Capability Input
Voice Root Email Address Update Accept Input
Voice Root Email Address Update Start Input
Waitlist Check In Input
Waitlist Participants Input
Webstore Settings Input
Wishlist Input
Wishlist Item Input
Wishlist Update Input
Work Type Input
Wrapped Value
Response Bodies
Appendices
PDF

Checkout Input

Input for a Commerce store checkout.
Root XML tag
<checkout>
JSON examples
Here’s an example of a request including contact information and Cart custom fields:

The PATCH request fails if it includes contact information with Cart Delivery Group custom fields or with both Cart and Cart Delivery Group custom fields.

Note

1{
2  "contactInfo": {
3    "firstName": "Alan",
4    "lastName": "Johnson",
5    "email": "al**@jo*****.com",
6    "phoneNumber": "******3944"
7  },
8  "customFields": [
9    {
10      "attributes": {
11        "type": "WebCart"
12      },
13      "Id": "0a6xx0000000000",
14      "MyCustomTextField__c": "Foo",
15      "MyCustomNumberField__c": 12.34,
16      "MyCustomPercentField__c": 0.2345,
17      "MyCustomGeolocationField__c": {
18        "latitude": 33.345,
19        "longitude": 45.567
20      }
21    }
22  ]
23}
Here’s an example of a request including delivery method and custom fields:

A PATCH request that includes deliveryMethodId clears all payment information for the checkout, including WebCart.BillingAddress.

Note

1{
2  "deliveryMethodId": "7cdLT000000EzA5YAK",
3  "customFields": [
4    {
5      "attributes": {
6        "type": "WebCart"
7      },
8      "Id": "0a6xx0000000000",
9      "MyCustomTextField__c": "Foo",
10      "MyCustomNumberField__c": 12.34,
11      "MyCustomPercentField__c": 0.2345,
12      "MyCustomGeolocationField__c": {
13        "latitude": 33.345,
14        "longitude": 45.567
15      }
16    },
17    {
18      "attributes": {
19        "type": "CartDeliveryGroup"
20      },
21      "Id": "0a7SB000000oBujYAE",
22      "MyCustomTextField__c": "Bar",
23      "MyCustomNumberField__c": 4.55,
24      "MyCustomPhoneField__c": "******1212",
25      "MyCustomAddressField__c": {
26        "street": "100 Folsom Street",
27        "city": "San Francisco",
28        "state": "California", //This field isn't currently supported in custom fields.
29        "stateCode": "US_CA",
30        "postalCode": "93555",
31        "country": "United States", //This field isn't currently supported in custom fields.
32        "countryCode": "US",
33        "geocodeAccuracy": "City",
34        "latitude": 34,
35        "longitude": 85.9
36      }
37    }
38  ]
39}
Here’s an example of a request including shipping information (deliveryAddress, desiredDeliveryDate, and shippingInstructions) and custom fields:

The PATCH request fails if it includes only shipping instructions along with custom fields for either Cart or Cart Delivery Group.

Note

1{
2  "deliveryAddress": {
3    "name": "Alan Johnson",
4    "firstName": "Alan",
5    "lastName": "Johnson",
6    "region": "CA",
7    "country": "US",
8    "city": "San Francisco",
9    "street": "415 Mission St",
10    "postalCode": "94105"
11  },
12  "desiredDeliveryDate": "2021-05-28T16:41:41.090Z",
13  "shippingInstructions": "type code 1234 on gate keypad",
14  "customFields": [
15    {
16      "attributes": {
17        "type": "WebCart"
18      },
19      "Id": "0a6xx0000000000",
20      "MyCustomTextField__c": "Foo",
21      "MyCustomNumberField__c": 12.34,
22      "MyCustomPercentField__c": 0.2345,
23      "MyCustomGeolocationField__c": {
24        "latitude": 33.345,
25        "longitude": 45.567
26      }
27    },
28    {
29      "attributes": {
30        "type": "CartDeliveryGroup"
31      },
32      "Id": "0a7SB000000oBujYAE",
33      "MyCustomTextField__c": "Bar",
34      "MyCustomNumberField__c": 4.55,
35      "MyCustomPhoneField__c": "******1212",
36      "MyCustomAddressField__c": {
37        "street": "100 Folsom Street",
38        "city": "San Francisco",
39        "state": "California", //This field isn't currently supported in custom fields.
40        "stateCode": "US_CA",
41        "postalCode": "93555",
42        "country": "United States", //This field isn't currently supported in custom fields.
43        "countryCode": "US",
44        "geocodeAccuracy": "City",
45        "latitude": 34,
46        "longitude": 85.9
47      }
48    }
49  ]
50}
Here’s an example of a request including shipping information (deliveryAddress, desiredDeliveryDate, and shippingInstructions) without custom fields:

Any combination of these three sub-resources is valid if custom fields aren’t included in the request.

Note

1{
2  "deliveryAddress": {
3    "name": "Alan Johnson",
4    "firstName": "Alan",
5    "lastName": "Johnson",
6    "region": "CA",
7    "country": "US",
8    "city": "San Francisco",
9    "street": "415 Mission St",
10    "postalCode": "94105"
11  },
12  "desiredDeliveryDate": "2021-05-28T16:41:41.090Z",
13  "shippingInstructions": "type code 1234 on gate keypad"
14}
Here’s an example of a request for a guest user, including contact information and delivery address:
1{
2  "contactInfo": {
3    "firstName": "Alan",
4    "lastName": "Johnson",
5    "email": "al**@jo*****.com",
6    "phoneNumber": "******3944"
7  },
8  "deliveryAddress": {
9    "name": "Alan Johnson",
10    "firstName": "Alan",
11    "lastName": "Johnson",
12    "region": "CA",
13    "country": "US",
14    "city": "San Francisco",
15    "street": "415 Mission St",
16    "postalCode": "94105"
17  }
18}
Properties
Name Type Description Required or Optional Available Version
contactInfo Contact Information Input Contact information for the checkout. Optional 55.0
customFields sObject Attributes Input[]

Array of sObjects with respective custom fields. Currently, custom fields are supported on WebCart and CartDeliveryGroup entities. You can specify up to 21 sObjects in the array: one WebCart and multiple CartDeliveryGroups.

Field-level security rules from the shopper profile are applied to the custom fields. The rules are applied for registered shoppers and for the guest shopper profile.

You can specify this property only if you specify at least one other property. For example, you can set custom fields in PATCH checkouts when you specify the guest contact information or a delivery method (in addition to setting the delivery address).

The custom fields can be of type Checkbox, Currency, Date, Email, LongTextArea, Number, Percent, Phone, Text, TextArea, Url, Address, or Location. We currently don’t support updating the country and state fields through customFields as part of the address update using request. Instead, specify the countryCode and stateCode.

Use the yyyy-MM-dd format to specify date fields.

Use the yyyy-MM-ddTHH:mm:ss.SSS+/-HH:mm or yyyy-MM-ddTHH:mm:ss.SSSZ formats to specify dateTime fields. When a timezone is added to a UTC dateTime, the result is the date and time in that timezone.

Use the HH:mm.ss.SSS or HH:mm.ss.SSSZ formats to specify time fields. When a timezone is added to a UTC time, the result is the time in that timezone.

The customFields property isn't supported in stores built on an Aura template.

 Optional 60.0
delivery​Address Checkout Address Input Shipping address for the checkout. Optional 55.0
delivery​MethodId String Delivery method ID for the checkout.

When Shipping is disabled for your web store, updation of delivery method isn’t supported.

 Optional 55.0
desired​Delivery​Date String Desired delivery date for the checkout. Optional 55.0
shipping​Instructions String Special shipping instructions for the checkout. Optional 55.0