BETA

Import Summaries

An Import Summary describes the status of an Import Container by the number of resources in each Processing State. It can be used to monitor the progress of import per Import Container.

To monitor the status of an Import Container more in detail, use Query ImportOperation. To monitor the status of individual resource, use Get ImportOperation.

Representations

ImportSummary

Describes the status of an ImportContainer by the number of resources in each Processing State. Can be used to monitor the import progress per Import Container.

The import status of an ImportContainer given by the number of resources in each Processing State.

total
Int

The total number of ImportOperations received for this Import Summary.

OperationStates

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.

Get ImportSummary

Retrieves an ImportSummary for the given import container. An ImportSummary is calculated on demand.

GET
https://import.{region}.commercetools.com/{projectKey}/import-containers/{importContainerKey}/import-summaries
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 commercetools Project key.

importContainerKey
String

The key of the import container.

Response:
Request Example:cURL
curl -X GET https://import.{region}.commercetools.com/{projectKey}/import-containers/{importContainerKey}/import-summaries -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'