Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Chatter 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
Add Order To Cart Input
Alternative Input
Alternative Payment Method Input
Announcement Input
Article Topic Assignment Job Input
Asset Action Input
Asset Action Source 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 Reversal Input
Authorization Input
Available Territory Slots Input
Banner Photo Input
Batch Collection Input
Batch Input
Bookmarks Capability Input
Boost and Bury Rule Condition Input
Boost and Bury Rule Input
Boost and Bury Rule Target Expression Input
Bot Version Activation Input
Buyer Profile Input
Buyer Registration Input
Calculate Taxes Input
Calculate Taxes Item Group Input
Calculate Taxes Line Item 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 Inventory Reservation Input (Pilot)
Cart Input
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 Input
Change Item Fee Input
Chatter Stream Input
Checkout Address Input
Checkout Input
Checkout Coupon 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
Community Input
Composite Commerce Variation 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
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
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 Group Input
Digest Job Input
Direct Message Capability Input
Distinct Value Refinement Input
Distribute Picked Quantities Input
Distribute To Orders Input
Duplicate Job Input
Duplicate Job Status Input
Einstein LLM Additional Configuration Input
Einstein Prompt Template Generations Input
Ensure Funds Async Input
Ensure Refunds Async Input
Entitlement Settings Input
Environment Hub SSO User Mapping 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 Credential Input
External Credential Parameter Input
External Credential Principal 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 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
Find Routes With Fewest Splits Input
Find Routes With Fewest Splits Group Using OCI 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
Inner Ensure Funds Async Input
Invite Collection Input
Invoice To Pay Input
Item Quantity Input
Item Arrange Input
Item Arrangements Input
Item Reference Input
Knowledge Article View Stat Input
Lead Input
Line Adjustment Input
Link Capability Input
List Current Share Collection Input
Location Availability Input
Location Input
Managed Content Body Input
Managed Content Channel Create
Managed Content Channel Update
Managed Content Document Clone Input
Managed Content Input
Managed Content Publish Input
Managed Content Type Searchable Input
Managed Content Space Channel Input
Managed Content Space Channels Input
Managed Content Unpublish Input
Managed Content Variant Input
Managed Content Variant Update Input
Media Settings 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
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 Future Stock Single Input
OCI Create Reservation Input
OCI Create Reservation Single Input
OCI Fulfill Reservation Input
OCI Fulfill Reservation 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 Item Summary Adjustment Collection Input
Order Item Summary Adjustment Input
Order Item Summary Input
Order Summary Adjustment Aggregates Async 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 Group Input
Payment Info
Payment Link To Order Input
Payment Method Input
Payment Method Tokenization Input
Payment Token Input
Apple Pay Domain Input
Payment Intents 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 Import Input
Product Media Input
Product Pricing Input
Product Search Input
Product Search Grouping Input
Product Variation Input
Program Application Input
Program Application Item Input
Program Application File Input
Promotion Cart Delivery Group Input
Promotion Cart Input
Promotion Cart Item Input
Promotion Evaluation Input
Promotion Parent Products Input
Promotion Product Categories Input
Promotion Product Evaluation Input
Promotion Product Input
Composite Promotion Qualifier Input
Composite Promotion Segment Input
Composite Promotion Target Input
Composite Promotion Translation Input
Push Notification Input
Quantity With SKU Input
Question and Answers Capability Input
Rank Average Distance Input
Read By Capability Input
Recommendation Reaction Input
Record Capability Input
Recordset Filter Criteria Input
Referenced Refund 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
Sale API Payment Method Input
Sale Input
Saved Payment Method Input
Scheduled Custom Recommendation Input
Searchable Attribute Input
Searchable Attributes Collection Input
Search Product Setting Collection Input
Search Product Setting Input
Include Search Rule Collection Input
Include Search Rule Input
Sequence Order Payment Summary Input
Service Appointment Input
Service Appointment Update Input
Service Appointments Create Input
Share Captured Activity Input
Shared Order Payment Summary Sequence
Share Input
Shifts from Pattern Input
Skill Requirement Input
Ship to Address Input
Social Customer Service Configuration Input
Social Customer Service Message Type Settings Input
Social Customer Service Provider Settings Input
sObject Attributes Input
Social Post Mass Approval Input
Sort Rule Input
Sort Rules Collection Input
Status Capability Input
Stream Subscription 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
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
Waitlist Check In Input
Webstore Settings Input
Wishlist Input
Wishlist Item Input
Wishlist Update Input
Work Type Input
Wrapped Value
Response Bodies
Appendices
PDF

Newer Version Available

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

Composite Promotion Input

Input representation of the create promotion request.
Root XML tag
<createPromotion>
JSON example
1{
2   "active": false,
3   "areQualItemsExclFromDiscounts": false,
4   "currencyIsoCode": "USD",
5   "description": "This is fall promotion.Get 10% off on Product &#39;Alpine Energy Drink Chai Post 0.5L PET - 6 pack&#39;",
6   "discountOrder": "MostExpensive",
7   "discountRestriction": "None",
8   "displayName": {
9      "translations": {},
10      "value": "Fall Promotion"
11   },
12   "objective": "Upsell product in fall",
13   "isTiered": true,
14   "endDateTime": null,
15   "exclusivityType": "Class",
16   "maximumUsageCount": 1,
17   "name": "Fall Promotion",
18   "priorityNumber": null,
19   "qualifierCriteria": "All",
20   "segments": [
21      {
22         "id": "0ZESB0000006vja4AA",
23         "name": "Codecept B2B LWR Store",
24         "segmentType": "Webstore"
25      }
26   ],
27   "startDateTime": "2023-09-01T00:00:00Z",
28   "targetCriteria": "Any",
29   "targets": [
30      {
31         "adjustmentType": "PercentageDiscount",
32         "adjustmentValue": "10",
33         "currencyIsoCode": "USD",
34         "isMinItemCountRequired": false,
35         "restrictionQuantity": null,
36         "ruleCriteriaType": "ANY",
37         "targetReferences": [
38            {
39               "id": "01tSB0000002p01YAA",
40               "itemReferenceType": "Product",
41               "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack",
42               "operatorType": "EQUALS_TO"
43            }
44         ]
45      }
46   ],
47   "qualifiers": [
48      {
49         "currencyIsoCode": "USD",
50         "qualifierReferences": [
51            {
52               "id": "01tSB0000002p01YAA",
53               "itemReferenceType": "Product",
54               "name": "Alpine Energy Drink Chai Post 0.5L PET - 6 pack",
55               "operatorType": "EQUALS_TO"
56            }
57         ],
58         "qualifierType": "Quantity",
59         "qualifierValue": 2
60      }
61   ],
62   "termsAndCondition": {
63      "translations": {},
64      "value": "This is fall promotion.Get 10% off on Product &#39;Alpine Energy Drink Chai Post 0.5L PET - 6 pack."
65   }
66}
Properties
Name Type Description Required or Optional Available Version
active Boolean Indicates whether the promotion is active (true) or not (false). Optional 62.0
areQualItemsExcl​FromDiscounts Boolean Indicates whether qualifying items are excluded from discounts for the promotion (true) or not (false). Optional 62.0
currencyIsoCode String Three-letter ISO 4217 currency code associated with the promotion. Optional 62.0
description String Localized display name of the promotion. Optional 62.0
discountOrder String Discount order for the promotion. Possible values are:
  • LeastExpensive
  • MostExpensive
 Optional 62.0
discount​Restriction String Discount restriction for the promotion. Possible values are:
  • LeastExpensive
  • None
 Optional 62.0
displayName Promotion Translation Input Promotion display name and translated values. Optional 62.0
endDateTime String The date time the promotion ends. Optional 62.0
exclusivityType String Type of exclusivity to be considered when applying the promotion. Possible values are:
  • Class—Class exclusion.
  • Global—Global exclusion.
  • No—No exclusion.
 Optional 62.0
generationId String ID of the generated promotion. This field is used to display the feedback component and collect promotion feedback when Smart Promotion is enabled. Optional 62.0
maximumUsage​Count Integer Number of times a promotion can apply to a cart. Optional 62.0
name String Name of the promotion. Required 62.0
objective String Objective for promotion. Optional 62.0
priorityNumber Integer Priority number for the promotion. Optional 62.0
qualifierCriteria String Qualifier criteria for the promotion. Possible values are:
  • All—All the criteria are met.
  • Any—Any of the criteria can be met.
 Optional 62.0
qualifiers Promotion Qualifier Input[] List of promotion qualifiers. Optional 62.0
segments Promotion Segment Input[] List of promotion segments associated with the web store or buyer group. Required 62.0
startDateTime String The date time the promotion starts. Optional 62.0
targetCriteria String Promotion criteria type. Possible values are:
  • All—All the criteria are met.
  • Any—Any of the criteria can be met.
 Optional 62.0
targets Promotion Target Input[] List of promotion targets. Required 62.0
termsAnd​Condition Promotion Translation Input Promotion terms and conditions and translated values. Optional 62.0
tiered Boolean Indicates whether promotion is tiered (true) or not (false).

If it is a tiered promotion, each tier can have its own set of targets and qualifiers. For example, buy 1 "t-shirt" and get 10% off or buy 2 "t-shirts” and get 20% off.

 Optional 62.0