Async Action Object

Data model description

AttributesDescriptionExample
id

Async action unique ID.

aa_0adad13d6f057f088e

type

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

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

Available values: ENQUEUED, IN_PROGRESS, DONE, FAILED
resultAny of:

CAMPAIGN.VOUCHERS_IMPORT

AttributesDescriptionExample
message

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

failed

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

Array of:
AttributesDescriptionExample
code

Unique voucher code.

reason

Detailed failure cause for the voucher code import.

done_count

Number of resources processed successfully.

failed_count

Number of resources failed to process.

CAMPAIGN.VOUCHERS_IMPORT_CSV

AttributesDescriptionExample
message

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

failed

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

Array of:
AttributesDescriptionExample
code

Unique voucher code.

row

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

reason

Detailed failure cause for the voucher code import.

done_count

Number of resources processed successfully.

failed_count

Number of resources failed to process.

CAMPAIGN.VOUCHERS_UPDATE

AttributesDescriptionExample
message

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

done_count

Number of resources processed successfully.

CAMPAIGN.VOUCHERS_DELETE

AttributesDescriptionExample
message

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

done_count

Number of resources processed successfully.

CAMPAIGN.VOUCHERS_GENERATE

AttributesDescriptionExample
message

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

done_count

Number of resources processed successfully.

CAMPAIGNS.METADATA_KEY_PURGE

AttributesDescriptionExample
message

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

done_count

Number of resources processed successfully.

CUSTOMERS.IMPORT_CSV

AttributesDescriptionExample
message

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

failed

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

Array of:
AttributesDescriptionExample
source_id

Unique customer ID from your inventory system as indicated in the CSV file.

row

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

reason

Detailed failure cause for the customer import.

done_count

Number of resources processed successfully.

failed_count

Number of resources failed to process.

CUSTOMERS.BULK_UPDATE

AttributesDescriptionExample
results

An array of statuses for each record.

Array of:
AttributesDescriptionExample
source_id

Unique customer source_id.

updated

Indicates whether the record was updated.

found

Indicates whether the record was found.

done_count

Number or resources processed successfully.

CUSTOMERS.METADATA_UPDATE

AttributesDescriptionExample
results

An array of statuses for each record.

Array of:
AttributesDescriptionExample
source_id

Unique customer source_id.

updated

Indicates whether the record was updated.

found

Indicates whether the record was found.

done_count

Number of resources processed successfully.

CUSTOMERS.METADATA_KEY_PURGE

AttributesDescriptionExample
message

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

done_count

Number of resources processed successfully.

PRODUCTS.BULK_UPDATE

AttributesDescriptionExample
results

An array of statuses for each record.

Array of:
AttributesDescriptionExample
source_id

Unique product source_id.

updated

Indicates whether the record was updated.

found

Indicates whether the record was found.

done_count

Number of resources processed successfully.

PRODUCTS.METADATA_UPDATE

AttributesDescriptionExample
results

An array of statuses for each record.

Array of:
AttributesDescriptionExample
source_id

Unique product source_id.

updated

Indicates whether the record was updated.

found

Indicates whether the record was found.

done_count

Number of resources processed successfully.

PRODUCTS.IMPORT_CSV

AttributesDescriptionExample
message

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

failed

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

Array of:
AttributesDescriptionExample
row

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

reason

Detailed failure cause for the product import.

done_count

Number of resources processed successfully.

failed_count

Number of resources failed to process.

SKUS.IMPORT_CSV

AttributesDescriptionExample
message

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

2 sku(s) imported successfully, 6 failed.

failed

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

Array of:
AttributesDescriptionExample
row

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

2

reason

Detailed failure cause for the SKU import.

Resource sku with id size-small is in use by products with ids [prod_0b0e3441c2462eff2c]

done_count

Number of resources processed successfully.

failed_count

Number of resources failed to process.

PRODUCTS.METADATA_KEY_PURGE

AttributesDescriptionExample
message

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

done_count

Number of resources updated successfully.

VOUCHERS.IMPORT

AttributesDescriptionExample
message

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

failed

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

AttributesDescriptionExample
code

Unique voucher code.

reason

Detailed failure cause for the voucher code import.

done_count

Number of resources processed successfully.

failed_count

Number of resources failed to process.

VOUCHERS.IMPORT_CSV

AttributesDescriptionExample
message

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

failed

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

Array of:
AttributesDescriptionExample
code

Unique voucher code.

row

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

reason

Detailed failure cause for the voucher code import.

done_count

Number of resources processed successfully.

failed_count

Number of resources failed to process.

VOUCHERS.BULK_UPDATE

AttributesDescriptionExample
results

An array of statuses for each record.

Array of:
AttributesDescriptionExample
code

Unique voucher code.

updated

Indicates whether the record was updated.

found

Indicates whether the record was found.

done_count

Number of resources processed successfully.

VOUCHERS.METADATA_UPDATE

AttributesDescriptionExample
results

An array of statuses for each record.

Array of:
AttributesDescriptionExample
code

Unique voucher code.

updated

Indicates whether the record was updated.

found

Indicates whether the record was found.

done_count

Number of resources processed successfully.

VOUCHERS.METADATA_KEY_PURGE

AttributesDescriptionExample
message

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

done_count

Number of resources processed successfully.

ORDERS.IMPORT

AttributesDescriptionExample
message

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

failed

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

AttributesDescriptionExample
source_id

Unique order source ID.

reason

Detailed failure cause for the voucher code import.

done_count

Number of resources processed successfully.

failed_count

Number of resources failed to process.

ORDERS.METADATA_KEY_PURGE

AttributesDescriptionExample
message

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

done_count

Number of resources processed successfully.

created_at

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

2022-06-23T11:21:45.578Z

updated_at

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

2022-06-23T11:21:46.795Z

request_id

Unique request ID.

v-0b45cee140c3c9b5ca

processing_time

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

1217

progress

% progress to completion of the asynchronous action.

object

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

Language
URL
Click Try It! to start a request and see the response here!