Async Action Object
Attributes | Description |
---|---|
idstring | Async action unique ID. Example:aa_0adad13d6f057f088e |
typestring | 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 |
statusstring | 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_atstring | Timestamp representing the date and time when the async action was scheduled in ISO 8601 format. Example:2022-06-23T11:21:45.578Z |
updated_atstring | Timestamp representing the date and time when the async action was updated in ISO 8601 format. Example:2022-06-23T11:21:46.795Z |
request_idstring | Unique request ID. Example:v-0b45cee140c3c9b5ca |
processing_timeinteger | The length of time it took to process the request in milliseconds. Example:1217 |
progressinteger | % progress to completion of the asynchronous action. |
objectstring | The type of object represented by JSON. This object stores information about the |
CAMPAIGN.VOUCHERS_IMPORT
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
messagestring | A human-readable message providing a short description about the result. | ||||||
failedarray | If any records failed during the process, this array shows the failure details. Array of:
| ||||||
done_countinteger | Number of resources processed successfully. | ||||||
failed_countinteger | Number of resources failed to process. |
CAMPAIGN.VOUCHERS_IMPORT_CSV
Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
messagestring | A human-readable message providing a short description about the result. | ||||||||
failedarray | If any records failed during the process, this array shows the failure details. Array of:
| ||||||||
done_countinteger | Number of resources processed successfully. | ||||||||
failed_countinteger | Number of resources failed to process. |
CAMPAIGN.VOUCHERS_UPDATE
Attributes | Description |
---|---|
messagestring | A human-readable message providing a short description about the result. |
done_countinteger | Number of resources processed successfully. |
CAMPAIGN.VOUCHERS_DELETE
Attributes | Description |
---|---|
messagestring | A human-readable message providing a short description about the result. |
done_countinteger | Number of resources processed successfully. |
CAMPAIGN.VOUCHERS_GENERATE
Attributes | Description |
---|---|
messagestring | A human-readable message providing a short description about the result. |
done_countinteger | Number of resources processed successfully. |
CAMPAIGNS.METADATA_KEY_PURGE
Attributes | Description |
---|---|
messagestring | A human-readable message providing a short description about the result. |
done_countinteger | Number of resources processed successfully. |
CUSTOMERS.IMPORT_CSV
Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
messagestring | A human-readable message providing a short description about the result. | ||||||||
failedarray | If any records failed during the process, this array shows the failure details. Array of:
| ||||||||
done_countinteger | Number of resources processed successfully. | ||||||||
failed_countinteger | Number of resources failed to process. |
CUSTOMERS.BULK_UPDATE
Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
resultsarray | An array of statuses for each record. Array of:
| ||||||||
done_countinteger | Number or resources processed successfully. |
CUSTOMERS.METADATA_UPDATE
Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
resultsarray | An array of statuses for each record. Array of:
| ||||||||
done_countinteger | Number of resources processed successfully. |
CUSTOMERS.METADATA_KEY_PURGE
Attributes | Description |
---|---|
messagestring | A human-readable message providing a short description about the result. |
done_countinteger | Number of resources processed successfully. |
PRODUCTS.BULK_UPDATE
Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
resultsarray | An array of statuses for each record. Array of:
| ||||||||
done_countinteger | Number of resources processed successfully. |
PRODUCTS.METADATA_UPDATE
Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
resultsarray | An array of statuses for each record. Array of:
| ||||||||
done_countinteger | Number of resources processed successfully. |
PRODUCTS.IMPORT_CSV
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
messagestring | A human-readable message providing a short description about the result. | ||||||
failedarray | If any records failed during the process, this array shows the failure details. Array of:
| ||||||
done_countinteger | Number of resources processed successfully. | ||||||
failed_countinteger | Number of resources failed to process. |
SKUS.IMPORT_CSV
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
messagestring | A human-readable message providing a short description about the result. Example:2 sku(s) imported successfully, 6 failed. | ||||||
failedarray | If any records failed during the process, this array shows the failure details. Array of:
| ||||||
done_countinteger | Number of resources processed successfully. | ||||||
failed_countinteger | Number of resources failed to process. |
PRODUCTS.METADATA_KEY_PURGE
Attributes | Description |
---|---|
messagestring | A human-readable message providing a short description about the result. |
done_countinteger | Number of resources updated successfully. |
VOUCHERS.IMPORT
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
messagestring | A human-readable message providing a short description about the result. | ||||||
failedobject | If any records failed during the process, this array shows the failure details.
| ||||||
done_countinteger | Number of resources processed successfully. | ||||||
failed_countinteger | Number of resources failed to process. |
VOUCHERS.IMPORT_CSV
Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
messagestring | A human-readable message providing a short description about the result. | ||||||||
failedarray | If any records failed during the process, this array shows the failure details. Array of:
| ||||||||
done_countinteger | Number of resources processed successfully. | ||||||||
failed_countinteger | Number of resources failed to process. |
VOUCHERS.BULK_UPDATE
Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
resultsarray | An array of statuses for each record. Array of:
| ||||||||
done_countinteger | Number of resources processed successfully. |
VOUCHERS.METADATA_UPDATE
Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
resultsarray | An array of statuses for each record. Array of:
| ||||||||
done_countinteger | Number of resources processed successfully. |
VOUCHERS.METADATA_KEY_PURGE
Attributes | Description |
---|---|
messagestring | A human-readable message providing a short description about the result. |
done_countinteger | Number of resources processed successfully. |
ORDERS.IMPORT
Attributes | Description | ||||||
---|---|---|---|---|---|---|---|
messagestring | A human-readable message providing a short description about the result. | ||||||
failedobject | If any records failed during the process, this array shows the failure details.
| ||||||
done_countinteger | Number of resources processed successfully. | ||||||
failed_countinteger | Number of resources failed to process. |
ORDERS.METADATA_KEY_PURGE
Attributes | Description |
---|---|
messagestring | A human-readable message providing a short description about the result. |
done_countinteger | Number of resources processed successfully. |