getCouponBatch

get

/ccadmin/v1/couponBatches/{id}

Get Coupon Batch. Provides details of a single coupon batch.

Request

Supported Media Types
Path Parameters
Query Parameters
  • Accepted values: used / claimed / all. If no value is provided, default to complete.
  • Boolean: true / false. True derives number claimed value from preview (non production). If no value is provided, default to production number claimed value (false).
  • ID corresponding to the promotion the coupon batch applies to.
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getCouponBatch_response
Type: object
Show Source
Nested Schema : promotions
Type: array
List of promotions associated with the coupon batch.
Show Source
Nested Schema : items
Type: object
Show Source
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
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top