REST API for Oracle Commerce Cloud December 2017

getCouponBatch

get

/ccadmin/v1/couponBatches/{id}

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

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

Query Parameters

promotionId: Type: 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.

Body

Root Schema : getCouponBatch_response

Properties

id: Type: string

ID of the coupon batch.
maxUses: Type: integer

The number of uses each coupon in the batch has.
numberClaimed: Type: integer

The number of coupons that have been claimed.
numberOfCoupons: Type: integer

The number of coupons in the batch.
prefix: Type: string

The prefix code for the coupon batch.
promotions: Type: array promotions

Additional Properties Allowed:

List of promotions associated with the coupon batch.
repositoryId: Type: string

See 'id'
startDate: Type: string

When this coupon batch becomes active.

Nested Schema : promotions

Type: array

List of promotions associated with the coupon batch.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

The promotion's repository ID

Example 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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: 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

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

{
  "maxUses": "1",
  "promotions": [
    {"repositoryId": "promo20011"},
    {"repositoryId": "promo20009"}
  ],
  "prefix": "SpecialEvent",
  "numberClaimed": "9",
  "numberOfCoupons": "11",
  "repositoryId": "2c2a9",
  "id": "2c2a9",
  "startDate": "2016-03-23T15:56:00.000Z"
}