Poll the status of an Excel export

Returns the status of an export started with GET /bulk_voucher_codes/excel_export/. Poll this endpoint with the returned cache_key until is_ready is true; the response then carries the download url of the generated file. Export results expire one hour after the job finishes.

get

/bulk_voucher_codes/excel_export_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 export job.

application/json

The status envelope of an asynchronous Excel export.

cache_keystring · uuidOptional

The job key used to poll the export status.

is_readybooleanOptional

Whether the export file is ready for download.

urlstring · nullableOptional

The download URL of the generated file, present once is_ready is true.

error_messagestring · nullableOptional

A human-readable error message when the export 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 export was not found or has expired.

application/json

get/bulk_voucher_codes/excel_export_status/

GET /api/remote/1/bulk_voucher_codes/excel_export_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,
  "url": null,
  "error_message": null
}