Jump to

• Request
• Response

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: string

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getCouponBatch_response

Type: object

Show Source

• 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.

{
    "properties":{
        "maxUses":{
            "description":"The number of uses each coupon in the batch has.",
            "type":"integer"
        },
        "promotions":{
            "description":"List of promotions associated with the coupon batch.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The promotion's repository ID",
                        "type":"string"
                    }
                }
            }
        },
        "prefix":{
            "description":"The prefix code for the coupon batch.",
            "type":"string"
        },
        "numberClaimed":{
            "description":"The number of coupons that have been claimed.",
            "type":"integer"
        },
        "numberOfCoupons":{
            "description":"The number of coupons in the batch.",
            "type":"integer"
        },
        "repositoryId":{
            "description":"See 'id'",
            "type":"string"
        },
        "uses":{
            "description":"The uses count.",
            "type":"integer"
        },
        "id":{
            "description":"ID of the coupon batch.",
            "type":"string"
        },
        "startDate":{
            "description":"When this coupon batch becomes active.",
            "type":"string"
        }
    }
}

Nested Schema : promotions

Type: array

List of promotions associated with the coupon batch.

Show Source

• Array of: object items

{
    "description":"List of promotions associated with the coupon batch.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The promotion's repository ID",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId(optional): string
  The promotion's repository ID

{
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"The promotion's repository ID",
            "type":"string"
        }
    }
}

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

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top