@commercelayer/cli-plugin-imports

cli-plugin-imports

Commerce Layer CLI Imports plugin

Usage

$ cl-imports COMMAND

$ cl-imports (-v | version | --version) to check the version of the CLI you have installed.

$ cl-imports [COMMAND] (--help | -h) for detailed information about CLI commands.

Commands

• cl-imports imports
• cl-imports imports:create
• cl-imports imports:delete ID
• cl-imports imports:details ID
• cl-imports imports:group GROUP_ID
• cl-imports imports:list

cl-imports imports

List all the created imports.

USAGE
  $ cl-imports imports

OPTIONS
  -A, --all
      show all imports instead of first 25 only

  -e, --errors
      show only imports with errors

  -g, --group=group
      the group ID associated to the import in case of multi-chunk imports

  -o, --organization=organization
      (required) the slug of your organization

  -s, --status=in_progress|pending|completed|interrupted
      the import job status

  -t, --type=orders|coupons|skus|prices|stock_items|gift_cards|customers|customer_subscriptions|tax_categories
      the type of resource imported

  -w, --warnings
      show only import with warnings

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

cl-imports imports:create

Create a new import.

USAGE
  $ cl-imports imports:create

OPTIONS
  -b, --blind
      execute in blind mode without showing the progress monitor

  -c, --csv
      accept input file in CSV format

  -i, --inputs=inputs
      (required) the path of the file containing teh resource data to import in CSV format

  -o, --organization=organization
      (required) the slug of your organization

  -p, --parent=parent
      the id of the parent resource to be associated with imported data

  -t, --type=orders|coupons|skus|prices|stock_items|gift_cards|customers|customer_subscriptions|tax_categories
      (required) the type of resource being imported

  -x, --cleanup
      delete all other existing items

EXAMPLES
  $ commercelayer imports:create -r stock_items -p <stock_location-id>
  $ cl imp:create skus -c

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

cl-imports imports:delete ID

Delete an existing import.

USAGE
  $ cl-imports imports:delete ID

ARGUMENTS
  ID  unique id of the import

OPTIONS
  -o, --organization=organization  (required) the slug of your organization

ALIASES
  $ cl-imports imp:delete

EXAMPLES
  $ commercelayer imports:delete <import-id>>
  $ cl imp:delete <import-id>>

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

cl-imports imports:details ID

Show the details of an existing import.

USAGE
  $ cl-imports imports:details ID

ARGUMENTS
  ID  unique id of the import

OPTIONS
  -i, --inputs                     show input items associated with the import
  -l, --logs                       show warning and error logs related to the import process
  -o, --organization=organization  (required) the slug of your organization

ALIASES
  $ cl-imports import
  $ cl-imports imp:details

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

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

cl-imports imports:group GROUP_ID

List all the imports related to an import group.

USAGE
  $ cl-imports imports:group GROUP_ID

ARGUMENTS
  GROUP_ID  unique id of the group import

OPTIONS
  -o, --organization=organization  (required) the slug of your organization

ALIASES
  $ cl-imports imp:group

EXAMPLES
  $ commercelayer imports:group <group-id>
  $ cl imports:ghroup <group-id>

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

cl-imports imports:list

List all the created imports.

USAGE
  $ cl-imports imports:list

OPTIONS
  -A, --all
      show all imports instead of first 25 only

  -e, --errors
      show only imports with errors

  -g, --group=group
      the group ID associated to the import in case of multi-chunk imports

  -o, --organization=organization
      (required) the slug of your organization

  -s, --status=in_progress|pending|completed|interrupted
      the import job status

  -t, --type=orders|coupons|skus|prices|stock_items|gift_cards|customers|customer_subscriptions|tax_categories
      the type of resource imported

  -w, --warnings
      show only import with warnings

ALIASES
  $ cl-imports imp:list

EXAMPLES
  $ commercelayer imports
  $ cl imports:list -A
  $ cl imp:list

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