@commercelayer/cli-plugin-exports

Commerce Layer CLI Exports plugin


* Usage
* Commands

Usage

``sh-session
commercelayer COMMAND

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



Commands

* [commercelayer exports [ID]](#commercelayer-exports-id)
* commercelayer exports:all
* commercelayer exports:create
* commercelayer exports:details ID
* commercelayer exports:group GROUP_ID
* commercelayer exports:interrupt ID
* commercelayer exports:list
* commercelayer exports:types

$3

List all the created exports or show details of a single export.

`sh-session
USAGE
$ commercelayer exports [ID] [-A | -l ] [-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|returns|shipmen
ts|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|t
ax_categories|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=
limit number of exports in output

-s, --status=
the export job status


-t, --type=
the type of resource exported
scriptions|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|retur
ns|shipments|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transf
ers|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_

$3

Export all the records.

`sh-session
USAGE
$ commercelayer exports:all -t [-i ...] [-w ...] [-f ...] [-D] [-F csv|json | -C |
] [-x | -X ] [-b] [-P | ] [-O] [-q] [-k] [-S ]

FLAGS
-C, --csv export data in CSV format
-D, --dry-data skip redundant attributes
-F, --format= [default: json] export file format

-O, --open open automatically the file after a successful export
-P, --prettify prettify json output format
-S, --size= max number of records for each export [1000-5000]
-X, --save-path= save command output to file and create missing path directories
-b, --blind execute in blind mode without showing the progress monitor
-f, --fields=... comma separated list of fields to include in the export
-i, --include=... comma separated resources to include
-k, --keep keep original export files in temp dir
-q, --quiet execute command without showing warning messages
-t, --type= (required) the type of resource being exported
-w, --where=... comma separated list of query filters
-x, --save= save command output to file

DESCRIPTION
export all the records

ALIASES
$ commercelayer exp:all
$ commercelayer export

EXAMPLES
$ commercelayer exports:all -t orders -f number -X

$ cl exp:all -t customers -i customer_subscriptions -w email_end=@test.org -X

$ cl export -t skus -w code_start=SHIRT -X --csv
`

_See code: src/commands/exports/all.ts_

$3

Create a new export.

`sh-session
USAGE
$ commercelayer exports:create -t [-i ...] [-w ...] [-f ...] [-D] [-F csv|json | -C |
] [-x | -X ] [-b] [-P | ] [-O]

FLAGS
-C, --csv export data in CSV format
-D, --dry-data skip redundant attributes
-F, --format= [default: json] export file format

-O, --open open automatically the file after a successful export
-P, --prettify prettify json output format
-X, --save-path= save command output to file and create missing path directories
-b, --blind execute in blind mode without showing the progress monitor
-f, --fields=... comma separated list of fields to include in the export
-i, --include=... comma separated resources to include
-t, --type= (required) the type of resource being exported
-w, --where=... comma separated list of query filters
-x, --save= save command output to file

DESCRIPTION
create a new export

ALIASES
$ commercelayer exp:create

EXAMPLES
$ commercelayer exports:create -t orders -f number -X

$ cl exp:create -t customers -i customer_subscriptions -w email_end=@test.org -X --csv
`

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

$3

Show the details of an existing export.

`sh-session
USAGE
$ commercelayer exports:details ID

ARGUMENTS
ID id of the export resource

DESCRIPTION
show the details of an existing export

ALIASES
$ commercelayer exp:details

EXAMPLES
$ commercelayer exports:details

$ cl exp:details
`

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

$3

List all the exports related to an export group.

`sh-session
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

$ cl exp:group
`

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

$3

Show the details of an existing export.

`sh-session
USAGE
$ commercelayer exports:interrupt ID [-D]

ARGUMENTS
ID id of the export resource

FLAGS
-D, --details show export details after command execution

DESCRIPTION
show the details of an existing export

ALIASES
$ commercelayer exp:interrupt

EXAMPLES
$ commercelayer exports:interrupt

$ cl exp:interrupt
`

_See code: src/commands/exports/interrupt.ts_

$3

List all the created exports.

`sh-session
USAGE
$ commercelayer exports:list [-A | -l ] [-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|returns|shipmen
ts|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|t
ax_categories|transactions|voids] [-s in_progress|pending|completed|interrupted]

FLAGS
-A, --all
show all exports instead of first 25 only

-l, --limit=
limit number of exports in output

-s, --status=
the export job status


-t, --type=
the type of resource exported
scriptions|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|retur
ns|shipments|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transf
ers|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_

$3

Show online documentation for supported resources.

`sh-session
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_