createPromotionClaimable
post
/ccadmin/v1/claimables
Create Promotion Claimable. Create a new coupon using the given promotion
Request
Supported Media Types
- application/json
Root Schema : createPromotionClaimable_request
Type:
Show Source
object
-
id:
string
The ID of the coupon to create. Also serves as the claim code.
-
maxUses(optional):
integer
Specifies the number of uses a coupon has. This is required if 'useMaxUses' is set to true.
-
promotionId(optional):
string
ID corresponding to the promotion which the coupon will use. Use either promotionId or promotions, not both.
-
promotions(optional):
array promotions
List of promotions with which to associate the coupon. Use either promotionId or promotions, not both.
-
startDate(optional):
string
When this claimable becomes active.
-
useMaxUses(optional):
boolean
Activates validation of maxUses property.
Example:
{
"maxUses":"50",
"useMaxUses":true,
"id":"10OffMyOrder",
"promotionId":"SamplePromotion",
"startDate":"2016-03-23T11:56:00.000-04:00"
}
Nested Schema : promotions
Type:
array
List of promotions with which to associate the coupon. Use either promotionId or promotions, not both.
Show Source
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : createPromotionClaimable_response
Type:
Show Source
object
-
repositoryId(optional):
string
The Claimable id.
Example Response (application/json)
{
"repositoryId":"10OffMyOrder"
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|21131|Create claimable id already exists|
|21130|Create claimable promotion not found|
|21139|Create claimable internal error|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code