listPromotionClaimables

get

/ccadmin/v1/claimables

List claimables (coupons) for all promotions or a specific promotion. Can show terse or verbose information.

Request

Supported Media Types
Query Parameters
  • ID corresponding to the promotion the coupon applies to. If promotionID is not specified it returns list of all promotion claimables.
  • Returns more verbose information about a coupon, including maximum uses.
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when using the useMaxUses=true flag. Without that, a list of objects containing the claimable IDs would be returned.
Body ()
Root Schema : listPromotionClaimables_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.
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "maxUses":"50",
    "promotions":[
        {
            "repositoryId":"promo20011"
        },
        {
            "repositoryId":"promo20009"
        }
    ],
    "repositoryId":"Claimable123",
    "uses":"2",
    "id":"Claimable123"
}

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| |------------------|------------------| |21133|Error while fetching list of promotion claimables.|
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