BETA

Import Summaries

Representations

ImportSummary

An import summary describes the states of import resources of a given import sink.

It is used to track the overall progress of import resources.

The states summary for this import summary.

total
Int

The total number of import operations received for this import group.

OperationStates

ValidationFailed
Int

The number of import operations that are in the state ValidationFailed.

Unresolved
Int

The number of import operations that are in the state Unresolved.

Resolved
Int

The number of import operations that are in the state Resolved.

WaitForMasterVariant
Int

The number of import operations that are in the state WaitForMasterVariant.

Imported
Int

The number of import operations that are in the state Imported.

Delete
Int

The number of import operations that are in the state Delete.

Deleted
Int

The number of import operations that are in the state Deleted.

Rejected
Int

The number of import operations that are in the state Rejected.

Skipped
Int

The number of import operations that are in the state Skipped.

Endpoints

Get an ImportSummary by Key

Retrieves an import summary for the given import sink.

The import summary is calculated on demand.

GET
https://import.europe-west1.gcp.commercetools.com/{projectKey}/import-summaries/importSinkKey={importSinkKey}
OAuth 2.0 Scopes:
manage_project:{projectKey}, manage_import_sinks:{projectKey}, view_import_sinks:{projectKey}
Path Parameters:
projectKey
String
The commercetools project key.
importSinkKey
String
The key of the import sink.
Response:
Request Example:cURL
curl -X GET https://import.europe-west1.gcp.commercetools.com/{projectKey}/import-summaries/importSinkKey={importSinkKey} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}'