commercetools GraphQL binding spec

Detailed documentation on the commercetools GraphQL binding component

Component format

To setup commercetools GraphQL binding create a component of type bindings.commercetools. See this guide on how to create and apply a binding configuration.

kind: Component
  name: <NAME>
  type: bindings.commercetools
  version: v1
  - name: region # required.
    value: "region"
  - name: provider # required.
    value: "gcp"
  - name: projectKey # required.
    value: "<project-key>"
  - name: clientID # required.
    value: "*****************"
  - name: clientSecret # required.
    value: "*****************"
  - name: scopes # required.
    value: "<project-scopes>"

Spec metadata fields

Field Required Binding support Details Example
region Y Output The region of the commercetools project "europe-west1"
provider Y Output The cloud provider, either gcp or aws "gcp", "aws"
projectKey Y Output The commercetools project key
clientID Y Output The commercetools client ID for the project
clientSecret Y Output The commercetools client secret for the project
scopes Y Output The commercetools scopes for the project "manage_project:project-key"

For more information see commercetools - Creating an API Client and commercetools - Regions.

Binding support

This component supports output binding with the following operations:

  • create