Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Request Bodies
Action Link Definition Input
Action Link Group Definition Input
Action Link Input
Action Link Template Binding Input
Activity Reminder Input
Address Input
Adjust Item Input
Adjust Order Item Summary Input
Alternative Input
Announcement Input
Article Topic Assignment Job Input
Asset File Input
Assigned Resource Input
Associated Actions Capability Input
Async Query Input
Audience Criterion Input
Audience Criterion Value Input
Audience Input
Available Territory Slots Input
Authorization API Payment Method Input
Authorization Input
Banner Photo Input
Batch Collection Input
Batch Input
Bookmarks Capability Input
Card Payment Method Input
Canvas Capability Input
Capture Input
Cart Input
Cart Item Input
Change Input
Change Item Input
Chatter Stream Input
Clean Input
Close Capability Input
Comment Input
Comment Capabilities Input
Community Input
Connectors Call Input
Connectors Call List Input
Content Capability Input
Create Credit Memo Input
Create Order Payment Summary Input
Custom List Audience Criteria Input
Custom Recommendation Audience Input
Custom Recommendation Definition Input
Datacloud Contact Import Input
Datacloud Order Input
Dashboard Component Snapshot Input
Digest Job Input
Direct Message Capability Input
Distinct Value Refinement Input
Duplicate Job Input
Duplicate Job Status Input
Ensure Funds Async Input
Ensure Refunds Async Input
Environment Hub SSO User Mapping Input
Extended Fields Input
Extension Input
Extensions Capability Input
Facetable Attribute Input
Facetable Attributes Collection Input
Feed Element Capabilities Input
Feed Entity Share Capability Input
Feed Favorite Input
Feed Item Input
Feed Item Topic Input
File Input
File ID Input
Files Capability Input
File Shares Input
Files Connect Field Value Input
Files Connect Item Input
Files Connect Permission Collection Input
Files Connect Permission Input
Folder Input
Folder Item Input
Following Input
Fulfillment Group Input
Fulfillment Order Input
Fulfillment Order Invoice Input
Fulfillment Order Line Item Input
Fulfillment Order Line Items To Cancel Input
Generic Batch Collection Input
Generic Batch Input
Group Chatter Settings Input
Group Information Input
Group Input
Group Member Input
Group Membership Request Update
Group Record Input
Invite Collection Input
Knowledge Article View Stat Input
Lead Input
Link Capability Input
List Current Share Collection Input
Managed Content Type Searchable Input
Managed Social Account Setup Input
Managed Topic Input
Managed Topic Position Collection Input
Managed Topic Position 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
Moderation Flag Input
Mute Capability 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
Order Item Summary Input
Order Summary Input
Payment Group Input
Payment Method Input
Photo Input
Pin Capability Input
Poll Capability Input
Pricing Input
Pricing Line Item Input
Product Search Input
Push Notification Input
Question and Answers Capability Input
Read By Capability Input
Recommendation Reaction Input
Record Capability Input
Referenced Refund Input
Request Header Input
Scheduled Custom Recommendation Input
Searchable Attribute Input
Searchable Attributes Collection Input
Search Product Setting Collection Input
Search Product Setting Input
Service Appointment Input
Service Appointments Input
Share Captured Activity Input
Share Input
Skill Requirement Input
Social Customer Service Configuration Input
Social Customer Service Message Type Settings Input
Social Customer Service Provider Settings Input
Social Post Mass Approval Input
Status Capability Input
Stream Subscription Input
Target Collection Input
Target Collection Update Input
Target Input
Target Update Input
Topic Assignment Input
Topic Endorsement Input
Topic Input
Topic Names Input
Topics Capability 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
Verified Capability Input
Wishlist Input
Wishlist Item Input
Work Type Input
Response Bodies
Appendices
PDF

Newer Version Available

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

Product Search Input

Product search.
JSON example
1{
2  "searchTerm": "lightweight",
3  "categoryId": "0ZGxx000000006TGAQ", //categoryId for women’s running shoes
4  "refinements": [
5   {  "nameOrId": "Color__c",
6      "values": ["red", "blue"],
7      "type": "DistinctValue"
8   },
9   {  
10      "nameOrId": "Size__c",
11      "values": ["5"],
12      "type": "DistinctValue"
13   }
14  ],
15  "fields": ["Name", "Description", "StockKeepingUnit", "Size__c", "Arch__c"],
16  "page" : 0,
17  "pageSize" : 25}
Properties
Name Type Description Required or Optional Available Version
categoryId String Category ID returns results for products in this category or its subcategories. Required if searchTerm isn’t specified 49.0
fields String[] Product fields to return in search results. Search results include fields you have access to. If unspecified, all accessible fields are returned. Optional 49.0
includePrices Boolean Specifies whether to include prices for products in search results (true) or not (false). If unspecified, defaults to false. Optional 49.0
page Integer Specifies the number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned. Optional 49.0
pageSize Integer Specifies the number of items per page. Valid values are from 1 through 200. If unspecified, the default is the value specified in Search Results per Page in Administration | General Settings | Products & Search. Optional 49.0
refinements Distinct Value Refinement Input[] Refinements for search results. Optional 49.0
searchTerm String A list of up to 32 space-separated search terms. Required if categoryId isn’t specified 49.0