Jump to

• Request
• Response

createPromotionClaimable

post

/ccadmin/v1/claimables

Create Promotion Claimable. Create a new coupon using the given promotion

Request

Supported Media Types

• application/json

Body ()

Root Schema : createPromotionClaimable_request

Type: object

Show Source

• id: string
  The ID of the coupon to create. Also serves as the claim code.
• maxUses(optional): integer
  Specifies the number of uses a coupon has. This is required if 'useMaxUses' is set to true.
• promotionId(optional): string
  ID corresponding to the promotion which the coupon will use. Use either promotionId or promotions, not both.
• promotions(optional): array promotions
  List of promotions with which to associate the coupon. Use either promotionId or promotions, not both.
• startDate(optional): string
  When this claimable becomes active.
• useMaxUses(optional): boolean
  Activates validation of maxUses property.

{
    "properties":{
        "maxUses":{
            "description":"Specifies the number of uses a coupon has.  This is required if 'useMaxUses' is set to true.",
            "type":"integer"
        },
        "promotions":{
            "description":"List of promotions with which to associate the coupon. Use either promotionId or promotions, not both.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The promotion's repository ID",
                        "type":"string"
                    }
                },
                "required":[
                    "repositoryId"
                ]
            }
        },
        "useMaxUses":{
            "description":"Activates validation of maxUses property.",
            "type":"boolean"
        },
        "id":{
            "description":"The ID of the coupon to create. Also serves as the claim code.",
            "type":"string"
        },
        "promotionId":{
            "description":"ID corresponding to the promotion which the coupon will use. Use either promotionId or promotions, not both.",
            "type":"string"
        },
        "startDate":{
            "description":"When this claimable becomes active.",
            "type":"string"
        }
    },
    "required":[
        "id"
    ],
    "example":{
        "maxUses":"50",
        "useMaxUses":true,
        "id":"10OffMyOrder",
        "promotionId":"SamplePromotion",
        "startDate":"2016-03-23T11:56:00.000-04:00"
    }
}

Example:

{
    "maxUses":"50",
    "useMaxUses":true,
    "id":"10OffMyOrder",
    "promotionId":"SamplePromotion",
    "startDate":"2016-03-23T11:56:00.000-04:00"
}

Nested Schema : promotions

Type: array

List of promotions with which to associate the coupon. Use either promotionId or promotions, not both.

Show Source

• Array of: object items

{
    "description":"List of promotions with which to associate the coupon. Use either promotionId or promotions, not both.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "repositoryId":{
                "description":"The promotion's repository ID",
                "type":"string"
            }
        },
        "required":[
            "repositoryId"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• repositoryId: string
  The promotion's repository ID

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createPromotionClaimable_response

Type: object

Show Source

• repositoryId(optional): string
  The Claimable id.

{
    "properties":{
        "repositoryId":{
            "description":"The Claimable id.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "repositoryId":"10OffMyOrder"
}

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| |------------------|------------------| |21131|Create claimable id already exists| |21130|Create claimable promotion not found| |21139|Create claimable internal error|

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