The export object and the allowed CRUD operations on the related resource endpoint

Exports let you asynchronously export SKUs, prices, stock items, and many other resources from your organization's environment. At the moment, two types of format are available when exporting resources: JSON (default) and CSV.

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

For each resource, you can specify the relationships you want to add to the export (among the supported ones) as includes. You can also apply some filters to fine-tune the exported data, and decide to skip redundant attributes excluding them from your export by setting the dry_data attribute to true (default is false).

Exported outputs can be used as inputs for the imports API.

As soon as an export is created you can check the number of items that are going to be exported by inspecting the records_count attribute. You can poll the status attribute to check the export progress until it's completed. Then, you can download the exported data using the link exposed in the attachment_url attribute.


Check the related guide for the complete list of exportable resources and any further information about the export process (e.g. export limits, supported associations, filters, and examples).

Last updated