---
title: "A shop with its settings and today's counts"
method: GET
path: "/shops/{shopId}"
tags: ["Shops"]
---

# A shop with its settings and today's counts

`GET /shops/{shopId}`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/shops/{shopId}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Path parameters

- `shopId` string, uuid, required

## Response `200`

The shop

- object
  - `id` string, uuid, required
  - `key` string, required: The public key the site's storefront calls use
  - `projectId` string, uuid, required
  - `sessionId` string, uuid, nullable, required
  - `status` 'active' | 'closed', required
  - `name` string, required
  - `currency` string, required
  - `country` string, required
  - `pricesIncludeVat` boolean, required
  - `vatNumber` string, nullable, required
  - `orgNumber` string, nullable, required
  - `oss` boolean, required
  - `storeEmail` string, nullable, required
  - `orderPrefix` string, required
  - `sellerAddress` string, nullable, required
  - `language` string, required
  - `lowStockThreshold` integer, required
  - `unpaidCancelDays` integer, required
  - `manualPayments` object, required
    - `bankTransfer` object
      - `enabled` boolean, required
      - `instructions` string
    - `swish` object
      - `enabled` boolean, required
      - `number` string
    - `pickup` object
      - `enabled` boolean, required
      - `instructions` string
    - `invoice` object
      - `enabled` boolean, required
      - `days` integer
  - `stripeEnabled` boolean, required
  - `stripe` object, required
    - `status` 'off' | 'not_connected' | 'onboarding' | 'restricted' | 'active', required: off: this server has no Stripe keys yet; not_connected; onboarding; restricted: Stripe needs more details; active
    - `accountId` string, nullable, required
    - `chargesEnabled` boolean, required
    - `applicationFeeBps` integer, required: Platform fee on Stripe payments (0 = none)
  - `policies` object, required
  - `euDistanceSalesEurCents` integer, required
  - `testPayments` boolean, required: The test gateway is available (test and smoke-test teams only)
  - `counts` object, required
    - `products` integer, required
    - `activeProducts` integer, required
    - `draftProducts` integer, required
    - `unconfirmedPrices` integer, required
    - `lowStock` integer, required
    - `openOrders` integer, required
    - `ordersToday` integer, required
    - `revenueTodayMinor` integer, required: Minor units of the shop currency (öre, cents)
    - `pendingAiChanges` integer, required
  - `storefrontUrl` string, required: Base URL of the public storefront API for this shop
  - `createdAt` string, required: ISO-8601 timestamp
  - `updatedAt` string, required: ISO-8601 timestamp

## Other responses

- `400`: Invalid request (code invalid_request; details.issues)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Refused in this state (code conflict; details.reason: slug_taken, code_taken, order_status, has_orders, …)
- `501`: Not available on this server (code not_configured; details.reason stripe_off when card payments are off)
- `503`: A payment provider is unavailable (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)