Store Details

Get a single store with its account name, location detail, and active subscription. Top-level fields cover store identity. Address, phone, and billing identifiers are nested under company (with city, then state, then country). The active subscription is under active_store_plan including the plan's feature list (with enabled/hard_stop).

Auth: Both (Partner or Account user) — authentication, role-agnostic store/ group. The endpoint gates access by membership: the id must be in (the caller's accessible store ids) or it returns 404 — partners reach any store in their tree, account users only their own.

Rate limit: No rate limit.

Request

Response{ data. } envelope; under it status plus a nested data store object.

  • data.status (string) — success.
  • data.data.id (integer) — store id.
  • data.data.account_name (string) — parent account name.
  • data.data.store_name, store_full_name, storeid, client_location_id (string) — identity.
  • data.data.company_id (integer) — location-account company id.
  • data.data.active_store_plan (object|null) — { id, store_id, plan_id, status, plan_start, plan_end, cancel_subscription_at, plan: { id, plan_name, features: [{ id, plan_id, feature_name, enabled, hard_stop, options }] } }.
  • data.data.company (object) — { id, address, address2, zip, city_id, site_url, company_phone, billing_id, phone, city: { id, name, state_id, state: { id, name, country_id, code, country: { id, name, code } } } }.

Path params

ParameterTypeRequiredNotes
storeIdintegerRequiredDigits only.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json