listPromotionCouponBatches

get

/ccadmin/v1/couponBatches

List Promotion Coupon Batches. Lists all coupon batches OR the coupon batches associated with a promotion.

Request

Supported Media Types
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. If promotionID is not specified, it returns list of all coupon batches.
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : listPromotionCouponBatches_response
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : items
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":"44d23",
    "id":"44d23"
}

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| |------------------|------------------| |21123|Error while fetching list of coupon batches.|
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