Documentation

Import Summaries

Get the status of an Import Container by the number of resources in each ProcessingState.
Import Summaries can be used to monitor the import progress of an Import Container.
For more detailed monitoring of an Import Container, use Query ImportOperations. To monitor the status of individual resources, use Get ImportOperation.
To receive automatic, real-time status updates, subscribe to Import API Events BETA.

Representations

ImportSummary

Describes the status of an ImportContainer by the number of resources in each ProcessingState. Can be used to monitor the import progress per Import Container.
states​
OperationStates​
The import status of an ImportContainer given by the number of resources in each ProcessingState.
total​
Int​
The total number of ImportOperations received for this Import Summary.
Example: json
{
  "states": {
    "processing": 3,
    "validationFailed": 0,
    "unresolved": 0,
    "waitForMasterVariant": 0,
    "imported": 2,
    "rejected": 0,
    "canceled": 0
  },
  "total": 5
}

OperationStates

The number of resources in each ProcessingState.
processing​
Int​
The number of resources in the processing state.
validationFailed​
Int​
The number of resources in the validationFailed state.
unresolved​
Int​
The number of resources in the unresolved state.
waitForMasterVariant​
Int​
The number of resources in the waitForMasterVariant state.
imported​
Int​
The number of resources in the imported state.
rejected​
Int​
The number of resources in the rejected state.
canceled​
Int​
The number of resources in the canceled state.
Example: json
{
  "processing": 3,
  "validationFailed": 0,
  "unresolved": 0,
  "waitForMasterVariant": 0,
  "imported": 2,
  "rejected": 0,
  "canceled": 0
}

Get ImportSummary

GET
https://import.{region}.commercetools.com/{projectKey}/import-containers/{importContainerKey}/import-summaries
Retrieves an ImportSummary for the given Import Container. An ImportSummary is calculated on demand.
OAuth 2.0 Scopes:
manage_import_containers:{projectKey}view_import_containers:{projectKey}
Path parameters:
region
​
String
​
The Region in which the Project is hosted.
projectKey
​
String
​

The Project key.

importContainerKey
​
String
​

The key of the Import Container.

Response:
200

ImportSummary

asapplication/json
Request Example:cURL
curl --get https://import.{region}.commercetools.com/{projectKey}/import-containers/{importContainerKey}/import-summaries -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
200 Response Example: ImportSummaryjson
{
  "states": {
    "processing": 3,
    "validationFailed": 0,
    "unresolved": 0,
    "waitForMasterVariant": 0,
    "imported": 2,
    "rejected": 0,
    "canceled": 0
  },
  "total": 5
}