Documentation

Publish your ConnectorStaged

Elevate, May 20-22-2025, Miami Beach, Florida

Learn how to publish a ConnectorStaged and certify a Connector to make it publicly available.

  • After completing this page, you should be able to:

    • Describe the process required to publish a ConnectorStaged.
    • Identify the steps required to certify a Connector to make it publicly available.
    • As we mentioned in the Connector development workflow section, at this point you need to decide if you want to publish your Connector for private or public use. We will explore both options in the following sections. You can also start by publishing the Connector as private and later update to trigger the certification process and have it listed on the Marketplace as a public Connector.

    Step 3a: Create a production-ready Connector

    Now that we have a ConnectorStaged that is known to Connect, we want to use it in our Composable Commerce Project. While we can deploy the ConnectorStaged for private use, in our example it’s now time to generate a Connector from this draft. This is done by updating the ConnectorStaged with the publish action.
    curl https://connect.{region}.commercetools.com/connectors/drafts/key={key} -i \
--header 'Authorization: Bearer ${BEARER_TOKEN}' \
--header 'Content-Type: application/json' \

    With the payload:

    {
  "version": 1,
  "actions": [
    {
      "action": "publish",
      "certification": false
    }
  ]
}
    It might take some time before the ConnectorStaged is published and a Connector is created. You can verify the status by running another GET request on your ConnectorStaged and check the ConnectorStatus. To get a more detailed report on the status and related messages, inspect the publishingReport field from the response.

    Once a ConnectorStaged is published, it becomes a Connector which is read-only and can be deployed to your production projects to integrate the functionality implemented in the Connector applications.

    Request the previewable status

    If you wish to be able to deploy a ConnectorStaged for testing and preview, instead of a published Connector (for instance in test/dev projects), you must update it the ConnectorStaged with the updatePreviewable update action and wait for the isPreviewable field to be set to true. See our documentation for more information about this.

    {
  "version": 3,
  "actions": [
    {
      "action": "updatePreviewable"
    }
  ]
}
    The ConnectorStaged will go through the validation process before the isPreviewable field is updated to true. As before, the above step can also be done from the Merchant Center by clicking the Request preview button when on the Connector page.

    You are now only one step away from using your Connector in your Project! Before we use the Connector, let’s have a short look at our certification process.

    Step 3b: Have your Connector Certified

    If you do not intend to make your Connector publicly available, you can skip the hands-on part of this section.

    There may be times when you want to make your Connector available for others to use. This means you need to have it certified and listed on the commercetools Marketplace. Until it is certified, a Connector remains private and can only be deployed for use in the private projects listed in its definition (as mentioned above).

    Certification is required for all public Connectors. It’s a semi-automated process that ensures that your Connect applications are:

    • Functionally complete.
    • Stable and secure.
    • Compatible with deployment requirements.
    • Fully documented.
    You can start the certification process when you update your ConnectorStaged with the publish update action and set certification to true. You can also perform the same action in the Merchant Center by selecting List on Marketplace when publishing the Connector, or later on from the Connector page.
    {
  "version": 1,
  "actions": [
    {
      "action": "publish",
      "certification": true
    }
  ]
}
    Visit the Connect certification process documentation to learn more about it.

    If you need to make any updates or fix bugs, you must get your Connector re-certified by first updating the repository, generating a new Github tag and then republishing the ConnectorStaged.

    Test your knowledge