Inventory System API | Salesforce B2C Commerce Cloud Implementation
home
This is a service to request information about product availability in SFDC Commerce or create reservation of the products.
GET /availability
This endpoint will trigger flow getAvailabilityFlow which obtains availability of product variants
POST /reservation
This endpoint creates reservation of products
License Agreement
Note that using this template is subject to the conditions of this License Agreement.
Please review the terms of the license before downloading and using this template. In short, you are allowed to use the template for free with Mule ESB Enterprise Edition, CloudHub, or as a trial in Anypoint Studio.
Considerations
To make this Anypoint Template run, there are certain preconditions that must be considered. Failing to do so could lead to unexpected behavior of the template.
APIs security considerations
This API is meant to be deployed to CloudHub and managed using the API Platform Manager.
Run it!
Simple steps to get Retail Locations System API running.
See below.
Running on premise
In this section we detail the way you should run your Anypoint Template on your computer.
Where to Download Anypoint Studio and Mule ESB
First thing to know if you are a newcomer to Mule is where to get the tools.
Importing an Anypoint Template into Studio
Mule Studio offers several ways to import a project into the workspace, for instance:
- Anypoint Studio Project from File System
- Packaged mule application (.jar)
You can find a detailed description on how to do so in this Documentation Page.
Running on Studio
Once you have imported you Anypoint Template into Anypoint Studio you need to follow these steps to run it:
- Locate the properties file
mule-<env>.properties
, in src/main/app/resources - Complete all the properties required as per the examples in the section Properties to be configured
- Once that is done, right click on you Anypoint Template project folder
- Hover you mouse over
"Run as"
- Click on
"Mule Application"
Running on Mule ESB stand alone
Complete all properties in one of the property files, for example in mule.prod.properties and run your app with the corresponding environment variable to use it. To follow the example, this will be mule.env=prod
.
Running on CloudHub
While creating your application on CloudHub (Or you can do it later as a next step), you need to go to "Manage Application"
> "Properties"
to set all environment variables detailed in Properties to be configured.
Follow other steps defined here and once your app is all set and started, there is no need to do anything else.
Deploying your Anypoint Template on CloudHub
Anypoint Studio provides you with really easy way to deploy your Template directly to CloudHub, for the specific steps to do so please check this link
Applying policies on CloudHub
When a Mule application is deployed using the Mule 4.1.4+ Runtime, the API Manager allows you to dynamically apply different policies that can be used for securing the application, among many other things. More information can be found in API Manager policies documentation
Properties to be configured (With examples)
In order to use this Mule Anypoint Template you need to configure properties (Credentials, configurations, etc.) either in properties file or in CloudHub as Environment Variables.
Detailed list with examples:
Application properties
- http.port
8081
SFDC Commerce Cloud Connector configuration
- ocapi.host
myinstance.comercecloud.salesforce.com
- ocapi.basePath
/basepath/
- ocapi.clientId
my_client_id
- ocapi.clientSecret
my_client_secret
ocapi.tokenUrl
https://path.to.token/access_token
location.id
store_id