Skip to content

commercelayer/commercelayer-cli-plugin-checkout

Repository files navigation

@commercelayer/cli-plugin-checkout

Commerce Layer CLI Checkout plugin

oclif Version Downloads/week License

Usage

commercelayer COMMAND

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

To install as a Commerce Layer CLI plugin run the following command:

$ commercelayer plugins:install checkout

Commands

commercelayer checkout

Create checkout URLs.

USAGE
  $ commercelayer checkout (-a <value> ) [--open] [-m <value> | [-O <value> | -S <value> | -B <value>]] [-c
    <value> | ] [-e <value> | ]

FLAGS
  -B, --bundle=<value>...    a bundle code
  -O, --order=<value>        an order id
  -S, --sku=<value>...       an SKU code
  -a, --accessToken=<value>  (required) custom access token to use instead of the one used for login
  -c, --coupon=<value>       a promo code
  -e, --email=<value>        a customer email
  -m, --market=<value>       a market number
  --open                     open checkout URL in default browser

DESCRIPTION
  create checkout URLs

EXAMPLES
  $ commercelayer checkout -O <order-id>

  $ cl checkout -S <sku-code> -m <market-id> -c <coupon-code> -e <email-address>

  $ cl checkout -S <sku-code-1> -S <sku-code-2> -m <market-id>

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

commercelayer checkout:order ID

Create checkout URLs starting from an existing order.

USAGE
  $ commercelayer checkout:order ID (-a <value> ) [--open]

ARGUMENTS
  ID  unique id of the order

FLAGS
  -a, --accessToken=<value>  (required) custom access token to use instead of the one used for login
  --open                     open checkout URL in default browser

DESCRIPTION
  create checkout URLs starting from an existing order

EXAMPLES
  $ commercelayer checkout:order <order-id>

See code: src/commands/checkout/order.ts