RCG B2C Commerce System API - Implementation Template

(0 reviews)


Each Accelerator implementation template in Exchange includes Bash and Windows scripts for building and deploying the APIs to CloudHub. These scripts depend on repositories, global settings, deployment profiles, and associated properties configured in the Maven settings.xml file.

Many templates can also be run from Anypoint Studio without having to customize the Run/Debug profiles. However, some templates make use of hidden deployment properties to protect sensitive information (e.g., passwords and secret keys). These properties must be supplied to the runtime by updating the configuration profile and adding them as VM arguments.


Ensure the Maven profile CloudHub-RCG-DEV has been properly configured in your settings.xml file. In particular, make sure the common properties for your environment have been provided (e.g., Anypoint Platform client ID and secret).

Required property overrides

At a minimum, the following properties must be customized for this application to reflect the target deployment environment.

Property NameDescription
api.autodiscoveryIDRequired if using API Manager to secure this API
headless-cc-orders-update-data-api.hostHeadless cc API instance hostname
headless-cc-orders-update-data-api.portHeadless cc API instance port
headless-cc-orders-update-data-api.shortCodeHeadless cc API instance shortCode
headless-cc-orders-update-data-api.siteIdHeadless cc API instance siteId of the referring site
headless-cc-orders-update-data-api.versionHeadless cc API instance version
headless-cc-orders-update-data-api.organizationIdHeadless cc API instance organizationId
headless-cc-orders-update-data-api.base-pathHeadless cc API instance base path
headless-cc-orders-update-data-api.scopeHeadless cc API instance scope value
ocapi-data-api.hostHeadless OCAPI instance hostname
ocapi-data-api.portHeadless OCAPI instance port
ocapi-data-api.base-pathHeadless OCAPI instance base path
ocapi-data-api.base-path-batchHeadless OCAPI instance base path for batch operations

Running the application from Anypoint Studio

The following instructions are for running applications from Studio but apply to debugging as well.

  1. Update the src/main/resources/config/config-local.yaml file and provide values for the properties described above.
  2. Right-click the project and select Run As -> Mule Application (configure)
  3. If hidden deployment properties (e.g., Anypoint MQ credentials) are required, select the Arguments tab and add the property definitions to the VM arguments section. For example:
     -M-Danypoint-mq.client-id=<client id> -M-Danypoint-mq.client-secret=<client secret>
  4. Click Run to launch the application.

To debug an application, choose Debug As -> Mule Application (configure) in the second step instead.

Deployment instructions for CloudHub

The following instructions apply to CloudHub deployments only.

  1. Update the config-dev.yaml properties as described above. You can also choose to add them to your settings.xml file instead.
  2. Use one of the following scripts to deploy application to CloudHub:
    • packageDeploy.sh (Mac/Linux) or packageDeploy.cmd (Windows) - clean, build, and deploy the application
    • deployOnly.sh (Mac/Linux) or deployOnly.cmd (Windows) - deploy a previously-built application
  3. Bring up the Runtime Manager console in Anypoint and monitor the application for proper startup.

Next steps

Visit the Data mappings tab to learn more about how the request and response data structures are mapped between the API interface and B2C commerce cloud.


Published by
MuleSoft Solutions
Published onMar 8, 2024
Asset overview

Asset versions for 3.0.x

Asset versions