---
title: "Get Async Action"
method: GET
path: "/v1/async-actions/{asyncActionId}"
tags: ["Async Actions"]
---

# Get Async Action

`GET /v1/async-actions/{asyncActionId}`

Check the result of a scheduled asynchronous operation.  

The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. 

| **Types by Context** | **Endpoint** |
|:---|:---|
| **CAMPAIGN** |  |
| CAMPAIGN.VOUCHERS_IMPORT | **POST**   [`/campaigns/{campaignId}/import`](/api-reference/campaigns/import-vouchers-to-campaign) |
| CAMPAIGN.VOUCHERS_IMPORT_CSV | **POST**   [`/campaigns/{campaignId}/importCSV`](/api-reference/campaigns/import-vouchers-to-campaign-by-csv) |
| CAMPAIGN.VOUCHERS_UPDATE | **PUT** [`/campaigns/{campaignId}`](/api-reference/campaigns/update-campaign) |
| CAMPAIGN.VOUCHERS_DELETE | **DELETE** [`/campaigns/{campaignId}`](/api-reference/campaigns/delete-campaign) |
| CAMPAIGN.VOUCHERS_GENERATE | <ul><li>**POST** [`/campaigns`](/api-reference/campaigns/create-campaign): asynchronous for campaigns with more than 1 voucher, synchronous for campaign with 1 voucher</li><li>**POST**    [`/campaigns/{campaignId}/vouchers`](/api-reference/campaigns/add-vouchers-to-campaign)</li></ul> |
| **CUSTOMERS** |  |
| CUSTOMERS.IMPORT_CSV | **POST** [`/customers/importCSV`](/api-reference/customers/import-and-update-customers-using-csv) |
| CUSTOMERS.BULK_UPDATE | **POST** [`/customers/bulk/async`](/api-reference/customers/update-customers-in-bulk) |
| CUSTOMERS.METADATA_UPDATE | **POST** [`/customers/metadata/async`](/api-reference/customers/update-customers-metadata-in-bulk) |
| **PRODUCTS** |  |
| PRODUCTS.BULK_UPDATE | **POST** [`/products/bulk/async`](/api-reference/products/update-products-in-bulk)<br /> |
| PRODUCTS.METADATA_UPDATE | **POST** [`/products/metadata/async`](/api-reference/products/update-products-metadata-in-bulk) |
| PRODUCTS.IMPORT_CSV | **POST** [`/products/importCSV`](/api-reference/products/import-products-using-csv) |
| SKUS.IMPORT_CSV | **POST** [`/skus/importCSV`](/api-reference/products/import-skus-using-csv) |
| **VOUCHERS** |  |
| VOUCHERS.IMPORT | **POST** [`/vouchers/import`](/api-reference/vouchers/import-vouchers) |
| VOUCHERS.IMPORT_CSV | **POST** [`/vouchers/importCSV`](/api-reference/vouchers/import-vouchers-using-csv) |
| VOUCHERS.BULK_UPDATE | **POST** [`/vouchers/bulk/async`](/api-reference/vouchers/update-vouchers-in-bulk)<br /> |
| VOUCHERS.METADATA_UPDATE | **POST** [`/vouchers/metadata/async`](/api-reference/vouchers/update-vouchers-metadata-in-bulk) | 
| **ORDERS** |  |
| ORDERS.IMPORT | **POST** [`/orders/import`](/api-reference/orders/import-orders) |
| **METADATA KEY PURGE** |  |
| CAMPAIGNS.METADATA_KEY_PURGE<br />CUSTOMERS.METADATA_KEY_PURGE<br />PRODUCTS.METADATA_KEY_PURGE<br />VOUCHERS.METADATA_KEY_PURGE<br />ORDERS.METADATA_KEY_PURGE | No API endpoint equivalent. You can perform this action through the Dashboard. See Dashboard documentation: Dashboard > [Project Settings](/prepare/metadata#maintenance) |

## Response `200`

Returns detailed information about the async action result.

- AsyncActionGetResponseBody — This is an object representing an asynchronous action.
  - `id` string — Async action unique ID.
  - `type` 'CAMPAIGN.VOUCHERS_IMPORT' | 'CAMPAIGN.VOUCHERS_IMPORT_CSV' | 'CAMPAIGN.VOUCHERS_UPDATE' | 'CAMPAIGN.VOUCHERS_DELETE' | 'CAMPAIGN.VOUCHERS_GENERATE' | 'CAMPAIGNS.METADATA_KEY_PURGE' | 'CUSTOMERS.IMPORT_CSV' | 'CUSTOMERS.BULK_UPDATE' | 'CUSTOMERS.METADATA_UPDATE' | 'CUSTOMERS.METADATA_KEY_PURGE' | 'PRODUCTS.BULK_UPDATE' | 'PRODUCTS.METADATA_UPDATE' | 'PRODUCTS.METADATA_KEY_PURGE' | 'PRODUCTS.IMPORT_CSV' | 'SKUS.IMPORT_CSV' | 'VOUCHERS.IMPORT' | 'VOUCHERS.IMPORT_CSV' | 'VOUCHERS.BULK_UPDATE' | 'VOUCHERS.METADATA_UPDATE' | 'VOUCHERS.METADATA_KEY_PURGE' | 'ORDERS.IMPORT' | 'ORDERS.METADATA_KEY_PURGE' — Type of async action.
  - `status` 'DONE' | 'ENQUEUED' | 'FAILED' | 'IN_PROGRESS' — Status of the async action. Informs you whether the async action has already been completed.
  - `operation_status` 'FAILED' | 'SUCCESS' | 'UNKNOWN' — Status of async action processing. Informs about the async action status, whether it failed, succeeded, or the status is unknown.
  - `created_at` string, date-time — Timestamp representing the date and time when the async action was scheduled in ISO 8601 format.
  - `updated_at` string, date-time — Timestamp representing the date and time when the async action was updated. The value is shown in the ISO 8601 format.
  - `request_id` string — Unique request ID.
  - `processing_time` integer — The length of time it took to process the request in milliseconds.
  - `progress` integer — % progress to completion of the asynchronous action.
  - `object` 'async_action' — The type of the object represented by JSON. This object stores information about the `async_action`.
  - `result` union
    - 17ResObjGetAsyncActionResultCampaignVouchersImport — Result schema for a `CAMPAIGN.VOUCHERS_IMPORT` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `failed` object[] — If any records failed during the process, this array shows the failure details.
        - `code` string — Unique voucher code.
        - `reason` string — Detailed failure cause for the voucher code import.
      - `done_count` integer — Number of resources processed successfully.
      - `failed_count` integer — Number of resources failed to process.
    - 17ResObjGetAsyncActionResultCampaignVouchersImportCsv — Result schema for a `CAMPAIGN.VOUCHERS_IMPORT_CSV` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `failed` object[] — If any records failed during the process, this array shows the failure details.
        - `code` string — Unique voucher code.
        - `row` integer — The CSV file row number where the code definition is recorded. The row counter excludes the file headers row.
        - `reason` string — Detailed failure cause for the voucher code import.
      - `done_count` integer — Number of resources processed successfully.
      - `failed_count` integer — Number of resources failed to process.
    - 17ResObjGetAsyncActionResultCampaignVouchersUpdate — Result schema for a `CAMPAIGN.VOUCHERS_UPDATE` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `done_count` integer — Number of resources processed successfully.
    - 17ResObjGetAsyncActionResultCampaignVouchersDelete — Result schema for a `CAMPAIGN.VOUCHERS_DELETE` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `done_count` integer — Number of resources processed successfully.
    - 17ResObjGetAsyncActionResultCampaignVouchersGenerate — Result schema for a `CAMPAIGN.VOUCHERS_GENERATE` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `done_count` integer — Number of resources processed successfully.
    - 17ResObjGetAsyncActionResultCampaignMetadataKeyPurge — Result schema for a `CAMPAIGNS.METADATA_KEY_PURGE` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `done_count` integer — Number of resources processed successfully.
    - 17ResObjGetAsyncActionResultCustomersImportCsv — Result schema for a `CUSTOMERS.IMPORT_CSV` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `failed` object[] — If any records failed during the process, this array shows the failure details.
        - `source_id` string — Unique customer ID from your inventory system as indicated in the CSV file.
        - `row` integer — The CSV file row number where the customer is recorded. The row counter excludes the file headers row.
        - `reason` string — Detailed failure cause for the customer import.
      - `done_count` integer — Number of resources processed successfully.
      - `failed_count` integer — Number of resources failed to process.
    - AsyncActionResultCustomersBulkUpdateResponseBody — Result schema for a `CUSTOMERS.BULK_UPDATE` async action type.
      - `done_count` integer, required — Number of items successfully processed.
      - `failed_count` integer, required — Number of items that failed to be processed.
      - `reports` string[], required — List of URLs to report files.
      - `reports_available_till` string, date-time, required — Timestamp until the reports are available.
      - `errors` object[], required — List of errors encountered during processing.
        - `message` string, required — A human-readable message providing a short description of the error.
        - `details` string, required — A human-readable message providing more details about the error.
        - `key` string, required — Short string describing the kind of error which occurred.
        - `source_id` string, required — Source identifier of the customer for which the error occurred.
    - AsyncActionResultCustomersMetadataUpdateResponseBody — Result schema for a `CUSTOMERS.METADATA_UPDATE` async action type.
      - `errors` object[], required — List of errors encountered during processing.
        - `message` string, required — A human-readable message providing a short description of the error.
        - `details` string, required — A human-readable message providing more details about the error.
        - `key` string, required — Short string describing the kind of error which occurred.
    - 17ResObjGetAsyncActionResultCustomersMetadataKeyPurge — Result schema for a `CUSTOMERS.METADATA_KEY_PURGE` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `done_count` integer — Number of resources processed successfully.
    - AsyncActionResultProductsBulkUpdateResponseBody — `Result schema for a PRODUCTS.BULK_UPDATE` async action type.
      - `done_count` integer, required — Number of items successfully processed.
      - `failed_count` integer, required — Number of items that failed to be processed.
      - `reports` string[], required — List of URLs to report files.
      - `reports_available_till` string, date-time, required — Timestamp until the reports are available.
      - `errors` object[], required — List of errors encountered during processing.
        - `message` string, required — A human-readable message providing a short description of the error.
        - `details` string, required — A human-readable message providing more details about the error.
        - `key` string, required — Short string describing the kind of error which occurred.
        - `source_id` string, required — Source identifier of the product for which the error occurred.
    - AsyncActionResultProductsMetadataUpdateResponseBody — Result schema for a `PRODUCTS.METADATA_UPDATE` async action type.
      - `errors` object[], required — List of errors encountered during processing.
        - `message` string, required — A human-readable message providing a short description of the error.
        - `details` string, required — A human-readable message providing more details about the error.
        - `key` string, required — Short string describing the kind of error which occurred.
    - AsyncActionResultProductsImportCSV — Result schema for a `PRODUCTS.IMPORT_CSV` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `failed` object[] — If any records failed during the process, this array shows the failure details.
        - `row` integer — The CSV file row number where the product definition is recorded. The row counter excludes the file headers row.
        - `source_id` string — The source identifier of the product that caused the error.
        - `reason` string — Detailed failure cause for the product import.
      - `done_count` integer — Number of resources processed successfully.
      - `failed_count` integer — Number of resources failed to process.
    - 17ResObjGetAsyncActionResultSkusImportCsv — Result schema for a `SKUS.IMPORT_CSV` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `failed` object[] — If any records failed during the process, this array shows the failure details.
        - `row` integer — The CSV file row number where the SKU definition is recorded. The row counter excludes the file headers row.
        - `reason` string — Detailed failure cause for the SKU import.
      - `done_count` integer — Number of resources processed successfully.
      - `failed_count` integer — Number of resources failed to process.
    - 17ResObjGetAsyncActionResultProductsMetadataKeyPurge — Result schema for a `PRODUCTS.METADATA_KEY_PURGE` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `done_count` integer — Number of resources updated successfully.
    - 17ResObjGetAsyncActionResultVouchersImport — Result schema for a `VOUCHERS.IMPORT` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `failed` object — If any records failed during the process, this array shows the failure details.
        - `code` string — Unique voucher code.
        - `reason` string — Detailed failure cause for the voucher code import.
      - `done_count` integer — Number of resources processed successfully.
      - `failed_count` integer — Number of resources failed to process.
    - 17ResObjGetAsyncActionResultVouchersImportCsv — Result schema for a `VOUCHERS.IMPORT_CSV` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `failed` object[] — If any records failed during the process, this array shows the failure details.
        - `code` string — Unique voucher code.
        - `row` integer — The CSV file row number where the code definition is recorded. The row counter excludes the file headers row.
        - `reason` string — Detailed failure cause for the voucher code import.
      - `done_count` integer — Number of resources processed successfully.
      - `failed_count` integer — Number of resources failed to process.
    - AsyncActionResultVouchersBulkUpdateResponseBody — Result schema for a `VOUCHERS.BULK_UPDATE` async action type.
      - `done_count` integer, required — Number of items successfully processed.
      - `failed_count` integer, required — Number of items that failed to be processed.
      - `reports` string[], required — List of URLs to report files.
      - `reports_available_till` string, date-time, required — Timestamp until the reports are available.
      - `errors` object[], required — List of errors encountered during processing.
        - `message` string, required — A human-readable message providing a short description of the error.
        - `details` string, required — A human-readable message providing more details about the error.
        - `key` string, required — Short string describing the kind of error which occurred.
        - `code` string, required — Code of the voucher for which the error occurred.
    - AsyncActionResultVouchersMetadataUpdateResponseBody — Result schema for a `VOUCHERS.METADATA_UPDATE` async action type.
      - `errors` object[], required — List of errors encountered during processing.
        - `message` string, required — A human-readable message providing a short description of the error.
        - `details` string, required — A human-readable message providing more details about the error.
        - `key` string, required — Short string describing the kind of error which occurred.
    - 17ResObjGetAsyncActionResultVouchersMetadataKeyPurge — Result schema for a `VOUCHERS.METADATA_KEY_PURGE` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `done_count` integer — Number of resources processed successfully.
    - 17ResObjGetAsyncActionResultOrdersImport — Result schema for a `ORDERS.IMPORT` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `failed` object — If any records failed during the process, this array shows the failure details.
        - `source_id` string — Unique order source ID.
        - `reason` string — Detailed failure cause for the voucher code import.
      - `done_count` integer — Number of resources processed successfully.
      - `failed_count` integer — Number of resources failed to process.
    - 17ResObjGetAsyncActionResultOrdersMetadataKeyPurge — Result schema for a `ORDERS.METADATA_KEY_PURGE` async action type.
      - `message` string — A human-readable message providing a short description about the result.
      - `done_count` integer — Number of resources processed successfully.

## Other responses

- `404` — Returns an error indicating that the async action with given ID was not found.

---

[API](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions.md) · [All operations](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voucherifyio/voucherify-api-async-actions/revisions/4982266e0494/schema)