Store Details

Overview

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).

Prerequisites

A bearer token. Callable with Partner and Account tokens.
The storeId of the record you are targeting.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

GET /api/v1/store/{storeId}

Authentication

Requires a bearer token in the Authorization: Bearer <bearer-token> header.
Who can call it: Partner and Account tokens.
(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 reach only their own.

Rate limit

No rate limit.

Path parameters

Parameter	Type	Required	Description
`storeId`	integer	Required	Digits only.

Response

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 } } } }.

200 OK · `200`

{
  "data": {
    "status": "success",
    "data": {
      "id": 412,
      "account_name": "Acme Coffee Co",
      "store_name": "Acme Coffee – Downtown",
      "store_full_name": "Acme Coffee – Downtown - DT-001",
      "storeid": "DT-001",
      "client_location_id": "loc_8842",
      "company_id": 1530,
      "active_store_plan": {
        "id": 88,
        "store_id": 412,
        "plan_id": 14,
        "status": 1,
        "plan_start": "2026-06-01",
        "plan_end": "2026-06-30",
        "cancel_subscription_at": null,
        "plan": {
          "id": 14,
          "plan_name": "Growth",
          "features": [
            {
              "id": 301,
              "plan_id": 14,
              "feature_name": "ai_response",
              "enabled": 1,
              "hard_stop": 0,
              "options": [
                {
                  "id": 9001,
                  "feature_value": "AI Response",
                  "plan_feature_id": 301,
                  "feature_key": "title"
                }
              ]
            }
          ]
        }
      },
      "company": {
        "id": 1530,
        "address": "42 Market Street",
        "address2": "Suite 5",
        "zip": "90210",
        "city_id": 77,
        "site_url": "https://acmecoffee.example",
        "company_phone": "3105551234",
        "billing_id": null,
        "phone": "3105551234",
        "city": {
          "id": 77,
          "name": "Beverly Hills",
          "state_id": 5,
          "state": {
            "id": 5,
            "name": "California",
            "country_id": 1,
            "code": "CA",
            "country": {
              "id": 1,
              "name": "United States",
              "code": "US"
            }
          }
        }
      }
    }
  }
}

404 Not Found · `404`

{
  "message": "Store not found",
  "status": "error",
  "errors": []
}

Errors

Status	Meaning
`401`	The bearer token is missing, expired or invalid
`404`	Not Found
`500`	Unexpected server error

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/store/123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Updated 9 days ago

Did this page help you?