@commercelayer/cli-plugin-exports

@commercelayer/cli-plugin-exports

Commerce Layer CLI Exports plugin

• Usage
• Commands

Usage

commercelayer COMMAND

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

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

commercelayer exports [ID]

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

USAGE
  $ commercelayer exports [ID] [-A | -l <value>] [-t
    addresses|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orders|payment_methods|price_tiers|
    prices|shipments|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|tax_cate
    gories|transactions|authorizations|captures|voids|refunds] [-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|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orde
                         rs|payment_methods|price_tiers|prices|shipments|shipping_categories|shipping_methods|sku_lists|
                         sku_list_items|sku_options|skus|stock_items|tax_categories|transactions|authorizations|captures
                         |voids|refunds>

DESCRIPTION
  list all the created exports or show details of a single export

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

commercelayer exports:all

Export all the records.

USAGE
  $ commercelayer exports:all -t
    addresses|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orders|payment_methods|price_tiers|
    prices|shipments|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|tax_cate
    gories|transactions|authorizations|captures|voids|refunds [-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|bundles|coupons|customer_subscriptions|...  (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_end=@test.org -X <output-file-path>

  $ cl export -t skus -w code_start=SHIRT -X <output-file-path> --csv

See code: src/commands/exports/all.ts

commercelayer exports:create

Create a new export.

USAGE
  $ commercelayer exports:create -t
    addresses|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orders|payment_methods|price_tiers|
    prices|shipments|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|tax_cate
    gories|transactions|authorizations|captures|voids|refunds [-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|bundles|coupons|customer_subscriptions|...  (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_end=@test.org -X <output-file-path> --csv

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

commercelayer exports:details ID

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

commercelayer exports:group GROUP_ID

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

commercelayer exports:list

List all the created exports.

USAGE
  $ commercelayer exports:list [-A | -l <value>] [-t
    addresses|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orders|payment_methods|price_tiers|
    prices|shipments|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|tax_cate
    gories|transactions|authorizations|captures|voids|refunds] [-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|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orde
                         rs|payment_methods|price_tiers|prices|shipments|shipping_categories|shipping_methods|sku_lists|
                         sku_list_items|sku_options|skus|stock_items|tax_categories|transactions|authorizations|captures
                         |voids|refunds>

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

commercelayer exports:types

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

Changelog

3.0.0-oclif3.1 (2024-02-13)

Performance Improvements

• upgrade to oclif 3 (a27aa54)

BREAKING CHANGES

• the framework oclif and its plugins have been migrated to next major version