updatePromotionClaimable
put
/ccadmin/v1/claimables/{id}
Update Promotion Claimable. Update a coupon
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID corresponding to the claimable to update.
Root Schema : updatePromotionClaimable_request
Type:
Show Source
object
-
maxUses(optional):
integer
Specifies the number of uses a coupon has. This is required if 'useMaxUses' is set to true.
-
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.
Example:
{
"maxUses":"50",
"promotions":[
{
"repositoryId":"promo20011"
},
{
"repositoryId":"promo20009"
}
],
"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 : updatePromotionClaimable_response
Type:
Show Source
object
-
id(optional):
string
The ID of the coupon.This is sent if 'useMaxUses' in the request is set to true.
-
maxUses(optional):
integer
Specifies the number of uses a coupon has. This is sent if 'useMaxUses' in the request is set to true.
-
prefix(optional):
string
If the coupon is a batch coupon and if 'useMaxUses' in the request is set to true then prefix for the batch coupon is sent in the reponse.
-
promotions(optional):
array promotions
List of promotions associated with the coupon.
-
repositoryId(optional):
string
The Claimable id.
-
startDate(optional):
string
When this claimable becomes active.
-
uses(optional):
integer
The uses count.
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
The promotion's repository ID
Example Response (application/json)
{
"maxUses":"50",
"promotions":[
{
"repositoryId":"promo20009"
},
{
"repositoryId":"promo20011"
}
],
"repositoryId":"Claimable123",
"uses":"2",
"id":"FREESHIP",
"startDate":"2016-03-23T15:56:00.000Z"
}
Default Response
The error response
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