SHOPSTACK

Checkout statuses

StatusMeaning / next action
queuedAccepted and waiting to start.
startedShopstack is working through the merchant checkout.
help_requiredProvide the missing information or use the requested input method.
approval_requiredReview and approve the exact payment total in the trusted interface.
submittingThe approved order is being submitted. Wait for the result.
completeThe merchant checkout is complete.
failedCheckout ended without success. Read the returned failure.
cancelledCheckout was stopped.

Read the result

A complete checkout can return result.order_number, confirmation_url, subtotal, shipping, tax, total, and currency. Some merchant facts can be null.

For failed, read failure.code and failure.message. If a request or connection fails, read the existing checkout before you create another one.

Merchant accounts & progress fields

If checkout requires merchant signup, the API or CLI result can include created_account before or after a final state. Treat these credentials as private. MCP removes them from its result.

activity describes current work. Optional intent has a name, phase, and timestamp. Its phases are selected, completed, uncertain, or failed. These are not checkout statuses or proof that an order was placed.

CLI commands

Checkout reference · v0.2.2

Account

Start the guided personal or developer signup flow.

Start the guided personal or developer signup flow.
shopstack signup

Start personal signup without the interactive prompts.

Start personal signup without the interactive prompts.
shopstack signup user --email EMAIL

Start developer signup without the interactive prompts.

Start developer signup without the interactive prompts.
shopstack signup developer --email EMAIL

Resume a pending email-verification flow.

Resume a pending email-verification flow.
shopstack signup resume SIGNUP_ID
Developer

Create an independently scoped user and local profile.

Create an independently scoped user and local profile.
shopstack users create --external-id ID --profile NAME
Profile

List the profiles stored on this machine.

List the profiles stored on this machine.
shopstack profiles list

Choose the profile used by later commands.

Choose the profile used by later commands.
shopstack profiles use NAME
Payment

Inspect payment connections for the active profile.

Inspect payment connections for the active profile.
shopstack connect list

Connect Link through its trusted browser flow.

Connect Link through its trusted browser flow.
shopstack connect link
Checkout

Create a checkout and return control immediately.

Create a checkout and return control immediately.
shopstack checkout create --file checkout.json

Create, follow, and complete a checkout interactively.

Create, follow, and complete a checkout interactively.
shopstack checkout run --file checkout.json

Read the current checkout state.

Read the current checkout state.
shopstack checkout get CHECKOUT_ID

Cancel a checkout before submission.

Cancel a checkout before submission.
shopstack checkout cancel CHECKOUT_ID

Security & approval

  • Verify your email before an account key is issued. The verification page never displays a key.
  • The CLI saves profiles in ~/.config/shopstack/config.json with mode 0600.
  • Keep API keys, signup capabilities, and card details out of prompts, ordinary command arguments, and browser storage.
  • Use a trusted payment interface for protected card input and exact payment approval. MCP cannot perform these steps.
  • Checkout messages can answer questions. They cannot approve a payment.