@salesforce/plugin-1commerce

=====================

Salesforce CLI Commands for managing 1Commerce WebStores and Data.

Installing

Install from the repository directly:

sfdx plugins:install https://github.com/forcedotcom/sfdx-1commerce-plugin

Installing from source

1. Install the Salesforce CLI.
2. Clone the repository
3. Install node_modules modules: yarn install
4. Link the plugin: sfdx plugins:link .

Docs

sfdx 1commerce -h

Salesforce Internal Developers

• See below

Table of Contents

• @salesforce/plugin-1commerce
• Table of Contents
• Usage
• Commands
• How-to-Contribute

Usage

$ npm install -g @salesforce/plugin-1commerce
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
@salesforce/plugin-1commerce/0.0.7 linux-x64 node-v12.18.4
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

Commands

• sfdx 1commerce:import:products -d <string> [-w <string>] [-n <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx 1commerce:search:start [-n <string> | -i <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

sfdx 1commerce:import:products -d <string> [-w <string>] [-n <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Import uploaded data into a given webstore

USAGE
  $ sfdx 1commerce:import:products -d <string> [-w <string>] [-n <string>] [-u <string>] [--apiversion <string>] 
  [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -d, --contentversionid=contentversionid                                           (required) ID of a file in FFX; CSV
                                                                                    only for 230; JSON and XML (?)
                                                                                    planned for the future. To be
                                                                                    imported into the store

  -n, --name=name                                                                   The name of the webstore to import
                                                                                    to that was created. This or the
                                                                                    webstoreId is required

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  -w, --webstoreid=webstoreid                                                       the ID of the webstore to import to,
                                                                                    will fetch/create the defaults
                                                                                    associated with this webstore if
                                                                                    needed. This is or the name is
                                                                                    required.

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  $ sfdx 1commerce:import:products -d 00Dxx0000000000 -w 00Dxx0000000000

See code: src/commands/1commerce/import/products.ts

sfdx 1commerce:search:start [-n <string> | -i <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Start search indexing for a given webstore

USAGE
  $ sfdx 1commerce:search:start [-n <string> | -i <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
  -i, --id=id                                                                       ID of webstore to index
  -n, --name=name                                                                   name of webstore to index

  -u, --targetusername=targetusername                                               username or alias for the target
                                                                                    org; overrides default target org

  --apiversion=apiversion                                                           override the api version used for
                                                                                    api requests made by this command

  --json                                                                            format output as json

  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
                                                                                    this command invocation

EXAMPLE
  sfdx 1commerce:search:start -n storeName
  // Finds a store and indexes it

See code: src/commands/1commerce/search/start.ts

How-to-Contribute

Please submit a PR!

Information on development can be found here: https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins.htm