Get Uploaded Coupons' Status

This API retrieves the status of a coupon upload job, providing detailed information about the upload process, organization ID, coupon series ID, job status, timestamps for creation and updates, URLs for error and uploaded files, and counts of uploaded, actual, and error rows.


  • Authentication: OAuth authentication details
  • Access group resource: Read access to coupon group resource

Resource information

HTTP methodGET
Pagination supported?NA
Rate limitNA
Batch supportNA

API endpoint example

Query parameter

couponSeriesId*The unique ID of the coupon series to get the status.

Response parameter

successBooleanIndicates whether the request was successful.
statusIntegerHTTP status code.
resultObjectObject containing the result of the request.
result.orgIdIntegerOrganization ID associated with the result.
result.couponSeriesIdIntegerID of the coupon series.
result.uploadJobStatusesArray of ObjectsList of upload job status objects.
result.uploadJobStatuses.jobIdIntegerJob ID for the upload status.
result.uploadJobStatuses.uploadStatusStringStatus of the upload.
result.uploadJobStatuses.createdOnString (Timestamp)Timestamp when the job was created.
result.uploadJobStatuses.updatedOnString (Timestamp)Timestamp when the upload job was last updated.
result.uploadJobStatuses.errorFileUrlStringURL for the error file if any errors occurred during upload.
result.uploadJobStatuses.successFileUrlString or NullURL for the success file if the upload was successful.
result.uploadJobStatuses.uploadedFileUrlStringURL of the uploaded file.
result.uploadJobStatuses.totalUploadedCountIntegerTotal number of uploaded rows.
result.uploadJobStatuses.actualRowCountIntegerActual number of rows in the uploaded file.
result.uploadJobStatuses.errorCountIntegerNumber of errors encountered during upload.
result.uploadJobStatuses.uploadTableNameStringName of the table where uploaded data is stored.
result.uploadJobStatuses.uploadedFileNameStringName of the uploaded file.
result.uploadJobStatuses.audienceGroupIdIntegerAudience group ID associated with the upload job.
result.uploadJobStatuses.audienceGroupVersionIdIntegerVersion ID of the audience group associated with the upload job.
    "success": true,
    "status": 200,
    "result": {
        "orgId": 100458,
        "couponSeriesId": 535521,
        "uploadJobStatuses": [
                "jobId": 220605,
                "uploadStatus": "FINISHED",
                "createdOn": "1716811570000",
                "updatedOn": "1716811574000",
                "errorFileUrl": "error_100458_5355212024_05_27_12_06_14",
                "successFileUrl": null,
                "uploadedFileUrl": "couponbatchupload_1716811569557_535521.csv",
                "totalUploadedCount": 2,
                "actualRowCount": 2,
                "errorCount": 2,
                "uploadTableName": "temp_100458_20240527_120613638",
                "uploadedFileName": "couponbatchupload.csv",
                "audienceGroupId": 0,
                "audienceGroupVersionId": 0
Click Try It! to start a request and see the response here!