@commercelayer/cli-plugin-imports

cli-plugin-imports

Commerce Layer CLI Imports plugin

• Usage
• Commands

Usage

commercelayer COMMAND

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

Commands

• 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

commercelayer imports [ID]

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

USAGE
  $ commercelayer imports [ID] [-A | -l <value>] [-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 <value> | ] [-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=<value>    the group ID associated to the import in case of multi-chunk imports
  -l, --limit=<value>    limit number of imports in output
  -s, --status=<option>  the import job status
                         <options: in_progress|pending|completed|interrupted>
  -t, --type=<option>    the type of resource imported
                         <options:
                         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

commercelayer imports:create

Create a new import.

USAGE
  $ commercelayer imports:create -t addresses|bundles|coupons|customer_addresses|... [-p <value>] (-C -i <value>)
    [-b | -q | ]

FLAGS
  -C, --csv                                                    accept input file in CSV format
  -b, --blind                                                  execute in blind mode without showing the progress
                                                               monitor
  -i, --inputs=<value>                                         (required) the path of the file containing the data to
                                                               import
  -p, --parent=<value>                                         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 <stock_location-id> -i <input-file-path>

  $ cl imp:create -t skus -i <input-file-path>

See code: src/commands/imports/create.ts

commercelayer imports:delete ID

Delete an existing import.

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 <import-id>>

  $ cl imp:delete <import-id>>

See code: src/commands/imports/delete.ts

commercelayer imports:details ID

Show the details of an existing import.

USAGE
  $ commercelayer imports:details ID [-l] [-S <value> -i]

ARGUMENTS
  ID  unique id of the import

FLAGS
  -S, --save-inputs=<value>  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 <import-id>

  $ cl imp:details <import-id> -i

  $ cl imp:details <import-id> -i -l

See code: src/commands/imports/details.ts

commercelayer imports:group GROUP_ID

List all the imports related to an import group.

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 <group-id>

  $ cl imp:group <group-id>

See code: src/commands/imports/group.ts

commercelayer imports:list

List all the created imports.

USAGE
  $ commercelayer imports:list [-A | -l <value>] [-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 <value> | ] [-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=<value>    the group ID associated to the import in case of multi-chunk imports
  -l, --limit=<value>    limit number of imports in output
  -s, --status=<option>  the import job status
                         <options: in_progress|pending|completed|interrupted>
  -t, --type=<option>    the type of resource imported
                         <options:
                         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

commercelayer imports:types

Show online documentation for supported resources.

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

Changelog

4.2.1 (2024-08-27)

Bug Fixes

• fix output messages (42c6dcc)

Features

• remove oclif ux (85e9633)