external-platform

Shopify App Status

Return the App Home status for the session token's shop.

Always 200 for a valid token. Unbound shops yield bound=false with the shop domain still populated; every profile-related field is null.

get/api/external-platform/shopify/app/status

Request

  • Base URL: https://api.usepomo.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.usepomo.ai/api/external-platform/shopify/app/status
  • Auth: none declared

Query parameters

force_refreshboolean

Re-read Shopify billing authority

Response

Successful Response

boundboolean required

Whether the shop is bound to an active Pomo profile

shop_domainstring nullable

The shop's myshopify.com domain from the session token

shop_namestring nullable

Human-readable shop name, if known

company_profile_idstring nullable

Bound company profile id (string UUID, sanitized)

company_profile_namestring nullable

Bound company profile name

connection_healthstring nullable

'healthy' | 'warning' | 'critical' | 'unknown' | null

initial_sync_statusstring nullable

'not_started' | 'pending' | 'running' | 'completed' | 'failed' | 'skipped' | null

last_sync_atstring date-time nullable

Matching successful catalog extraction job finalized_at, only with saved Shopify result provenance

onboarding_completeboolean

Whether the bound profile has finished onboarding

setup_status'unknown' | 'pending' | 'running' | 'needs_attention' | 'failed' | 'completed'

Whole setup state, independent of catalog extraction

setup_stage'catalog' | 'products' | 'competitors' | 'research' | 'complete' nullable

Persisted setup stage requiring progress or attention

setup_attentionstring nullable

Fixed public-safe recovery guidance; never raw workflow errors

shopify_products_importedinteger nullable

Distinct Shopify product IDs in the matching shop-qualified saved extraction; null when provenance is unavailable

active_product_offeringsinteger nullable

Active Pomo product offerings in the bound profile, including manual products

product_limitinteger nullable

Current effective Shopify product allowance; null when entitlement is unavailable

catalog_retry_allowedboolean

Whether failed initial extraction can be retried under the existing onboarding dispatch guards

catalog_import_cappedboolean nullable

Whether saved evidence proves truncation; null when unknown, never inferred from count equal to allowance

billing_statusstring

none | trialing | active | unknown | verification_unavailable | unbound

entitledboolean

Whether Shopify currently grants product access

plan_handlestring nullable

Active Shopify App Pricing plan handle

plan_namestring nullable

Public name of the active supported plan

billing_intervalstring nullable

monthly | annual

cancel_at_period_endboolean

Whether cancellation is scheduled

trial_ends_atstring date-time nullable

Shopify trial end, if active

current_period_ends_atstring date-time nullable

Current billing-cycle end

pricing_urlstring required

Shopify-owned plan selection URL

pomo_urlstring required

Deep-link into the full Pomo app

Changes

No recorded changes to this operation across all 1 revision of this API.