Halo CLI Shop

Manage the Halo shop area through the console.api.ecommerce.halo.run/v1alpha1 API.

Prerequisites

The shop API only exists on Halo Pro / Halo Commercial instances with the shop feature enabled.

halo shop doctor --json

Run doctor before a shop workflow. It reports edition, activation, shopApiAvailable, shopApiStatus (available, denied, unavailable, or unknown), per-feature readability, read/write permissions for each shop resource, configuration counts, and actionable warnings.

Use shopApiStatus rather than the boolean alone: denied means the API exists but the current profile lacks permission, while unavailable means the instance does not expose the shop API. A features entry is true only when the current profile can read that resource; use warnings to distinguish PERMISSION_DENIED from RESOURCE_UNAVAILABLE. If a warning uses PERMISSION_DENIED, PERMISSIONS_UNAVAILABLE, or READ_ONLY_ACCESS, adjust the profile or token instead of retrying.

halo shop status --json is a lighter check that only reports edition, activation, and API availability.

All commands accept --profile <name> and --json. Prefer --json for agent workflows.