Async Action Object

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 async action. Informs you whether the async action has already been completed. Available values: `ENQUEUED`, `IN_PROGRESS`, `DONE`, `FAILED`
result	One of: 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.IMPORT_CSV, SKUS.IMPORT_CSV, PRODUCTS.METADATA_KEY_PURGE, VOUCHERS.IMPORT, VOUCHERS.IMPORT_CSV, VOUCHERS.BULK_UPDATE, VOUCHERS.METADATA_UPDATE, VOUCHERS.METADATA_KEY_PURGE, ORDERS.IMPORT, ORDERS.METADATA_KEY_PURGE
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 in 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 object represented by JSON. This object stores information about the `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

Attributes Description

results
array

An array of statuses for each record.

Array of:

Attributes	Description
source_id `string`	Unique customer `source_id`.
updated `boolean`	Indicates whether the record was updated.
found `boolean`	Indicates whether the record was found.

done_count
integer

Number or resources processed successfully.

CUSTOMERS.METADATA_UPDATE

Attributes Description

results
array

An array of statuses for each record.

Array of:

Attributes	Description
source_id `string`	Unique customer `source_id`.
updated `boolean`	Indicates whether the record was updated.
found `boolean`	Indicates whether the record was found.

done_count
integer

Number of resources processed successfully.

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

Attributes Description

results
array

An array of statuses for each record.

Array of:

Attributes	Description
source_id `string`	Unique product `source_id`.
updated `boolean`	Indicates whether the record was updated.
found `boolean`	Indicates whether the record was found.

done_count
integer

Number of resources processed successfully.

PRODUCTS.METADATA_UPDATE

Attributes Description

results
array

An array of statuses for each record.

Array of:

Attributes	Description
source_id `string`	Unique product `source_id`.
updated `boolean`	Indicates whether the record was updated.
found `boolean`	Indicates whether the record was found.

done_count
integer

Number of resources processed successfully.

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

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

Attributes Description

results
array

An array of statuses for each record.

Array of:

Attributes	Description
code `string`	Unique voucher code.
updated `boolean`	Indicates whether the record was updated.
found `boolean`	Indicates whether the record was found.

done_count
integer

Number of resources processed successfully.

VOUCHERS.METADATA_UPDATE

Attributes Description

results
array

An array of statuses for each record.

Array of:

Attributes	Description
code `string`	Unique voucher code.
updated `boolean`	Indicates whether the record was updated.
found `boolean`	Indicates whether the record was found.

done_count
integer

Number of resources processed successfully.

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.