Salesforce · JSON Structure
Salesforce Promotions Creation Request Structure
Type: object
Properties: 11
Required: 11
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales
PromotionsCreationRequest is a JSON Structure definition published by Salesforce, describing 11 properties, of which 11 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.
Properties
name
startDateTime
displayName
priorityNumber
description
endDateTime
objective
loyaltyProgram
additionalFieldValues
promotionLimits
promotionEligibility
Meta-schema: https://json-structure.org/draft/2020-12/schema
JSON Structure
{
"type": "object",
"name": "PromotionsCreationRequest",
"properties": {
"name": {
"type": "string"
},
"startDateTime": {
"type": "string"
},
"displayName": {
"type": "string"
},
"priorityNumber": {
"type": "integer"
},
"description": {
"type": "string"
},
"endDateTime": {
"type": "string"
},
"objective": {
"type": "string"
},
"loyaltyProgram": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
},
"additionalFieldValues": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"properties": {
"promotionLocation__c": {
"type": "string"
}
},
"required": [
"promotionLocation__c"
]
}
},
"required": [
"attributes"
]
},
"promotionLimits": {
"type": "object",
"properties": {
"perLineItemLimit": {
"type": "integer"
},
"vouchersLimit": {
"type": "integer"
},
"vouchersPerCustomerLimit": {
"type": "integer"
},
"perCartLimit": {
"type": "integer"
},
"usePerCustomerLimit": {
"type": "integer"
},
"liabilityLimit": {
"type": "integer"
},
"loyaltyProgramCurrency": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
"pointsPerCustomerLimit": {
"type": "integer"
}
},
"required": [
"perLineItemLimit",
"vouchersLimit",
"vouchersPerCustomerLimit",
"perCartLimit",
"usePerCustomerLimit",
"liabilityLimit",
"loyaltyProgramCurrency",
"pointsPerCustomerLimit"
]
},
"promotionEligibility": {
"type": "object",
"properties": {
"eligibleProductCategories": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"eligibleProducts": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
},
"eligibleChannels": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"channelType": {
"type": "string"
},
"store": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
},
"retailLocationGroup": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
},
"required": [
"channelType",
"store",
"retailLocationGroup"
]
}
},
"eligibleCustomerEvents": {
"type": "object",
"properties": {
"event": {
"type": "string"
},
"eventPeriodUnit": {
"type": "string"
}
},
"required": [
"event",
"eventPeriodUnit"
]
},
"eligibleEnrollmentPeriod": {
"type": "object",
"properties": {
"isEnrollmentRequired": {
"type": "boolean"
},
"enrollmentStartDate": {
"type": "string"
},
"enrollmentEndDate": {
"type": "string"
}
},
"required": [
"isEnrollmentRequired",
"enrollmentStartDate",
"enrollmentEndDate"
]
},
"eligibleLoyaltyTiers": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"tierGroup": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"name",
"id"
]
},
"tier": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"name",
"id"
]
}
},
"required": [
"tierGroup",
"tier"
]
}
}
},
"required": [
"eligibleProductCategories",
"eligibleProducts",
"eligibleChannels",
"eligibleCustomerEvents",
"eligibleEnrollmentPeriod",
"eligibleLoyaltyTiers"
]
}
},
"required": [
"name",
"startDateTime",
"displayName",
"priorityNumber",
"description",
"endDateTime",
"objective",
"loyaltyProgram",
"additionalFieldValues",
"promotionLimits",
"promotionEligibility"
],
"$schema": "https://json-structure.org/draft/2020-12/schema"
}