Skip to content
CPQ DevKit™
CPQ DevKit™ for Epicor
CPQ DevKit™ for Epicor

Epicor CPQのSNAPとAPIをVS Codeで

SNAPコードをワークスペースへプルし、OpenAPI操作を実行し、テナント認証はVS CodeのSecret Storageに保持します。

VS Code にインストールサインインしてAIを利用機能を見る変更履歴

macOS • Windows • Linux

CPQ DevKit™ for Epicor helps you connect to an Epicor CPQ (KBMax) tenant, pull SNAP code into your workspace, and run API operations from the Command Palette.

Quick Start

  1. Install the extension from the VS Code Marketplace
  2. Open a folder and run CPQ DevKit™ for Epicor: Configure Epicor CPQ Connection
  3. Enter the tenant URL and choose session (email/password) or Basic auth. The password stays in VS Code secret storage
  4. Run Show Tenant API Version to confirm the connection
  5. Run Pull SNAP Code into Workspace to download products, functions, actions, workflows, and rules as editable files

What's New in 2.7.1

  • New Marketplace icon: the CPQ DevKit™ wordmark on the Epicor color plate
  • Ask @cpq-epicor in chat, or use #epicorEnv, to see the connection
  • Install Chat Skills adds guidance for tenant checks and SNAP work
  • Requires VS Code 1.109 or later

See full release notes in the changelog.

How to use it

Connect

Configure Epicor CPQ Connection saves the tenant URL and auth mode in .cpqdevkit/epicor/epicor-config.json. The password is not written to that file.

Use Show Tenant API Version any time you want to confirm the tenant is reachable.

Pull SNAP code

Pull SNAP Code into Workspace downloads:

  • products
  • safe and global functions
  • custom actions
  • workflows and the workflow selector
  • product rules

Files land under epicor/snap-code (configurable):

  • raw/ — the full records from the tenant
  • extracted/ — rule JavaScript, block serializations, and decoded JSON you can edit

Later pulls can skip unchanged records. A full pull is still available when you want everything again.

Run API operations

You do not need to know the API by heart.

  • List Epicor CPQ API Operations — browse available operations
  • Show Epicor CPQ Operation Details — inspect one operation
  • Run Epicor CPQ Operation (Interactive) — pick an operation and fill in parameters
  • Create Epicor CPQ Request Template — start a request JSON in the editor
  • Run Epicor CPQ Request (Active JSON) — run the request you have open
  • Create Epicor CPQ Request in Workspace — save a reusable .epicor-http.json file (default folder epicor/requests)
  • Run Epicor CPQ Request File — run a saved request file

Saved request files are safe to commit if they do not include secrets.

Commands

All commands are in the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) under CPQ DevKit™ for Epicor.

CommandDescription
Configure Epicor CPQ ConnectionSet tenant URL and auth mode
Show Tenant API VersionConfirm the connected tenant
Pull SNAP Code into WorkspaceDownload SNAP code as editable files
List Epicor CPQ API OperationsBrowse available API operations
Show Epicor CPQ Operation DetailsInspect one operation
Run Epicor CPQ Operation (Interactive)Run an operation with prompts
Create Epicor CPQ Request TemplateCreate a request JSON in the editor
Run Epicor CPQ Request (Active JSON)Run the open request
Create Epicor CPQ Request in WorkspaceSave a reusable request file
Run Epicor CPQ Request FileRun a saved request file
Convert to JSON / XML / CSVConvert the current data file
Install Chat SkillsAdd Epicor guidance for chat

Settings

Configure the extension under ecpq.* in VS Code Settings.

SettingDefaultDescription
ecpq.snapCodeDirepicor/snap-codeFolder for pulled SNAP code
ecpq.requestsDirepicor/requestsFolder for saved request files
ecpq.requestTimeout30000Timeout in ms for tenant requests
ecpq.pageSize100Page size when listing tenant records
ecpq.detailConcurrency4How many detail requests to run at once
ecpq.specPath(bundled spec)Optional path to a custom OpenAPI file

Requirements

  • VS Code 1.109 or later
  • An Epicor CPQ (KBMax) tenant URL
  • A user that can sign in with session auth or Basic auth

Security & Privacy

  • Passwords are stored in VS Code secret storage, not in epicor-config.json
  • Chat tools report the connection without secrets
  • Keep secrets out of saved request files if you commit them

Support

License

See LICENSE.md for details.

Frequently Asked Questions

What is CPQ DevKit™ for Epicor?

A VS Code extension for Epicor CPQ: connect to a tenant, pull SNAP code, and run API operations from the editor.

How do I connect?

Run Configure Epicor CPQ Connection and choose session or Basic auth. Then use Show Tenant API Version to confirm.

Where does SNAP code go?

Under epicor/snap-code by default. Change ecpq.snapCodeDir if you want a different folder.

Which operating systems are supported?

macOS, Windows, and Linux.

Trademarks

Epicor and KBMax are trademarks of their respective owners. This extension is not affiliated with or endorsed by Epicor.