API reference
Search…
⌃K
Links

Imports

The import object and the allowed CRUD operations on the related resource endpoint
Imports let you asynchronously import SKUs, prices, stock items, and many other resources into your organization's environment. At the moment, two types of format are available when importing resources: JSON (default) and CSV.
Each element of the inputs list contains the resource attributes and relationships.
You can use as inputs any output you get from the exports API.
After creating an import, you can poll the status attribute to check the import progress until it's completed. Then, you can download the imported data using the link exposed in the attachment_url attribute. Import errors and warnings (if any) are reported through the errors_count, errors_log, warnings_count, and 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 that case, after the import is complete, you also get the number of destroyed records through the destroyed_count attribute.
How-to