BETA

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/

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

The Import API is available only in the Google Cloud Regions.

Authorization

The Import API uses tokens and scopes from any of the commercetools HTTP API Authorization flows.

  • manage_project:{projectKey} grants permission to use all Import API endpoints. More selective permissions are sufficient when using individual API endpoints.
  • To create an ImportContainer, an API Client must have at least the manage_import_containers:{projectKey} scope.
  • To view an ImportContainer, an API Client must have at least the view_import_containers:{projectKey} scope.

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 at last the scope required to create a resource of the ImportContainer's resourceType.

    For example if resourceType is category, the API Client must have, at a minimum, the manage_products:{projectKey} scope.

  • To view ImportOperations or ImportSummaries, an API Client must have at least the scope required to view a resource of the ImportContainer's resourceType.

    For example if resourceType is product, the API Client must have at least the view_products:{projectKey} scope.