> ## Documentation Index > Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt > Use this file to discover all available pages before exploring further. # Async Action Object

Async Action

This is an object representing an asynchronous action.

All of:

  1. Async Action Base
  2. Attributes Description

    result

    		 One of:
    1. CAMPAIGN.VOUCHERS\_IMPORT
    2. CAMPAIGN.VOUCHERS\_IMPORT\_CSV
    3. CAMPAIGN.VOUCHERS\_UPDATE
    4. CAMPAIGN.VOUCHERS\_DELETE
    5. CAMPAIGN.VOUCHERS\_GENERATE
    6. CAMPAIGNS.METADATA\_KEY\_PURGE
    7. CUSTOMERS.IMPORT\_CSV
    8. CUSTOMERS.BULK\_UPDATE
    9. CUSTOMERS.METADATA\_UPDATE
    10. CUSTOMERS.METADATA\_KEY\_PURGE
    11. PRODUCTS.BULK\_UPDATE
    12. PRODUCTS.METADATA\_UPDATE
    13. PRODUCTS.IMPORT\_CSV
    14. SKUS.IMPORT\_CSV
    15. PRODUCTS.METADATA\_KEY\_PURGE
    16. VOUCHERS.IMPORT
    17. VOUCHERS.IMPORT\_CSV
    18. VOUCHERS.BULK\_UPDATE
    19. VOUCHERS.METADATA\_UPDATE
    20. VOUCHERS.METADATA\_KEY\_PURGE
    21. ORDERS.IMPORT
    22. ORDERS.METADATA\_KEY\_PURGE

Async Action Base

Attributes Description

id
string

Async action unique ID.

Example: aa\_0adad13d6f057f088e

type
string

Type of async action.

Available values: 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

status
string

Status of the async action. Informs you whether the async action has already been completed.

Available values: DONE, ENQUEUED, FAILED, IN\_PROGRESS

operation\_status
string

Status of async action processing. Informs about the async action status, whether it failed, succeeded, or the status is unknown.

Available values: FAILED, SUCCESS, UNKNOWN

created\_at
string

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

Example: 2022-06-23T11:21:45.578Z

updated\_at
string

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

Example: 2022-06-23T11:21:46.795Z

request\_id
string

Unique request ID.

Example: v-0b45cee140c3c9b5ca

processing\_time
integer

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

Example: 1217

progress
integer

% progress to completion of the asynchronous action.

object
string

The type of the object represented by JSON. This object stores information about the async\_action.

Available values: async\_action

CAMPAIGN.VOUCHERS\_IMPORT

Attributes Description

message
string

A human-readable message providing a short description about the result.

failed
array

If any records failed during the process, this array shows the failure details.

Array of:
Attributes Description

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.

CAMPAIGN.VOUCHERS\_IMPORT\_CSV

Attributes Description

message
string

A human-readable message providing a short description about the result.

failed
array

If any records failed during the process, this array shows the failure details.

Array of:
Attributes Description

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.

CAMPAIGN.VOUCHERS\_UPDATE

Attributes Description

message
string

A human-readable message providing a short description about the result.

done\_count
integer

Number of resources processed successfully.

CAMPAIGN.VOUCHERS\_DELETE

Attributes Description

message
string

A human-readable message providing a short description about the result.

done\_count
integer

Number of resources processed successfully.

CAMPAIGN.VOUCHERS\_GENERATE

Attributes Description

message
string

A human-readable message providing a short description about the result.

done\_count
integer

Number of resources processed successfully.

CAMPAIGNS.METADATA\_KEY\_PURGE

Attributes Description

message
string

A human-readable message providing a short description about the result.

done\_count
integer

Number of resources processed successfully.

CUSTOMERS.IMPORT\_CSV

Attributes Description

message
string

A human-readable message providing a short description about the result.

failed
array

If any records failed during the process, this array shows the failure details.

Array of:
Attributes Description

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.

CUSTOMERS.BULK\_UPDATE

All of:

  1. Async Action Voucher Customer Product Bulk Update Result
  2. Attributes Description

    errors
    array

    List of errors encountered during processing.

    Array of:
    Attributes Description

    message
    string

    A human-readable message providing a short description of the error.

    details
    string

    A human-readable message providing more details about the error.

    key
    string

    Short string describing the kind of error which occurred.

    source\_id
    string

    Source identifier of the customer for which the error occurred.

CUSTOMERS.METADATA\_UPDATE

Attributes Description

errors
array

List of errors encountered during processing.

Array of:
Attributes Description

message
string

A human-readable message providing a short description of the error.

details
string

A human-readable message providing more details about the error.

key
string

Short string describing the kind of error which occurred.

CUSTOMERS.METADATA\_KEY\_PURGE

Attributes Description

message
string

A human-readable message providing a short description about the result.

done\_count
integer

Number of resources processed successfully.

PRODUCTS.BULK\_UPDATE

All of:

  1. Async Action Voucher Customer Product Bulk Update Result
  2. Attributes Description

    errors
    array

    List of errors encountered during processing.

    Array of:
    Attributes Description

    message
    string

    A human-readable message providing a short description of the error.

    details
    string

    A human-readable message providing more details about the error.

    key
    string

    Short string describing the kind of error which occurred.

    source\_id
    string

    Source identifier of the product for which the error occurred.

PRODUCTS.METADATA\_UPDATE

Attributes Description

errors
array

List of errors encountered during processing.

Array of:
Attributes Description

message
string

A human-readable message providing a short description of the error.

details
string

A human-readable message providing more details about the error.

key
string

Short string describing the kind of error which occurred.

PRODUCTS.IMPORT\_CSV

Attributes Description

message
string

A human-readable message providing a short description about the result.

failed
array

If any records failed during the process, this array shows the failure details.

Array of:
Attributes Description

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.

SKUS.IMPORT\_CSV

Attributes Description

message
string

A human-readable message providing a short description about the result.

Example: 2 sku(s) imported successfully, 6 failed.

failed
array

If any records failed during the process, this array shows the failure details.

Array of:
Attributes Description

row
integer

The CSV file row number where the SKU definition is recorded. The row counter excludes the file headers row.

Example: 2

reason
string

Detailed failure cause for the SKU import.

Example: Resource sku with id size-small is in use by products with ids \[prod\_0b0e3441c2462eff2c]

done\_count
integer

Number of resources processed successfully.

failed\_count
integer

Number of resources failed to process.

PRODUCTS.METADATA\_KEY\_PURGE

Attributes Description

message
string

A human-readable message providing a short description about the result.

done\_count
integer

Number of resources updated successfully.

VOUCHERS.IMPORT

Attributes Description

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.

Attributes Description

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.

VOUCHERS.IMPORT\_CSV

Attributes Description

message
string

A human-readable message providing a short description about the result.

failed
array

If any records failed during the process, this array shows the failure details.

Array of:
Attributes Description

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.

VOUCHERS.BULK\_UPDATE

All of:

  1. Async Action Voucher Customer Product Bulk Update Result
  2. Attributes Description

    errors
    array

    List of errors encountered during processing.

    Array of:
    Attributes Description

    message
    string

    A human-readable message providing a short description of the error.

    details
    string

    A human-readable message providing more details about the error.

    key
    string

    Short string describing the kind of error which occurred.

    code
    string

    Code of the voucher for which the error occurred.

VOUCHERS.METADATA\_UPDATE

Attributes Description

errors
array

List of errors encountered during processing.

Array of:
Attributes Description

message
string

A human-readable message providing a short description of the error.

details
string

A human-readable message providing more details about the error.

key
string

Short string describing the kind of error which occurred.

VOUCHERS.METADATA\_KEY\_PURGE

Attributes Description

message
string

A human-readable message providing a short description about the result.

done\_count
integer

Number of resources processed successfully.

ORDERS.IMPORT

Attributes Description

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.

Attributes Description

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.

ORDERS.METADATA\_KEY\_PURGE

Attributes Description

message
string

A human-readable message providing a short description about the result.

done\_count
integer

Number of resources processed successfully.

Async Action Voucher Customer Product Bulk Update Result

Attributes Description

done\_count
integer

Number of items successfully processed.

failed\_count
integer

Number of items that failed to be processed.

reports
array

List of URLs to report files.

reports\_available\_till
string

Timestamp until the reports are available.