To best utilize the Import API, we recommend some best practices while implementing the Import API.
Using Import Containers effectively
Organizing Import Containers
It is entirely up to you how to organize your Import Containers.
A general recommendation is to use more Import Containers that contain less data (over more data in fewer containers). But, it may differ based on your use case and organization/monitoring needs:
- When importing full data sets, creating a new dedicated Import Container for the task can help in distinguishing imports performed on different occasions.
- When performing routine data imports, reusing a dedicated Import Container may be better.
- When importing data from multiple sources, using an Import Container for each source can help in organizing and monitoring progress.
In these three use cases, Import Containers would be organized by resource type, reusing a container for recurring import activities, or by data source.
|Possible Import Container organization
|Import Product and Category
|Create separate containers for Product and Category
|Import Price changes daily at 5 PM
|Create a reusable container. If there are more than 200 000 imports per day, this may be broken down by some other business logic or temporary container for excess counts.
|Import Product changes from multiple sources
|Create one container per source for Product imports.
|Import Operation total count
|Import Containers (Import Operation count)
|container-a (100 000)
|container-a (100 000), container-b (200 000), container-c (200 000)
|container-a (0), container-b (200 000), container-c (200 000)
|container-a (200 000), container-b (0), container-c (0)
On Day 3, container-a will be empty as all the Import Operations have reached 48 hours. container-a is now ready to be reused. Similarly container-b and container-c can be reused from Day 4.
You can have any number of Import Containers.
Import Operations and Import Requests per Import Container have no limits, but we recommend breaking down containers per 200 000 Import Operations, especially if you would be querying these containers.
To achieve the best performance with the Import API, it is recommended to use fewer than 200 000 Import Operations per Import Container.
Cleaning up data from Import Containers and removing unused Import Containers
You can delete Import Containers at your own convenience. This will immediately delete all Import Operations in the container. However, data that has been imported to your Project will not be affected.
How to send Import Requests to Import Containers?
The batch size is limited to 20 per Import Request. If you have a huge number of resources to import, we recommend using thread optimization to send your data as fast as possible to an Import Container.
Which Product import endpoint should be used?
The Import API has multiple endpoints for importing Product data. The following table summarizes what can be imported by each endpoint.
|What can be imported
|Product data including Product Variants and Prices.
|Product data without Product Variants and Prices.
|Product Variant data without Prices.
|Product Variant Attribute data.
|Price data for a specific Product Variant.
The following information explains common use cases for each endpoint.
Use ProductDraftImport for large payloads that include complete sets of Product data including Product Variants and Embedded Prices. Effective use of this endpoint can remove the need to call three separate endpoints (Products, Product Variants, and Embedded Prices).
Common use cases:
- when you want to update a Product with 10+ new Product Variants, each with 20+ Embedded Prices.
- when you want to update a large number of Product Variants with new Attribute values and Prices.
Use ProductImport to create or update Products without Product Variant or Price data. As ProductImport does not import any ProductVariant or Price data, it will result in better performance due to the smaller payload.
Use ProductVariantImport to create or update Product Variants without Price data.
Use ProductVariantPatchImport to update the Attributes of existing Product Variants.
Use EmbeddedPriceImport to update the Price data of existing Product Variants.
How to effectively monitor the import progress?
Two of our monitoring endpoints, Import Summary and Query Import Operations, are container-based. Call the Import Summary endpoint for a quick summary and (later) the Query Import Operations to fetch details.
- Import Summary can be used to get an aggregated progress summary, which gives you the information if you have any errors,
- Query Import Operations can be used with filters like states to query specific situations. For example, query to fetch all the errors to fix those, or to fetch the unresolved to resolve those.
- You can use debug mode to fetch the unresolved references if there is something in the
unresolvedstates. This way, you know which references to resolve.
How to best utilize the 48 hours lifetime of import operations?
Import Operations are kept for 48 hours to allow you to send other referenced data (unresolved references) during this time period.
For example, one of your teams is responsible for Product import but the business validation usually delays the Product import for 1-2 days, and another team that imports Prices is very fast in importing the data, the Import API keeps the Price data for up of 48 hours and waits for the Product to be imported.
What is a very large size import? Limitations of Import API?
- You can import as much data you need using the Import API, keeping the best practices on Rate Limit and payload size per request in mind. For more information on optimization, see optimizing performance.
- Check the API limits to ensure that your import requests do not exceed the resource limitations of your Project.
Currently, there are no rate limits. However, to ensure the best performance, we recommend that you send 300 API calls per second, per Project, to the Import API.
- To ensure the best performance, send 300 API calls per second per Project to the Import API. For example, if you send 300 Import Category requests per second, and each CategoryImportRequest contains 20 CategoryImport items, this means that 360 000 Categories can be sent to the Import API for processing every minute.
What is the recommendation on retries?
You only need to retry if your Import Operation has the
rejected status. In other cases, the Import API will handle the retry internally without you needing to do anything.
What not to do
- Do not send duplicate import requests concurrently. Since the Import API imports data asynchronously, the order is not guaranteed. It may also lead to a concurrent modification error.
- In case of errors, do not query Import Operations or the Import Summary endpoint frequently without fixing the problems as it may slow down the import process. For assistance in debugging issues or errors, query the Import Operation and consult the