> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Get the store > The store's details and settings: its name and address, currency, branding, links, policies, what its storefront shows, and its business details. Needs the `store.read` permission (Read Store). ## OpenAPI ````yaml /api-reference/openapi.json get /stores/{storeId} openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}: get: tags: - Store summary: Get the store description: >- The store's details and settings: its name and address, currency, branding, links, policies, what its storefront shows, and its business details. Needs the `store.read` permission (Read Store). operationId: store.show parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: object properties: id: type: string name: type: string slug: type: string urlChangeableAt: nullable: true supportUrl: type: string guideUrl: type: string panelUrl: type: string socialLinks: type: object properties: discord: type: string youtube: type: string tiktok: type: string x: type: string instagram: type: string telegram: type: string customLinks: type: - array - object description: type: string currencyCode: type: string adaptivePricing: type: boolean currencies: type: array items: type: object properties: code: type: string name: type: string ratesFetchedAt: type: string locale: type: string logoUrl: nullable: true faviconUrl: nullable: true storefrontPassword: type: string storefrontPasswordUnreadable: type: boolean accentColor: type: string theme: type: string publishStock: type: boolean lowStockThreshold: type: integer dashboardCards: type: array items: type: string termsOfService: type: string refundPolicy: type: string autoReviews: type: boolean publicStats: type: boolean saleNotifications: type: boolean publicOnline: type: boolean active: type: boolean blocked: nullable: true businessType: type: string businessName: type: string businessTaxId: type: string businessVatNumber: type: string businessLine1: type: string businessLine2: type: string businessCity: type: string businessRegion: type: string businessPostalCode: type: string businessCountry: type: string invoiceFooter: type: string originCountry: type: string hasDynamicSecret: type: boolean dynamicSecretEnd: type: string updatedAt: type: string settingsVersion: type: string example: success: true message: null code: null data: id: 743d82fb-6aad-44bb-ab00-d54c4b0eecb7 name: Northwind Keys slug: northwind urlChangeableAt: null supportUrl: '' guideUrl: '' panelUrl: '' socialLinks: discord: '' youtube: '' tiktok: '' x: '' instagram: '' telegram: '' customLinks: [] description: Software licences, delivered at once. currencyCode: USD adaptivePricing: false currencies: - code: AED name: UAE dirham - code: ARS name: Argentine peso ratesFetchedAt: '2026-09-29T06:00:05Z' locale: en-US logoUrl: null faviconUrl: null storefrontPassword: '' storefrontPasswordUnreadable: false accentColor: '#4f8ef7' theme: simplistic publishStock: true lowStockThreshold: 5 dashboardCards: - conversion - status termsOfService: '' refundPolicy: '' autoReviews: true publicStats: false saleNotifications: false publicOnline: true active: true blocked: null businessType: '' businessName: Northwind Keys Ltd businessTaxId: '' businessVatNumber: '' businessLine1: '' businessLine2: '' businessCity: '' businessRegion: '' businessPostalCode: '' businessCountry: DE invoiceFooter: '' originCountry: '' hasDynamicSecret: false dynamicSecretEnd: '' updatedAt: '2026-10-22T16:20:18.454Z' settingsVersion: a1593e9245ecff300c6ad568 '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.store.show(); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->store->show(); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.store.show() components: responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.