store Commands

commerce:store:create 

Comprehensive create and set up a store. This will create your community/store push store sources, create buyer user, import products, create search index.

Examples for commerce:store:create 

sfdx commerce:store:create --store-name test-store

Command Syntax 
sfdx commerce:store:create

[--json]

[--loglevel LOGLEVEL]

[-v TARGETDEVHUBUSERNAME]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

[-f DEFINITIONFILE]

[-o TYPE]

[-y]

[-t TEMPLATENAME]

[-b BUYER-USERNAME]

[-n STORE-NAME]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-v | --targetdevhubusername TARGETDEVHUBUSERNAME

Optional

A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.

Type: string

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-f | --definitionfile DEFINITIONFILE

Optional

Config file.

Type: filepath

Default value: ~/.commerce/config/store-scratch-def.json

-o | --type TYPE

Optional

The type of store you want to create.

Type: string

Permissible values are: b2c, b2b

Default value: b2c

-y | --prompt

Optional

If there is a file difference detected, prompt before overwriting file.

Type: boolean

-t | --templatename TEMPLATENAME

Optional

Template to use to create a site .

Type: string

Default value: b2c-lite-storefront

-b | --buyer-username BUYER-USERNAME

Optional

Buyer's username.

Type: string

Default value: buyer@1commerce.com

-n | --store-name STORE-NAME

Required

Name of the site to create.

Type: string

Default value: 1commerce

commerce:store:display 

Display buyer info.

Examples for commerce:store:display 

sfdx commerce:store:display --store-name test-store

Command Syntax 
sfdx commerce:store:display

[--json]

[--loglevel LOGLEVEL]

[-v TARGETDEVHUBUSERNAME]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

[-b BUYER-USERNAME]

[-n STORE-NAME]

[-p URLPATHPREFIX]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-v | --targetdevhubusername TARGETDEVHUBUSERNAME

Optional

A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.

Type: string

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-b | --buyer-username BUYER-USERNAME

Optional

Buyer's username.

Type: string

Default value: buyer@1commerce.com

-n | --store-name STORE-NAME

Required

Name of the site to create.

Type: string

Default value: 1commerce

-p | --urlpathprefix URLPATHPREFIX

Optional

Required if different from store-name URL to append to the domain created when Experiences was enabled for this org.

Type: string

commerce:store:open 

Open store(s).

Examples for commerce:store:open 

sfdx commerce:store:open --store-name test-store

sfdx commerce:store:open --all

Command Syntax 
sfdx commerce:store:open

[--json]

[--loglevel LOGLEVEL]

[-v TARGETDEVHUBUSERNAME]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

[-n STORE-NAME]

[--all]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-v | --targetdevhubusername TARGETDEVHUBUSERNAME

Optional

A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.

Type: string

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-n | --store-name STORE-NAME

Required

Name of the site to create.

Type: string

Default value: 1commerce

--all

Optional

View All stores using sfdx force:org:open _ui/networks/setup/SetupNetworksPage page.

Type: boolean

commerce:store:quickstart:create 

Use this command to just create a community. It will use sfdx force:community:create until a community is created or failed.

Examples for commerce:store:quickstart:create 

sfdx commerce:store:quickstart:create --templatename ‘b2c-lite-storefront’

Command Syntax 
sfdx commerce:store:quickstart:create

[--json]

[--loglevel LOGLEVEL]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

[-t TEMPLATENAME]

[-n STORE-NAME]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-t | --templatename TEMPLATENAME

Optional

Template to use to create a site .

Type: string

Default value: b2c-lite-storefront

-n | --store-name STORE-NAME

Required

Name of the site to create.

Type: string

Default value: 1commerce

commerce:store:quickstart:setup 

Set up a store.

Examples for commerce:store:quickstart:setup 

sfdx commerce:store:quickstart:setup --definitionfile store-scratch-def.json

Command Syntax 
sfdx commerce:store:quickstart:setup

[--json]

[--loglevel LOGLEVEL]

[-v TARGETDEVHUBUSERNAME]

[-u TARGETUSERNAME]

[--apiversion APIVERSION]

[-f DEFINITIONFILE]

[-y]

[-n STORE-NAME]

Parameters 
--json

Optional

Format output as JSON.

Type: boolean

--loglevel LOGLEVEL

Optional

The logging level for this command invocation. Logs are stored in $HOME/.sfdx/sfdx.log.

Type: enum

Permissible values are: trace, debug, info, warn, error, fatal, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Default value: warn

-v | --targetdevhubusername TARGETDEVHUBUSERNAME

Optional

A username or alias for the target Dev Hub org. Overrides the default Dev Hub org.

Type: string

-u | --targetusername TARGETUSERNAME

Optional

A username or alias for the target org. Overrides the default target org.

Type: string

--apiversion APIVERSION

Optional

Override the API version used for API requests made by this command.

Type: string

-f | --definitionfile DEFINITIONFILE

Optional

Config file.

Type: filepath

Default value: ~/.commerce/config/store-scratch-def.json

-y | --prompt

Optional

If there is a file difference detected, prompt before overwriting file.

Type: boolean

-n | --store-name STORE-NAME

Required

Name of the site to create.

Type: string

Default value: 1commerce

Salesforce Commerce Plug-In CLI Command Reference
commerce Namespace
examples Commands
files Commands
payments Commands
products Commands
store Commands
Help for Salesforce CLI Commands
CLI Deprecation Policy
Discover Salesforce Plugins
Previous Versions