Poll the status of an Excel/CSV import

Returns the status of an import started with POST /bulk_voucher_codes/excel_import/. Poll this endpoint with the returned cache_key until is_ready is true; the response then carries the import result with the assignment count and the per-row errors. Import results expire one hour after the job finishes.

get

/bulk_voucher_codes/excel_import_status/

Authorizations

AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Query parameters

cache_keystring · uuidRequired

The job key returned when the asynchronous operation was started.

Responses

200

The current status of the import job.

application/json

The status envelope of an asynchronous Excel/CSV import.

cache_keystring · uuidOptional

The job key used to poll the import status.

is_readybooleanOptional

Whether the import has finished.

error_messagestring · nullableOptional

A human-readable error message when the import failed or was not found.

401

Authentication credentials were not provided or are invalid.

application/json

403

The authenticated user does not have administrator privileges.

application/json

404

The cache_key was not provided, or the import was not found or has expired.

application/json

get/bulk_voucher_codes/excel_import_status/

GET /api/remote/1/bulk_voucher_codes/excel_import_status/?cache_key=123e4567-e89b-12d3-a456-426614174000 HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "cache_key": "123e4567-e89b-12d3-a456-426614174000",
  "is_ready": true,
  "result": {
    "assigned_count": 1,
    "errors": [
      {
        "voucher_code": "text",
        "user_email": "text",
        "error": "text"
      }
    ],
    "summary": {
      "total_rows": 1,
      "successful": 1,
      "failed": 1
    }
  },
  "error_message": null
}