cli-plugin-imports

Commerce Layer CLI Imports plugin


* Usage
* Commands

Usage

``sh-session
commercelayer COMMAND

commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.
`



Commands

* [commercelayer imports [ID]](#commercelayer-imports-id)
* commercelayer imports:create
* commercelayer imports:delete ID
* commercelayer imports:details ID
* commercelayer imports:group GROUP_ID
* commercelayer imports:list
* commercelayer imports:types

$3

List all the created imports or show details of a single import.

`sh-session
USAGE
$ commercelayer imports [ID] [-A | -l ] [-t
addresses|bundles|coupons|customer_addresses|customer_payment_sources|customer_subscriptions|customers|gift_cards|li
ne_items|line_item_options|orders|price_tiers|prices|shipping_categories|sku_lists|sku_list_items|sku_options|skus|s
tock_items|stock_transfers|tags|tax_categories] [-g | ] [-s in_progress|pending|completed|interrupted] [-e]
[-w]

ARGUMENTS
ID unique id of the import to be retrieved

FLAGS
-A, --all show all imports instead of first 25 only
-e, --errors show only imports with errors
-g, --group= the group ID associated to the import in case of multi-chunk imports
-l, --limit= limit number of imports in output
-s, --status= the import job status

-t, --type= the type of resource imported
addresses|bundles|coupons|customer_addresses|customer_payment_sources|customer_subscriptions|cu
stomers|gift_cards|line_items|line_item_options|orders|price_tiers|prices|shipping_categories|s
ku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|tax_categories>
-w, --warnings show only import with warnings

DESCRIPTION
list all the created imports or show details of a single import
`

_See code: src/commands/imports/index.ts_

$3

Create a new import.

`sh-session
USAGE
$ commercelayer imports:create -t addresses|bundles|coupons|customer_addresses|... [-p ] (-C -i )
[-b | -q | ]

FLAGS
-C, --csv accept input file in CSV format
-b, --blind execute in blind mode without showing the progress
monitor
-i, --inputs= (required) the path of the file containing the data to
import
-p, --parent= the id of the parent resource to be associated with
imported data
-q, --quiet execute command without showing warning messages
-t, --type=addresses|bundles|coupons|customer_addresses|... (required) the type of resource being imported

DESCRIPTION
create a new import

ALIASES
$ commercelayer imp:create
$ commercelayer import

EXAMPLES
$ commercelayer imports:create -t stock_items -p -i

$ cl imp:create -t skus -i
`

_See code: src/commands/imports/create.ts_

$3

Delete an existing import.

`sh-session
USAGE
$ commercelayer imports:delete ID

ARGUMENTS
ID unique id of the import

DESCRIPTION
delete an existing import

ALIASES
$ commercelayer imp:delete

EXAMPLES
$ commercelayer imports:delete >

$ cl imp:delete >
`

_See code: src/commands/imports/delete.ts_

$3

Show the details of an existing import.

`sh-session
USAGE
$ commercelayer imports:details ID [-l] [-S -i]

ARGUMENTS
ID unique id of the import

FLAGS
-S, --save-inputs= save import inputs to local file
-i, --inputs show input items associated with the import
-l, --logs show warning and error logs related to the import process

DESCRIPTION
show the details of an existing import

ALIASES
$ commercelayer imp:details

EXAMPLES
$ commercelayer imports:details

$ cl imp:details -i

$ cl imp:details -i -l
`

_See code: src/commands/imports/details.ts_

$3

List all the imports related to an import group.

`sh-session
USAGE
$ commercelayer imports:group GROUP_ID

ARGUMENTS
GROUP_ID unique id of the group import

DESCRIPTION
list all the imports related to an import group

ALIASES
$ commercelayer imp:group

EXAMPLES
$ commercelayer imports:group

$ cl imp:group
`

_See code: src/commands/imports/group.ts_

$3

List all the created imports.

`sh-session
USAGE
$ commercelayer imports:list [-A | -l ] [-t
addresses|bundles|coupons|customer_addresses|customer_payment_sources|customer_subscriptions|customers|gift_cards|li
ne_items|line_item_options|orders|price_tiers|prices|shipping_categories|sku_lists|sku_list_items|sku_options|skus|s
tock_items|stock_transfers|tags|tax_categories] [-g | ] [-s in_progress|pending|completed|interrupted] [-e]
[-w]

FLAGS
-A, --all show all imports instead of first 25 only
-e, --errors show only imports with errors
-g, --group= the group ID associated to the import in case of multi-chunk imports
-l, --limit= limit number of imports in output
-s, --status= the import job status

-t, --type= the type of resource imported
addresses|bundles|coupons|customer_addresses|customer_payment_sources|customer_subscriptions|cu
stomers|gift_cards|line_items|line_item_options|orders|price_tiers|prices|shipping_categories|s
ku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|tax_categories>
-w, --warnings show only import with warnings

DESCRIPTION
list all the created imports

ALIASES
$ commercelayer imp:list

EXAMPLES
$ commercelayer imports

$ cl imports:list -A

$ cl imp:list
`

_See code: src/commands/imports/list.ts_

$3

Show online documentation for supported resources.

`sh-session
USAGE
$ commercelayer imports:types [-O]

FLAGS
-O, --open open online documentation page

DESCRIPTION
show online documentation for supported resources

ALIASES
$ commercelayer imp:types

EXAMPLES
$ commercelayer imports:types

$ cl imp:types
``

_See code: src/commands/imports/types.ts_