API overview
Learn more about the Import API and its advantages.
About the Import API
The Import API uploads data to commercetools Composable Commerce.
Its asynchronous design is suitable to sync a large amount of resources from external systems into your Composable Commerce Project.
The arrows in the diagram indicate the data flow. The data of the Import Resource Types can be imported.
Advantages of the Import API
The Import API provides the following advantages:
Asynchronous
You can send bulk data at once, and your systems can do something else while your data is imported asynchronously.Resource specific
You can separately import specific resources, including Products, Product Variants, and Prices.Automatic dependency handling
The Import API automatically handles data dependencies, such as the parental relations of Categories.API first
Unlike with CLI and UI tools, the Import API provides better opportunities for integration with modern application infrastructure.
Comparing the Import API with other HTTP APIs
You can create and update resources in your Composable Commerce Project using the Import API or other HTTP APIs. The following table explains the main differences between the APIs.
| Functionality | Import API | HTTP APIs |
|---|---|---|
| Upload method | Asynchronous | Synchronous |
| Updating resources | Including the key of an existing resource in your import request will update the resource with the specified values. | Different resource types have their own update actions. You must check what update actions to use and include them in an API call to a specific resource. |
| Dependency handling | The Import API identifies and resolves dependencies between imported resources. | All dependencies must be considered beforehand. Dependent resources must be uploaded in the right order. |
| Order of API calls | The order of API calls does not matter. The Import API waits for missing dependencies. Resources may not be imported in the order they were uploaded. | The order of API calls matters and operations arrive in the order they were imported. |
| Status monitoring | You can actively query the status of the import process. | As this process happens synchronously, responses indicate either success or failure. You cannot query the status of the process. |
How to use the Import API
Use keys as identifiers
The key field is an optional user-defined identifier when using other HTTP APIs, but is required when using the Import API. This is due to the id field not being present on resources until they are created.
If a resource with the specified key exists when importing data, the Import API updates that resource with the imported data. If a resource with the specified key does not exist, the Import API creates a new resource.
ImportRequest
An ImportRequest is the data type that is sent in a request body to create or update resources in a Project.
An ImportRequest may contain maximum of 20 resources to import. ImportRequests are resource-specific.
- CategoryImportRequest BETA
- CustomerImportRequest BETA
- DiscountCodeImportRequest BETA
- EmbeddedPriceImportRequest BETA
- InventoryImportRequest BETA
- OrderImportRequest BETA
- OrderPatchImportRequest BETA
- ProductTypeImportRequest BETA
- ProductImportRequest BETA
- ProductDraftImportRequest BETA
- ProductVariantImportRequest BETA
- ProductVariantPatchRequest BETA
- StandalonePriceImportRequest BETA
- TypeImportRequest BETA
Generalities
An ImportContainer can be thought of as the entry point of data and the place where the data is temporarily stored while the asynchronous import process is carried out.
An import process can be initiated by posting an ImportRequest to one of the resource-specific endpoints for import. In response, an ImportResponse is returned, which is the list of the ID's and validation statuses of the newly created ImportOperations.
Here, an ImportOperation can be said to be a status report of each import resource.
Import API Workflow
The Import API employs the following workflow.
- Create an ImportContainer.
- Next, create an ImportRequest and post it to a resource-specific endpoint for import (for example, Import Categories). This initiates an import process.
- After sending the ImportRequest, the Import API returns an ImportResponse, the list of newly created ImportOperations and their validation statuses.
- During the import process, it is possible to get an aggregated summary (called an ImportSummary) of all the ImportOperations associated with a specific ImportContainer by calling Get ImportSummary.
- The Import API validates the import data structures and updates
stateof ImportOperations. For more information, see Processing State. - If the import is successful,
stateof the ImportOperations becomes"imported". The corresponding resource is now imported into the Project. - Suppose the ImportSummary shows that some ImportOperations ended up in the state
validationFailedorrejected. You can then see the error for each ImportOperation by querying them by the respective state.
How to monitor the import status
Use Get ImportOperation to see the status of each import resource, Query ImportOperations to get the status of all import resources in a specific ImportContainer, or Get ImportSummary to see the number of import resources in each Processing State.