https://github.com/commercelayer/commercelayer-cli-plugin-checkout
https://github.com/commercelayer/commercelayer-cli-plugin-checkout
commercelayer
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/commercelayer/commercelayer-cli-plugin-checkout
- Owner: commercelayer
- License: mit
- Created: 2021-10-28T07:16:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-03-24T16:14:31.000Z (3 months ago)
- Last Synced: 2026-03-25T13:13:02.192Z (2 months ago)
- Topics: commercelayer
- Language: TypeScript
- Homepage:
- Size: 1.08 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @commercelayer/cli-plugin-checkout
Commerce Layer CLI Checkout plugin
[](https://oclif.io)
[](https://npmjs.org/package/@commercelayer/cli-plugin-checkout)
[](https://npmjs.org/package/@commercelayer/cli-plugin-checkout)
[](https://github.com/commercelayer/commercelayer-cli-plugin-checkout/blob/master/package.json)
* [Usage](#usage)
* [Commands](#commands)
## Usage
```sh-session
commercelayer COMMAND
commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.
```
To install as a Commerce Layer CLI plugin run the following command:
```sh-session
$ commercelayer plugins:install checkout
```
## Commands
* [`commercelayer checkout`](#commercelayer-checkout)
* [`commercelayer checkout:order ID`](#commercelayer-checkoutorder-id)
### `commercelayer checkout`
Create checkout URLs.
```sh-session
USAGE
$ commercelayer checkout (-a ) [--open] [-m | [-O | -S ... | -B ...]]
[-c | ] [-e | ]
FLAGS
-B, --bundle=... a bundle code
-O, --order= an order id
-S, --sku=... an SKU code
-a, --accessToken= (required) custom access token to use instead of the one used for login
-c, --coupon= a promo code
-e, --email= a customer email
-m, --market= a market number
--open open checkout URL in default browser
DESCRIPTION
create checkout URLs
EXAMPLES
$ commercelayer checkout -O
$ cl checkout -S -m -c -e
$ cl checkout -S -S -m
```
_See code: [src/commands/checkout/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-checkout/blob/main/src/commands/checkout/index.ts)_
### `commercelayer checkout:order ID`
Create checkout URLs starting from an existing order.
```sh-session
USAGE
$ commercelayer checkout:order ID (-a ) [--open]
ARGUMENTS
ID unique id of the order
FLAGS
-a, --accessToken= (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
```
_See code: [src/commands/checkout/order.ts](https://github.com/commercelayer/commercelayer-cli-plugin-checkout/blob/main/src/commands/checkout/order.ts)_