Mode d’emploi
- Copiez la commande et examinez le paquet avant de l’installer dans votre environnement agent.
- Consultez le document original pour les outils, identifiants et environnements requis.
- Décrivez les entrées et le livrable souhaité ; comparez la sortie aux sources.
npx skills add https://github.com/arohitu/salesforce-revenue-cloud-skills --skill revenue-cloud-config-apisAvant de commencer
- L’installation n’inclut ni abonnement au modèle, ni quota API, ni accès aux fichiers.
- Étoiles et installations reflètent l’activité, pas un test indépendant de qualité ou de sécurité.
Rendu depuis le dépôt source en conservant titres, exemples, code, tableaux, liens et images.
Revenue Cloud Product Configurator Business APIs
Salesforce Revenue Cloud (Revenue Lifecycle Management) exposes ten Connect REST resources for product configuration. This skill lists every resource and bundles a curl script that authenticates through the Salesforce CLI and POSTs to each one.
- Base URL pattern:
https://<instance>/services/data/v<version><resource> - Auth: OAuth bearer token (
Authorization: Bearer <accessToken>), obtained from an
authorized org via sf org display --json.
- Source of truth: output-md/Product Configurator APIs.md.
For full request bodies, property tables, and response bodies, read references/resources.md first; consult the source doc for complete schemas.
API version rule
Always call with the latest API version the org supports, and never below v67.0. The bundled script auto-discovers the newest version from GET /services/data/ and uses max(latestOrgVersion, 67.0). Any explicit --api-version below 67.0 is rejected.
Gotchas
- These APIs are stateless - they don't recall prior user actions between calls
unless state is explicitly persisted and reloaded. Deselecting a child product and later reselecting it is treated as adding a brand-new item; the original line item is not restored and a new line item is created.
- Minimum callable version is v67.0, even though most resources are available since
v60.0. /revenue/product-configurator/rules/actions/execute requires v67.0+.
contextResponseTypeonconfigurerequires v65.0+ and is intended for large sales
transactions (>1000 line items, <15K line items).
transactionId= the header entity being configured (Quote/Order).contextId/
transactionContextId = the transaction context instance id returned by load/configure. Node and quantity resources operate on an existing contextId.
- All ten resources use POST. Sample IDs in
payloads/*.jsonare placeholders -
replace them with real org IDs before calling a live org.
Resources
All resources use the POST method.
| Resource | Purpose |
|---|---|
/connect/cpq/configurator/actions/configure | Retrieve and update a product's configuration; execute configuration rules, report violations for bundle/attribute/quantity changes, and get pricing for the configured bundle. |
/connect/cpq/configurator/actions/load-instance | Create a session for the configuration instance from a transaction ID; returns a session id with results of configuration rules, qualification rules, and pricing. |
/connect/cpq/configurator/actions/set-instance | Set a configuration instance when the instance lives in a database other than Salesforce while product catalog data is in Salesforce. |
/connect/cpq/configurator/actions/get-instance | Fetch the JSON representation of a product configuration to display in the UI or save to an external system. |
/connect/cpq/configurator/actions/save-instance | Save a configuration instance after a successful product configuration. |
/connect/cpq/configurator/actions/set-product-quantity | Set the quantity of a product through the runtime system. |
/connect/cpq/configurator/actions/add-nodes | Add a node to the context through the runtime system without using the Salesforce UI. |
/connect/cpq/configurator/actions/update-nodes | Update nodes in a product configuration. |
/connect/cpq/configurator/actions/delete-nodes | Delete nodes from a product configuration. |
/revenue/product-configurator/rules/actions/execute | Run rules for a specific quote or order based on a context ID or transaction ID. |
Each resource's URI, available version, request-body example, property table, and response representation are in references/resources.md.
Authentication
Authorize an org once with the Salesforce CLI, then reuse it:
sf org login web --alias myorg
sf org display --json --target-org myorgsf org display --json returns result.instanceUrl and result.accessToken, which the script uses to build the URL and bearer header.
Quick start - call every resource
Prerequisites: Salesforce CLI (sf) with an authorized org, curl, jq, and a Bash shell (Git Bash or WSL on Windows).
# List all ten resources and their payload files (no org needed)
bash scripts/call-configurator-apis.sh --list
# Preview the exact URLs and curl commands without calling the org
bash scripts/call-configurator-apis.sh --dry-run --target-org myorg
# POST to every resource using the bundled sample payloads
bash scripts/call-configurator-apis.sh --target-org myorg
# Call a single resource
bash scripts/call-configurator-apis.sh --target-org myorg --resource configureRun bash scripts/call-configurator-apis.sh --help for all flags and exit codes.
Workflow for calling a live org
- Edit the relevant
payloads/*.jsonwith real ids (transactionId,contextId,
account/contact ids, product ids).
--dry-runfirst to confirm the URL, version (>= v67.0), and payload.- Run without
--dry-run. Inspect the per-resource JSON status lines on stdout. - On errors, read the Salesforce response body and cross-check the request against
references/resources.md and the source doc.
Available scripts
- `scripts/call-configurator-apis.sh` - Auth via
sf, auto-select latest API version
(floored at v67.0), and POST to all ten resources (or one via --resource). Supports --list, --dry-run, --target-org, --api-version, --payload-dir, --output.
