Checkout statuses
| Status | Meaning / next action |
|---|---|
queued | Accepted and waiting to start. |
started | Shopstack is working through the merchant checkout. |
help_required | Provide the missing information or use the requested input method. |
approval_required | Review and approve the exact payment total in the trusted interface. |
submitting | The approved order is being submitted. Wait for the result. |
complete | The merchant checkout is complete. |
failed | Checkout ended without success. Read the returned failure. |
cancelled | Checkout 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.
shopstack signupStart personal signup without the interactive prompts.
shopstack signup user --email EMAILStart developer signup without the interactive prompts.
shopstack signup developer --email EMAILResume a pending email-verification flow.
shopstack signup resume SIGNUP_IDDeveloper
Create an independently scoped user and local profile.
shopstack users create --external-id ID --profile NAMEProfile
List the profiles stored on this machine.
shopstack profiles listChoose the profile used by later commands.
shopstack profiles use NAMEPayment
Inspect payment connections for the active profile.
shopstack connect listConnect Link through its trusted browser flow.
shopstack connect linkCheckout
Create a checkout and return control immediately.
shopstack checkout create --file checkout.jsonCreate, follow, and complete a checkout interactively.
shopstack checkout run --file checkout.jsonRead the current checkout state.
shopstack checkout get CHECKOUT_IDCancel a checkout before submission.
shopstack checkout cancel CHECKOUT_IDSecurity & 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.jsonwith mode0600. - 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.