getPromotionClaimable
get
/ccadmin/v1/claimables/{id}
Get Promotion Claimable. Provides details of a single promotion claimable.
Request
Supported Media Types
- application/json
Path Parameters
Query Parameters
-
promotionId: string
ID corresponding to the promotion the coupon applies to.
-
useMaxUses: boolean
Returns information about a coupon's maximum uses.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getPromotionClaimable_response
Type:
Show Source
object
-
id:
string
The ID of the coupon.This is sent if 'useMaxUses' in the request is set to true.
-
maxUses:
integer
Specifies the number of uses a coupon has. This is sent if 'useMaxUses' in the request is set to true.
-
prefix:
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:
array promotions
List of promotions associated with the coupon.
-
repositoryId:
string
The Claimable id.
-
startDate:
string
When this claimable becomes active.
-
useMaxUses:
boolean
Activates validation of maxUses property.
-
uses:
integer
The uses count.
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code