This API helps to upload a batch of coupons to a coupon series. It provides the status of the upload process, organization ID, coupon series ID, job status, timestamps for creation and updates, and file information related to the upload.
Prerequisites
Authentication: OAuth authentication details
Access group: Write access to coupon group resource
Unique ID of the coupon series for which you need to upload coupons.
Body parameter
Parameter
Description
file*
Name of the CSV file containing customer and coupon details. There is no limit to the number of coupon codes—including externally managed coupons—that you can add in a file, but it is recommended to keep each batch to a maximum of 500,000 entries.
customerIdentifier*
Customer identifier type used in the CSV file. Use NOT_TAGGED as the identifier to upload only coupon codes.
customerIdentifierColumn
Column ID of the customer identifier in the uploaded CSV file.
Header Required
Header
Description
Content-Type*
multipart/form-data
x-cap-api-oauth-token*
Generated authentication token
Response parameter
Parameter
Data Type
Description
success
Boolean
Indicates whether the API call was successful.
status
Integer
HTTP status code of the API response.
result
Object
Contains the result data of the API call.
result.orgId
Integer
Organization ID associated with the result.
result.couponSeriesId
Integer
ID of the coupon series.
result.uploadJobStatuses
Array of Objects
List of upload job statuses related to the coupon series.
result.uploadJobStatuses.jobId
Integer
Job ID of the upload status.
result.uploadJobStatuses.uploadStatus
String
Status of the upload (e.g., STARTED).
result.uploadJobStatuses.createdOn
String
Timestamp when the upload job was created.
result.uploadJobStatuses.updatedOn
String
Timestamp when the upload job was last updated.
result.uploadJobStatuses.errorFileUrl
String or null
URL for the error file if any errors occurred during upload.
result.uploadJobStatuses.successFileUrl
String or null
URL for the success file if the upload was successful.
