Documentation

Common API Types

Common API Types used within multiple API resources.

References

Repository

Details of the GitHub repository that contains the Connect applications.

url​
String​

HTTPS or SSH GitHub URL of the GitHub repository. Private repositories must use an SSH URL.

tag​
String​

Git tag of the release to use.

Example: json
{
  "url": "git@github.com:commercetools/connect-application-kit.git",
  "tag": "0.0.0"
}

Region

The Region of a commercetools Composable Commerce Project or Deployment. For more information, see Hosts.
europe-west1.gcp

Europe (Google Cloud, Belgium)

us-central1.gcp

North America (Google Cloud, Iowa)

australia-southeast1.gcp

Australia (Google Cloud, Sydney)

ProjectIdentifier

Identifies a Composable Commerce Project. Uses the format "{region}:{projectKey}".

Example: json
"europe-west1.gcp:my-project-key"

IntegrationType

Integration type of the Connector.

tax

Tax.

marketplace

Marketplace.

oms

Order management.

psp

Payment service provider.

pim

Product information management.

promotion

Promotions and loyalty.

search

Search.

erp

Enterprise resource planning.

crm

Customer relationship management.

email

Email and marketing.

analytics

Analytics.

shipping

Shipping and delivery.

giftcard

Gift card.

other

The Connector provides a service or functionality that is not covered by the other values.

ConnectorApiClient

Configuration for generating API Client credentials.

scopes​
Array of String​
List of scopes assigned to the API Client.

DeploymentApiClient

API Client credentials used for deployment.

name​
String​

Client ID of the API Client.

scopes​
Array of String​
List of scopes assigned to the API Client.

DeploymentGlobalConfiguration

Global configuration applied to all applications in the deployment.

standardConfiguration​
Array of ConfigurationValue​

List of standard environment variables.

securedConfiguration​
Array of ConfigurationValue​

List of secured environment variables.

DeploymentType

Deployment type of the Connector.

preview
The deployed Connector is the previewable ConnectorStaged.
sandbox
The Connector is deployed in the sandbox environment.
production
The Connector is deployed in the production environment and requires a commercetools Composable Commerce Project that is also marked as in production.