Commerce Layer CLI Exports plugin
commercelayer COMMAND
commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.
commercelayer exports [ID]
commercelayer exports:all
commercelayer exports:create
commercelayer exports:details ID
commercelayer exports:group GROUP_ID
commercelayer exports:list
commercelayer exports:types
List all the created exports or show details of a single export.
USAGE
$ commercelayer exports [ID] [-A | -l <value>] [-t
addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_subscriptions
|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|shipments|shipp
ing_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|tax_categ
ories|transactions|voids] [-s in_progress|pending|completed|interrupted]
ARGUMENTS
ID unique id of the export to be retrieved
FLAGS
-A, --all
show all exports instead of first 25 only
-l, --limit=<value>
limit number of exports in output
-s, --status=<option>
the export job status
<options: in_progress|pending|completed|interrupted>
-t, --type=<option>
the type of resource exported
<options: addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_sub
scriptions|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|shipm
ents|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags
|tax_categories|transactions|voids>
DESCRIPTION
list all the created exports or show details of a single export
See code: src/commands/exports/index.ts
Export all the records.
USAGE
$ commercelayer exports:all -t
addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_subscriptions
|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|shipments|shipp
ing_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|tax_categ
ories|transactions|voids [-i <value>] [-w <value>] [-D] [-F csv|json | -C | ] [-x <value> | -X <value>] [-b] [-P | ]
[-O] [-q] [-k]
FLAGS
-C, --csv export data in CSV format
-D, --dry-data skip redundant attributes
-F, --format=<option> [default: json] export file format
<options: csv|json>
-O, --open open automatically the file after a successful export
-P, --prettify prettify json output format
-X, --save-path=<value> save command output to file and create missing path
directories
-b, --blind execute in blind mode without showing the progress monitor
-i, --include=<value>... comma separated resources to include
-k, --keep keep original export files in temp dir
-q, --quiet execute command without showing warning messages
-t, --type=addresses|authorizations|bundles|captures|... (required) the type of resource being exported
-w, --where=<value>... comma separated list of query filters
-x, --save=<value> save command output to file
DESCRIPTION
export all the records
ALIASES
$ commercelayer exp:all
$ commercelayer export
EXAMPLES
$ commercelayer exports:all -t cusorderstomers -X <output-file-path>
$ cl exp:all -t customers -i customer_subscriptions -w [email protected] -X <output-file-path>
$ cl export -t skus -w code_start=SHIRT -X <output-file-path> --csv
See code: src/commands/exports/all.ts
Create a new export.
USAGE
$ commercelayer exports:create -t
addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_subscriptions
|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|shipments|shipp
ing_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|tax_categ
ories|transactions|voids [-i <value>] [-w <value>] [-D] [-F csv|json | -C | ] [-x <value> | -X <value>] [-b] [-P | ]
[-O]
FLAGS
-C, --csv export data in CSV format
-D, --dry-data skip redundant attributes
-F, --format=<option> [default: json] export file format
<options: csv|json>
-O, --open open automatically the file after a successful export
-P, --prettify prettify json output format
-X, --save-path=<value> save command output to file and create missing path
directories
-b, --blind execute in blind mode without showing the progress monitor
-i, --include=<value>... comma separated resources to include
-t, --type=addresses|authorizations|bundles|captures|... (required) the type of resource being exported
-w, --where=<value>... comma separated list of query filters
-x, --save=<value> save command output to file
DESCRIPTION
create a new export
ALIASES
$ commercelayer exp:create
EXAMPLES
$ commercelayer exports:create -t orders -X <output-file-path>
$ cl exp:create -t customers -i customer_subscriptions -w [email protected] -X <output-file-path> --csv
See code: src/commands/exports/create.ts
Show the details of an existing export.
USAGE
$ commercelayer exports:details ID
ARGUMENTS
ID unique id of the export
DESCRIPTION
show the details of an existing export
ALIASES
$ commercelayer exp:details
EXAMPLES
$ commercelayer exports:details <export-id>
$ cl exp:details <export-id>
See code: src/commands/exports/details.ts
List all the exports related to an export group.
USAGE
$ commercelayer exports:group GROUP_ID
ARGUMENTS
GROUP_ID unique id of the group export
DESCRIPTION
list all the exports related to an export group
ALIASES
$ commercelayer exp:group
EXAMPLES
$ commercelayer exports:group <group-id>
$ cl exp:group <group-id>
See code: src/commands/exports/group.ts
List all the created exports.
USAGE
$ commercelayer exports:list [-A | -l <value>] [-t
addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_subscriptions
|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|shipments|shipp
ing_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|tax_categ
ories|transactions|voids] [-s in_progress|pending|completed|interrupted]
FLAGS
-A, --all
show all exports instead of first 25 only
-l, --limit=<value>
limit number of exports in output
-s, --status=<option>
the export job status
<options: in_progress|pending|completed|interrupted>
-t, --type=<option>
the type of resource exported
<options: addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_sub
scriptions|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|shipm
ents|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags
|tax_categories|transactions|voids>
DESCRIPTION
list all the created exports
ALIASES
$ commercelayer exp:list
EXAMPLES
$ commercelayer exports
$ cl exports:list -A
$ cl exp:list
See code: src/commands/exports/list.ts
Show online documentation for supported resources.
USAGE
$ commercelayer exports:types [-O]
FLAGS
-O, --open open online documentation page
DESCRIPTION
show online documentation for supported resources
ALIASES
$ commercelayer exp:types
EXAMPLES
$ commercelayer exports:types
$ cl exp:types
See code: src/commands/exports/types.ts