Commerce
The `hanzo commerce` commands.
Also for this capability: API · CLI · MCP · SDKs
Selling: checkout, subscriptions, invoices, spend alerts, payment webhooks and the storefront catalog.
hanzo commerce note listEvery command takes --json for the raw response and --help for its own flags. Sign in once with hanzo auth login; the commands below use that session, and the org they act in is the one it carries.
| Command | What it does |
|---|---|
hanzo commerce currencies | The reference currency list the price and settings pickers render |
hanzo commerce deposits | Read the crypto deposit watcher's runtime state, asset by asset |
hanzo commerce health | Answers ok whenever the commerce subsystem is mounted. |
hanzo commerce org | The public org configuration a checkout page boots from |
cart
| Command | What it does |
|---|---|
hanzo commerce cart create | Open a cart for a shopper to fill |
hanzo commerce cart discard <id> | Discard a cart the shopper abandoned |
hanzo commerce cart get <id> | Read one cart with its lines and totals |
hanzo commerce cart item <id> | Set one item's quantity in a cart; zero removes it |
catalog
| Command | What it does |
|---|---|
hanzo commerce catalog entries create | Add a catalog entry |
hanzo commerce catalog entries get | The raw catalog entries, including the unpublished ones |
hanzo commerce catalog get | The public product catalog projection for a brand |
hanzo commerce catalog models create | Land a syncer's view of the model catalog: upstream costs and machine facts |
hanzo commerce catalog models refresh | Refresh the model catalog by reading the upstream provider |
hanzo commerce catalog seed | Seed the embedded catalog, without disturbing edits already made |
collection
| Command | What it does |
|---|---|
hanzo commerce collection create | Create a collection |
hanzo commerce collection get <collectionid> | Fetch one collection |
hanzo commerce collection list | List your org's collections, as a page |
hanzo commerce collection rm <collectionid> | Delete a collection, keeping a recoverable copy |
hanzo commerce collection set <collectionid> | Replace a collection outright |
hanzo commerce collection update <collectionid> | Change part of a collection |
disclosure
| Command | What it does |
|---|---|
hanzo commerce disclosure create | Create a disclosure |
hanzo commerce disclosure get <disclosureid> | Fetch one disclosure |
hanzo commerce disclosure list | List your org's disclosures, as a page |
hanzo commerce disclosure rm <disclosureid> | Delete a disclosure, keeping a recoverable copy |
hanzo commerce disclosure set <disclosureid> | Replace a disclosure outright |
hanzo commerce disclosure update <disclosureid> | Change part of a disclosure |
discount
| Command | What it does |
|---|---|
hanzo commerce discount create | Create a discount |
hanzo commerce discount get <discountid> | Fetch one discount |
hanzo commerce discount list | List your org's discounts, as a page |
hanzo commerce discount rm <discountid> | Delete a discount, keeping a recoverable copy |
hanzo commerce discount set <discountid> | Replace a discount outright |
hanzo commerce discount update <discountid> | Change part of a discount |
movie
| Command | What it does |
|---|---|
hanzo commerce movie create | Create a movie |
hanzo commerce movie get <movieid> | Fetch one movie |
hanzo commerce movie list | List your org's movies, as a page |
hanzo commerce movie rm <movieid> | Delete a movie, keeping a recoverable copy |
hanzo commerce movie set <movieid> | Replace a movie outright |
hanzo commerce movie update <movieid> | Change part of a movie |
note
| Command | What it does |
|---|---|
hanzo commerce note create | Create a note |
hanzo commerce note get <noteid> | Fetch one note |
hanzo commerce note list | List your org's notes, as a page |
hanzo commerce note rm <noteid> | Delete a note, keeping a recoverable copy |
hanzo commerce note set <noteid> | Replace a note outright |
hanzo commerce note update <noteid> | Change part of a note |
payments
| Command | What it does |
|---|---|
hanzo commerce payments create | Take a card payment and credit the org's balance |
hanzo commerce payments get <id> | Read one settled payment by its id |
plans
| Command | What it does |
|---|---|
hanzo commerce plans entries create | Add a subscription plan |
hanzo commerce plans entries list | The raw plan authority rows |
hanzo commerce plans entries rm <slug> | Remove a plan from the authority |
hanzo commerce plans entries set <slug> | Edit a plan, leaving the fields you omit alone |
hanzo commerce plans seed | Seed the embedded plan catalog, without overwriting administrative edits |
product
| Command | What it does |
|---|---|
hanzo commerce product create | Create a product |
hanzo commerce product get <productid> | Fetch one product |
hanzo commerce product list | List your org's products, as a page |
hanzo commerce product rm <productid> | Delete a product, keeping a recoverable copy |
hanzo commerce product set <productid> | Replace a product outright |
hanzo commerce product update <productid> | Change part of a product |
rates
| Command | What it does |
|---|---|
hanzo commerce rates entries create | Add a rate |
hanzo commerce rates entries list | List what one unit of each metered thing costs |
hanzo commerce rates entries product rm <product> <meter> | Remove a rate outright |
hanzo commerce rates entries product set <product> <meter> | Edit a rate, and mark it as operator-set |
hanzo commerce rates import | Load the published price document, reconciling rather than replacing |
return
| Command | What it does |
|---|---|
hanzo commerce return create | Create a return |
hanzo commerce return get <returnid> | Fetch one return |
hanzo commerce return list | List your org's returns, as a page |
hanzo commerce return rm <returnid> | Delete a return, keeping a recoverable copy |
hanzo commerce return set <returnid> | Replace a return outright |
hanzo commerce return update <returnid> | Change part of a return |
saleschannel
| Command | What it does |
|---|---|
hanzo commerce saleschannel create | Create a sales channel |
hanzo commerce saleschannel get <saleschannelid> | Fetch one sales channel |
hanzo commerce saleschannel list | List your org's sales channels, as a page |
hanzo commerce saleschannel rm <saleschannelid> | Delete a sales channel, keeping a recoverable copy |
hanzo commerce saleschannel set <saleschannelid> | Replace a sales channel outright |
hanzo commerce saleschannel update <saleschannelid> | Change part of a sales channel |
stocklocation
| Command | What it does |
|---|---|
hanzo commerce stocklocation create | Create a stock location |
hanzo commerce stocklocation get <stocklocationid> | Fetch one stock location |
hanzo commerce stocklocation list | List your org's stock locations, as a page |
hanzo commerce stocklocation rm <stocklocationid> | Delete a stock location, keeping a recoverable copy |
hanzo commerce stocklocation set <stocklocationid> | Replace a stock location outright |
hanzo commerce stocklocation update <stocklocationid> | Change part of a stock location |
store
| Command | What it does |
|---|---|
hanzo commerce store access | Whether a store is entitled to trade, and why |
hanzo commerce store authorize add <storeid> <orderid> | Authorize an order that already exists, holding the funds without settling them |
hanzo commerce store authorize create <storeid> | Authorize a new order against a storefront, holding the funds without settling them |
hanzo commerce store bundle get <storeid> <key> | Fetch a bundle as this storefront sells it |
hanzo commerce store capture add <storeid> <orderid> | Capture a previously authorized order and settle the payment |
hanzo commerce store charge <storeid> | Authorize and capture a new order in one call |
hanzo commerce store checkout authorize add <storeid> <orderid> | Authorize an existing order, holding the funds — the checkout spelling |
hanzo commerce store checkout authorize create <storeid> | Authorize a new order against a storefront, holding the funds — the checkout spelling |
hanzo commerce store checkout capture add <storeid> <orderid> | Capture a previously authorized order and settle it — the checkout spelling |
hanzo commerce store checkout charge <storeid> | Authorize and capture a new order in one call — the checkout spelling |
hanzo commerce store checkout paypal cancel add <storeid> <payKey> | PayPal cancel by pay key — refuses, exactly as the unprefixed address does |
hanzo commerce store checkout paypal confirm add <storeid> <payKey> | PayPal confirm by pay key — refuses, exactly as the unprefixed address does |
hanzo commerce store checkout paypal pay <storeid> | Start a PayPal authorization for a new order — the checkout spelling |
hanzo commerce store create | Create a storefront |
hanzo commerce store current | Resolve your org's active storefront without naming an id |
hanzo commerce store get <storeid> | Fetch one storefront |
hanzo commerce store list | List your org's storefronts as a page |
hanzo commerce store listing add <storeid> <key> | Add a listing override under a new key |
hanzo commerce store listing get <storeid> <key> | Fetch one listing override, by item id or by its slug or SKU |
hanzo commerce store listing list <storeid> | The storefront's whole listing override map |
hanzo commerce store listing rm <storeid> <key> | Remove a listing override |
hanzo commerce store listing set <storeid> <key> | Upsert a listing override |
hanzo commerce store listing update <storeid> <key> | Confirm a listing override exists and re-save the store |
hanzo commerce store paypal cancel add <storeid> <payKey> | PayPal cancel by pay key — refuses, because a pay key alone does not identify the order |
hanzo commerce store paypal confirm add <storeid> <payKey> | PayPal confirm by pay key — refuses, because a pay key alone does not identify the order |
hanzo commerce store paypal pay <storeid> | Start a PayPal authorization for a new order |
hanzo commerce store product get <storeid> <key> | Fetch a product as this storefront sells it |
hanzo commerce store rm <storeid> | Delete a storefront, keeping a recoverable copy |
hanzo commerce store set <storeid> | Replace a storefront outright |
hanzo commerce store token | Mint your org's least-privilege storefront read key |
hanzo commerce store trial <storeid> | Start this store's no-card trial on the entry plan |
hanzo commerce store update <storeid> | Change part of a storefront |
hanzo commerce store variant get <storeid> <key> | Fetch a variant as this storefront sells it |
submission
| Command | What it does |
|---|---|
hanzo commerce submission create | Create a submission |
hanzo commerce submission get <submissionid> | Fetch one submission |
hanzo commerce submission list | List your org's submissions, as a page |
hanzo commerce submission rm <submissionid> | Delete a submission, keeping a recoverable copy |
hanzo commerce submission set <submissionid> | Replace a submission outright |
hanzo commerce submission update <submissionid> | Change part of a submission |
subscriber
| Command | What it does |
|---|---|
hanzo commerce subscriber create | Create a subscriber |
hanzo commerce subscriber get <subscriberid> | Fetch one subscriber |
hanzo commerce subscriber list | List your org's subscribers, as a page |
hanzo commerce subscriber rm <subscriberid> | Delete a subscriber, keeping a recoverable copy |
hanzo commerce subscriber set <subscriberid> | Replace a subscriber outright |
hanzo commerce subscriber update <subscriberid> | Change part of a subscriber |
tokentransaction
| Command | What it does |
|---|---|
hanzo commerce tokentransaction create | Create a token transaction |
hanzo commerce tokentransaction get <tokentransactionid> | Fetch one token transaction |
hanzo commerce tokentransaction list | List your org's token transactions, as a page |
hanzo commerce tokentransaction rm <tokentransactionid> | Delete a token transaction, keeping a recoverable copy |
hanzo commerce tokentransaction set <tokentransactionid> | Replace a token transaction outright |
hanzo commerce tokentransaction update <tokentransactionid> | Change part of a token transaction |
transfer
| Command | What it does |
|---|---|
hanzo commerce transfer create | Create a transfer |
hanzo commerce transfer get <transferid> | Fetch one transfer |
hanzo commerce transfer list | List your org's transfers, as a page |
hanzo commerce transfer rm <transferid> | Delete a transfer, keeping a recoverable copy |
hanzo commerce transfer set <transferid> | Replace a transfer outright |
hanzo commerce transfer update <transferid> | Change part of a transfer |
variant
| Command | What it does |
|---|---|
hanzo commerce variant create | Create a variant |
hanzo commerce variant get <variantid> | Fetch one variant |
hanzo commerce variant list | List your org's variants, as a page |
hanzo commerce variant rm <variantid> | Delete a variant, keeping a recoverable copy |
hanzo commerce variant set <variantid> | Replace a variant outright |
hanzo commerce variant update <variantid> | Change part of a variant |
wallet
| Command | What it does |
|---|---|
hanzo commerce wallet create | Create a wallet |
hanzo commerce wallet get <walletid> | Fetch one wallet |
hanzo commerce wallet list | List your org's wallets, as a page |
hanzo commerce wallet rm <walletid> | Delete a wallet, keeping a recoverable copy |
hanzo commerce wallet set <walletid> | Replace a wallet outright |
hanzo commerce wallet update <walletid> | Change part of a wallet |
watchlist
| Command | What it does |
|---|---|
hanzo commerce watchlist create | Create a watchlist |
hanzo commerce watchlist get <watchlistid> | Fetch one watchlist |
hanzo commerce watchlist list | List your org's watchlists, as a page |
hanzo commerce watchlist rm <watchlistid> | Delete a watchlist, keeping a recoverable copy |
hanzo commerce watchlist set <watchlistid> | Replace a watchlist outright |
hanzo commerce watchlist update <watchlistid> | Change part of a watchlist |
webhook
| Command | What it does |
|---|---|
hanzo commerce webhook create | Create a webhook |
hanzo commerce webhook get <webhookid> | Fetch one webhook |
hanzo commerce webhook list | List your org's webhooks, as a page |
hanzo commerce webhook rm <webhookid> | Delete a webhook, keeping a recoverable copy |
hanzo commerce webhook set <webhookid> | Replace a webhook outright |
hanzo commerce webhook update <webhookid> | Change part of a webhook |
webhooks
| Command | What it does |
|---|---|
hanzo commerce webhooks add <provider> | Payment-provider webhook intake for settlement and subscription lifecycle events |
How is this guide?