Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Async Actions

Get Async Action

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 ContextEndpoint
CAMPAIGN
CAMPAIGN.VOUCHERS_IMPORTPOST /campaigns/{campaignId}/import
CAMPAIGN.VOUCHERS_IMPORT_CSVPOST /campaigns/{campaignId}/importCSV
CAMPAIGN.VOUCHERS_UPDATEPUT /campaigns/{campaignId}
CAMPAIGN.VOUCHERS_DELETEDELETE /campaigns/{campaignId}
CAMPAIGN.VOUCHERS_GENERATE<ul><li>POST /campaigns: asynchronous for campaigns with more than 1 voucher, synchronous for campaign with 1 voucher</li><li>POST /campaigns/{campaignId}/vouchers</li></ul>
CUSTOMERS
CUSTOMERS.IMPORT_CSVPOST /customers/importCSV
CUSTOMERS.BULK_UPDATEPOST /customers/bulk/async
CUSTOMERS.METADATA_UPDATEPOST /customers/metadata/async
PRODUCTS
PRODUCTS.BULK_UPDATEPOST /products/bulk/async<br />
PRODUCTS.METADATA_UPDATEPOST /products/metadata/async
PRODUCTS.IMPORT_CSVPOST /products/importCSV
SKUS.IMPORT_CSVPOST /skus/importCSV
VOUCHERS
VOUCHERS.IMPORTPOST /vouchers/import
VOUCHERS.IMPORT_CSVPOST /vouchers/importCSV
VOUCHERS.BULK_UPDATEPOST /vouchers/bulk/async<br />
VOUCHERS.METADATA_UPDATEPOST /vouchers/metadata/async
ORDERS
ORDERS.IMPORTPOST /orders/import
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_PURGENo API endpoint equivalent. You can perform this action through the Dashboard. See Dashboard documentation: Dashboard > Project Settings
get/v1/async-actions/{asyncActionId}

Response

Returns detailed information about the async action result.

idstring

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_atstring date-time

Timestamp representing the date and time when the async action was scheduled in ISO 8601 format.

updated_atstring date-time

Timestamp representing the date and time when the async action was updated. The value is shown in the ISO 8601 format.

request_idstring

Unique request ID.

processing_timeinteger

The length of time it took to process the request in milliseconds.

progressinteger

% 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.

Example response

{
  "id": "aa_0adad13d6f057f088e",
  "created_at": "2022-06-23T11:21:45.578Z",
  "updated_at": "2022-06-23T11:21:46.795Z",
  "request_id": "v-0b45cee140c3c9b5ca",
  "processing_time": 1217,
  "result": {
    "message": "2 sku(s) imported successfully, 6 failed.",
    "failed": [
      {
        "row": 2,
        "reason": "Resource sku with id size-small is in use by products with ids [prod_0b0e3441c2462eff2c]"
      }
    ]
  }
}
All 315 operations