Retail Cloud API Developer Guide for Non Hyperforce Users
Invoking Retail Cloud's APIs is a two-step process. This topic describes the steps and includes sample responses.
For a comprehensive list of APIs and SPIs, see Retail Cloud API Specifications.
In 2024, Salesforce acquired PredictSpring, a provider of modern retail Point-of-Sale (POS) software built natively in the cloud. The product is now known as Retail Cloud. You may still see references to PredictSpring in the Retail Cloud POS app and in our documentation (for example, in API header names).
Find the keys needed to use Retail Cloud's API in CMS by going to Advanced > Merchant Configuration > Developer Credentials.
- Staging API Base URL: https://api.predictspring.com/staging/service
- Production API Base URL: https://api.predictspring.com/prod/service
- Staging OAuth2 URL: https://staging-oauth2.predictspring.com/oauth2/token
- Production OAuth2 URL: https://prod-oauth2.predictspring.com/oauth2/token
- Production: 10 requests per second and 100,000 requests per month.
- Staging: 10,000 requests per month.
For additional API volume, contact Salesforce Customer Support.
To use Retail Cloud's APIs, complete a two-step authentication process. First, obtain an OAuth token. Then, use that token to make API calls.
Sample Response:
Extract the access token value. This token is required for Step 2 to invoke the Retail Cloud API.
The token is valid for the expiry period as specified in expired_in in seconds.
Pass the access token as PredictSpring-Token when invoking the Retail Cloud API.
Make sure that Content-Type is set to application/json in all the requests.
Invoke Retail Cloud API with the below headers:
- PredictSpring-Secret (this is an encrypted string you will get from Retail Cloud)
- PredictSpring-Token
- X-api-key
- Content-Type: application/json
x-api-key is the Merchant API Key in the UI.
Here's a sample request to create promotions in a staging environment.