v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB

Async Actions

List Async Actions

Track asynchronous operations scheduled in your project.

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
CAMPAIGN.VOUCHERS_IMPORT_CSV	POST /campaigns/{campaignId}/importCSV
CAMPAIGN.VOUCHERS_UPDATE	PUT /campaigns/{campaignId}
CAMPAIGN.VOUCHERS_DELETE	DELETE /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_CSV	POST /customers/importCSV
CUSTOMERS.BULK_UPDATE	POST /customers/bulk/async
CUSTOMERS.METADATA_UPDATE	POST /customers/metadata/async
PRODUCTS
PRODUCTS.BULK_UPDATE	POST /products/bulk/async<br />
PRODUCTS.METADATA_UPDATE	POST /products/metadata/async
PRODUCTS.IMPORT_CSV	POST /products/importCSV
SKUS.IMPORT_CSV	POST /skus/importCSV
VOUCHERS
VOUCHERS.IMPORT	POST /vouchers/import
VOUCHERS.IMPORT_CSV	POST /vouchers/importCSV
VOUCHERS.BULK_UPDATE	POST /vouchers/bulk/async<br />
VOUCHERS.METADATA_UPDATE	POST /vouchers/metadata/async
ORDERS
ORDERS.IMPORT	POST /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_PURGE	No API endpoint equivalent. You can perform this action through the Dashboard. See Dashboard documentation: Dashboard > Project Settings

get/v1/async-actions

Query parameters

limitinteger

Limit the number of asynchronous actions that the API returns in the response.

end_datestring date-time

Example:2023-12-22T10:13:06.487Z

Limits results to actions scheduled before the end_date. The date format needs to be consistent with ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16).

Response

Returns a list of all scheduled asynchronous actions and detailed information for each scheduled action. Note that a status DONEdoesn't include the result of the completed action. If you need more information about the result, use the ID of the respective async action to call the Get Async Action endpoint.

object'list'

The type of the object represented by JSON. This object stores information about asynchronous actions.

data_ref'async_actions'

Identifies the name of the JSON property that contains the array of asynchronous actions.

has_moreboolean

As query results are always limited by parameters, the has_more flag indicates if there are more records available. This lets you know if you can run another request to get more records returned in the results.

Example response

{
  "async_actions": [
    {
      "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
    }
  ]
}