Common API Types

Common API Types used within multiple API resources.

References

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"
}

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

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

Example: json

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

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.

Configuration for generating API Client credentials.

scopes

Array of String

List of scopes assigned to the API Client.

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.

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.