REST API for Oracle Commerce Cloud December 2017

getPromotionClaimable

get

/ccadmin/v1/claimables/{id}

Get Promotion Claimable. Provides details of a single promotion claimable.

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 applies to.
useMaxUses: Type: boolean

Returns information about a coupon's maximum uses.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getPromotionClaimable_response

Properties

id: Type: string

The ID of the coupon.This is sent if 'useMaxUses' in the request is set to true.
maxUses: Type: integer

Specifies the number of uses a coupon has. This is sent if 'useMaxUses' in the request is set to true.
prefix: Type: string

If the coupon is a batch coupon and if 'useMaxUses' in the request is set to true then prefix for the batch coupon is sent in the reponse.
promotions: Type: array promotions

Additional Properties Allowed:

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

The Claimable id.
startDate: Type: string

When this claimable becomes active.
useMaxUses: Type: boolean

Activates validation of maxUses property.

Nested Schema : promotions

Type: array

List of promotions associated with the coupon.

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":"50",
    "promotions":[
        {
            "repositoryId":"promo20009"
        },
        {
            "repositoryId":"promo20011"
        }
    ],
    "repositoryId":"Claimable123",
    "uses":"2",
    "id":"FREESHIP",
    "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": "50",
  "promotions": [
    {"repositoryId": "promo20009"},
    {"repositoryId": "promo20011"}
  ],
  "repositoryId": "Claimable123",
  "uses": "2",
  "id": "FREESHIP",
  "startDate": "2016-03-23T15:56:00.000Z"
}