Jump to

• Request
• Response

createPromotionCouponBatch

post

/ccadmin/v1/couponBatches

Create Promotion Coupon Batch. Create a new coupon batch using the given promotion.

Request

Supported Media Types

• application/json

Body ()

Root Schema : createPromotionCouponBatch_request

Type: object

Show Source

• id(optional): string
  Optional parameter to specify the ID of the coupon batch to create.
• maxUses: integer
  The maximum number of times each coupon code can be used.
• numberOfCoupons: integer
  The number of coupon codes to request.
• prefix: string
  The prefix code for the coupon batch.
• promotionId(optional): string
  ID corresponding to the promotion which the coupon batch will use. Use either promotionId or promotions, not both.
• promotions(optional): array promotions
  List of promotions with which to associate the coupon batch. Use either promotionId or promotions, not both.
• startDate(optional): string
  When this coupon batch becomes active.

{
    "properties":{
        "maxUses":{
            "description":"The maximum number of times each coupon code can be used.",
            "type":"integer"
        },
        "promotions":{
            "description":"List of promotions with which to associate the coupon batch. Use either promotionId or promotions, not both.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "repositoryId":{
                        "description":"The promotion's repository ID",
                        "type":"string"
                    }
                },
                "required":[
                    "repositoryId"
                ]
            }
        },
        "prefix":{
            "description":"The prefix code for the coupon batch.",
            "type":"string"
        },
        "numberOfCoupons":{
            "description":"The number of coupon codes to request.",
            "type":"integer"
        },
        "id":{
            "description":"Optional parameter to specify the ID of the coupon batch to create.",
            "type":"string"
        },
        "promotionId":{
            "description":"ID corresponding to the promotion which the coupon batch will use. Use either promotionId or promotions, not both.",
            "type":"string"
        },
        "startDate":{
            "description":"When this coupon batch becomes active.",
            "type":"string"
        }
    },
    "required":[
        "maxUses",
        "prefix",
        "numberOfCoupons"
    ],
    "example":{
        "maxUses":"1",
        "prefix":"SpecialEvent",
        "numberOfCoupons":"5000",
        "promotionId":"PromoFor10PercentOff",
        "startDate":"2016-03-23T11:56:00.000-04:00"
    }
}

Example:

{
    "maxUses":"1",
    "prefix":"SpecialEvent",
    "numberOfCoupons":"5000",
    "promotionId":"PromoFor10PercentOff",
    "startDate":"2016-03-23T11:56:00.000-04:00"
}

Nested Schema : promotions

Type: array

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

Show Source

• Array of: object items

{
    "description":"List of promotions with which to associate the coupon batch. 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 : createPromotionCouponBatch_response

Type: object

Show Source

• repositoryId(optional): string
  The Claimable id.

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

Example Response (application/json)

{
    "repositoryId":"44d23",
    "links":[
        {
            "method":"POST",
            "rel":"self",
            "href":"/couponBatches"
        }
    ]
}

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| |------------------|------------------| |21134|ID value is too long: {0}| |21122|Promotion ID cannot be blank.| |21133|Max uses is missing from the input data.| |21121|Claimable ID {0} is invalid. Claimable IDs may not contain forwardslash or backslash characters.| |21132|Specified property is not permitted for coupon batches: {0}| |21131|ID already exists for coupon batch {0}.| |21153|Prefix has an invalid format. Can only be alphanumeric with no special characters: {0}| |21164|Number of Coupons not in the valid range. It must be in the range: 1, 1006632| |21139|Internal error when creating a batch.| |21130|Promotion {0} could not be found.| |21152|Prefix already exists.| |21163|Coupon batch prefix is too long. Maximum: {0}. Actual: {1}.| |21162|Missing expected property: {0}| |21150|Required property cannot be blank: {0}| |21161|Coupon batch properties cannot be empty or null.| |21160|Coupon batch property does not exist, or value is invalid: {0}, {1}|

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