Imports are very handy resources that let you asynchronously import SKUs, prices, and stock items into your organization's environment. After creating an import, you can poll the resource until the import is complete to get its reports. Import errors and warnings, if any, are reported through the
warnings_log attributes. When you import a list of resources, you can choose to delete any record that is not included in the list, by setting the
cleanup_records variable to
true. In case, after the import is complete you also get the number of destroyed records through the
An import object is returned as part of the response body of each successful list, retrieve or create API call.
The import unique identifier
The import endpoint URL
The type of resource being imported.
The ID of the parent resource to be associated with imported data.
The import job status. One of 'pending' (default), 'in_progress', 'interrputed', or 'completed'
Time at which the import was started.
Time at which the import was completed.
Time at which the import was interrupted.
Array of objects representing the resources that are being imported.
Indicates the size of the objects to be imported.
Indicates the number of import errors, if any.
Indicates the number of import warnings, if any.
Indicates the number of records that have been destroyed, if any.
Indicates the number of records that have been processed (created or updated).
Contains the import errors, if any.
Contains the import warnings, if any.
Indicates if the import should cleanup records that are not included in the inputs array.
Time at which the resource was created.
Time at which the resource was last updated.
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
Any identifier of the third party system that defines the reference code
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
The resource environment (can be one of