README
cli-plugin-imports
Commerce Layer CLI Imports plugin
Usage
Commands
commercelayer imports
commercelayer imports:create
commercelayer imports:delete ID
commercelayer imports:details ID
commercelayer imports:group GROUP_ID
commercelayer imports:list
commercelayer imports:types
commercelayer imports
List all the created imports.
USAGE
$ commercelayer 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
-l, --limit=limit
limit number of imports in output
-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|sku_lists|sku_list_items|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
commercelayer imports:create
Create a new import.
USAGE
$ commercelayer imports:create
OPTIONS
-C, --csv accept input file in CSV format
-b, --blind execute in blind mode without showing the progress monitor
-i, --inputs=inputs (required) the path of the file containing the data to import
-o, --organization=organization (required) the slug of your organization
-p, --parent=parent the id of the parent resource to be associated with imported data
-q, --quiet execute command without showing warning messages
-t, --type=orders|coupons|skus|sku_lists|... (required) the type of resource being imported
ALIASES
$ commercelayer imp:create
$ commercelayer import
EXAMPLES
$ commercelayer imports:create -t stock_items -p <stock_location-id> -i <input-file-path>
$ cl imp:create 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
OPTIONS
-o, --organization=organization (required) the slug of your organization
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
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
$ 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
OPTIONS
-o, --organization=organization (required) the slug of your organization
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
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
-l, --limit=limit
limit number of imports in output
-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|sku_lists|sku_list_items|prices|stock_items|gift_cards|customers|customer_subscriptions
|tax_categories
the type of resource imported
-w, --warnings
show only import with warnings
ALIASES
$ commercelayer imports
$ 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
ALIASES
$ commercelayer imp:types
EXAMPLES
$ commercelayer imports:types
$ cl imp:types
See code: src/commands/imports/types.ts