Hosts and Authorization

Hosts

The Import API has different hosts from the HTTP API hosts. The Import API is hosted at the following URLs:

RegionAPI URL
Europe (Google Cloud, Belgium)https://import.europe-west1.gcp.commercetools.com/
North America (Google Cloud, Iowa)https://import.us-central1.gcp.commercetools.com/
Australia (Google Cloud, Sydney)https://import.australia-southeast1.gcp.commercetools.com/
North America (AWS, Ohio)https://import.us-east-2.aws.commercetools.com/
Europe (AWS, Frankfurt)https://import.eu-central-1.aws.commercetools.com/
North America (Azure, Virginia)https://import.eastus.azure.commercetools.com/
Europe (Azure, Frankfurt)https://import.germanywestcentral.azure.commercetools.com/

If documentation refers to https://import.{region}.commercetools.com, the {region} placeholder has to be replaced with the actual value.

Authorization

The Import API uses tokens and scopes from any of the Composable Commerce HTTP API authorization flows with the following scopes:

  • manage_project:{projectKey}: grants permission to use all Import API endpoints. To access individual API endpoints, use more selective permissions.
  • view_import_containers:{projectKey}: grants permission to view Import Containers, Import Operations, and Import Summaries.
  • manage_import_containers:{projectKey}: grants permission to view, create, update, and delete Import Containers.

The required scope for sending requests to an ImportContainer is derived from its resourceType property as follows:

  • To create ImportRequests, an API Client must have the scope required to create a resource of the ImportContainer's resourceType.
    For example, if resourceType is category, the API Client must have the manage_products:{projectKey} scope.

  • To view ImportOperations or ImportSummaries, an API Client must have the scope required to view a resource of the ImportContainer's resourceType.
    For example, if resourceType is product, the API Client must have the view_products:{projectKey} scope.