This is the early access documentation preview for Custom Views. This documentation might not be in sync with our official 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 host Region of a commercetools Composable Commerce Project. For more information, see Hosts.

europe-west1.gcp
us-central1.gcp
australia-southeast1.gcp

ProjectIdentifier

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

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

IntegrationType

The type of integration provided by a Connector.

tax
marketplace
oms
psp
pim
promotion
search
erp
crm
email
analytics
shipping
other