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.

Imports can be managed via API or using the related back-office app in the Apps section of the admin dashboard.

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.

Even if still returned by the API, cleanup_records and destroyed_count attributes are deprecated. If you need to remove some resources and their associated relationships in batches we strongly recommend using cleanups.

Some automations normally triggered on resources' creation or update (e.g. webhooks, callbacks, and most event-driven communications) might not be enabled when using imports. Read here for more information.


Check the related guide for the complete list of importable resources and any further information about the import process (e.g. import limits, unique keys, parent resources, and examples).

Last updated