getCouponBatch
get
/ccadmin/v1/couponBatches/{id}
Get Coupon Batch. Provides details of a single coupon batch.
Request
Supported Media Types
- application/json
Path Parameters
Query Parameters
-
claimableStatus(optional): string
Accepted values: used / claimed / all. If no value is provided, default to complete.
-
numberClaimedPreview(optional): string
Boolean: true / false. True derives number claimed value from preview (non production). If no value is provided, default to production number claimed value (false).
-
promotionId(optional): string
ID corresponding to the promotion the coupon batch applies to.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getCouponBatch_response
Type:
Show Source
object
-
id(optional):
string
ID of the coupon batch.
-
maxUses(optional):
integer
The number of uses each coupon in the batch has.
-
numberClaimed(optional):
integer
The number of coupons that have been claimed.
-
numberOfCoupons(optional):
integer
The number of coupons in the batch.
-
prefix(optional):
string
The prefix code for the coupon batch.
-
promotions(optional):
array promotions
List of promotions associated with the coupon batch.
-
repositoryId(optional):
string
See 'id'
-
startDate(optional):
string
When this coupon batch becomes active.
-
uses(optional):
integer
The uses count.
Nested Schema : promotions
Type:
array
List of promotions associated with the coupon batch.
Show Source
Nested Schema : items
Type:
Show Source
object
-
repositoryId(optional):
string
The promotion's repository ID
Example Response (application/json)
{
"maxUses":"1",
"promotions":[
{
"repositoryId":"promo20011"
},
{
"repositoryId":"promo20009"
}
],
"prefix":"SpecialEvent",
"numberClaimed":"9",
"numberOfCoupons":"11",
"repositoryId":"2c2a9",
"id":"2c2a9",
"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