> ## Documentation Index > Fetch the complete documentation index at: https://andcze.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get the public shop profile > Name, logo, currency, languages, servers (with online status), links, theme, legal documents (with `legal.version` for checkout consent) and `publicData` flags. ## OpenAPI ````yaml /openapi.en.json get /api/v2/storefront/v1/shops/{shopId} openapi: 3.0.0 info: title: ItemShop v2 API description: >- REST API platformy ItemShop v2 (NestJS + Fastify). Wszystkie ścieżki mają prefiks /api/v2. version: 2.0.0 contact: {} servers: - url: https://itemshop.dev description: Production (API under /api/v2, same origin as the panel) - url: http://localhost:3000 description: Local security: [] tags: [] paths: /api/v2/storefront/v1/shops/{shopId}: get: tags: - Storefront v1 summary: Get the public shop profile description: >- Name, logo, currency, languages, servers (with online status), links, theme, legal documents (with `legal.version` for checkout consent) and `publicData` flags. operationId: getShop parameters: - name: shopId required: true in: path description: >- Shop ID (ObjectId). Also accepts the `uniqueName`, an active custom domain or `.`. schema: type: string example: 664f1a2b3c4d5e6f7a8b9c0d responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/StorefrontShopResponseDto' '403': description: Origin outside the shop domains (`ORIGIN_NOT_ALLOWED`) content: application/json: schema: $ref: '#/components/schemas/StorefrontErrorDto' '404': description: >- Shop/resource not found or the shop is blocked (`SHOP_NOT_FOUND`, `PRODUCT_NOT_FOUND`, `ORDER_NOT_FOUND`) content: application/json: schema: $ref: '#/components/schemas/StorefrontErrorDto' '429': description: Rate limit exceeded (`RATE_LIMITED`) content: application/json: schema: $ref: '#/components/schemas/StorefrontErrorDto' components: schemas: StorefrontShopResponseDto: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/StorefrontShopDto' required: - success - data StorefrontErrorDto: type: object properties: success: type: boolean example: false statusCode: type: number example: 404 code: enum: - VALIDATION_FAILED - BAD_REQUEST - NOT_FOUND - SHOP_NOT_FOUND - PRODUCT_NOT_FOUND - ORDER_NOT_FOUND - PRODUCT_UNAVAILABLE - PRODUCT_VARIANT_REQUIRED - INVALID_PRODUCT_VARIANT - INVALID_QUANTITY - OUT_OF_STOCK - CART_EMPTY - NICK_REQUIRED - EMAIL_REQUIRED - CART_TOO_LARGE - DISCOUNT_INVALID - LEGAL_CONSENT_REQUIRED - LEGAL_DOCUMENTS_CHANGED - SHOP_PAYMENT_NOT_READY - PAYMENT_INIT_FAILED - ORDER_BLOCKED - RETURN_URL_NOT_ALLOWED - VOUCHER_NOT_FOUND - VOUCHER_USED - VOUCHER_EXPIRED - IDEMPOTENCY_KEY_REQUIRED - IDEMPOTENCY_KEY_REUSED - CHECKOUT_ATTEMPT_CLOSED - CHECKOUT_IN_PROGRESS - CAPTCHA_REQUIRED - ORIGIN_NOT_ALLOWED - FORBIDDEN - UNAUTHORIZED - PAYLOAD_TOO_LARGE - CONFLICT - RATE_LIMITED - SERVICE_UNAVAILABLE - INTERNAL_ERROR type: string description: Machine-readable error code — translate UI messages by this example: SHOP_NOT_FOUND message: type: string description: >- Developer message (language not guaranteed; do not show it to buyers) example: Shop not found error: type: string description: Same as `message` (compatibility with the rest of the API) example: Shop not found deprecated: true details: type: object description: Validation details timestamp: type: string format: date-time example: '2026-10-27T12:00:00.000Z' path: type: string example: /api/v2/storefront/v1/shops/moj-sklep required: - success - statusCode - code - message - error - timestamp - path StorefrontShopDto: type: object properties: id: type: string example: 664f1a2b3c4d5e6f7a8b9c0d uniqueName: type: string example: moj-sklep kind: enum: - game - general type: string description: >- `game` — player nick required at checkout; `general` — nick optional, then email is required example: game displayName: type: string example: Mój Sklep description: type: string nullable: true example: Najlepszy serwer survival w Polsce. logoUrl: type: string nullable: true example: https://cdn.itemshop.pl/u/logo.png currency: type: string description: Price currency (ISO 4217) example: PLN languages: description: Shop languages; the first one is the default example: - pl - en type: array items: type: string defaultLanguage: type: string example: pl plan: enum: - free - pro type: string example: pro poweredByRequired: type: boolean description: The Free plan requires a visible “Powered by ItemShop” example: false domains: $ref: '#/components/schemas/StorefrontDomainsDto' serverIp: type: string nullable: true example: play.moj-sklep.pl discordInviteUrl: type: string nullable: true example: https://discord.gg/abc announcement: type: string nullable: true example: Promocja -20% do niedzieli! socials: $ref: '#/components/schemas/StorefrontSocialsDto' links: type: array items: $ref: '#/components/schemas/StorefrontLinkDto' theme: $ref: '#/components/schemas/StorefrontThemeDto' administration: type: array items: $ref: '#/components/schemas/StorefrontAdministratorDto' servers: type: array items: $ref: '#/components/schemas/StorefrontServerDto' legal: $ref: '#/components/schemas/StorefrontLegalDto' publicData: description: Which widgets the owner made public; disabled ones return empty data allOf: - $ref: '#/components/schemas/StorefrontPublicDataDto' required: - id - uniqueName - kind - displayName - description - logoUrl - currency - languages - defaultLanguage - plan - poweredByRequired - domains - serverIp - discordInviteUrl - announcement - socials - links - theme - administration - servers - legal - publicData StorefrontDomainsDto: type: object properties: primaryUrl: type: string description: Canonical shop site URL example: https://moj-sklep.pl customDomain: type: string nullable: true description: Active custom domain example: moj-sklep.pl subdomain: type: string nullable: true description: Platform hosting subdomain example: moj-sklep.itemshop.site required: - primaryUrl - customDomain - subdomain StorefrontSocialsDto: type: object properties: discord: type: string nullable: true example: https://discord.gg/abc tiktok: type: string nullable: true example: null facebook: type: string nullable: true example: null youtube: type: string nullable: true example: https://youtube.com/@mojsklep instagram: type: string nullable: true example: null required: - discord - tiktok - facebook - youtube - instagram StorefrontLinkDto: type: object properties: label: type: string example: Regulamin serwera url: type: string example: https://moj-sklep.pl/zasady newTab: type: boolean example: false required: - label - url - newTab StorefrontThemeDto: type: object properties: brandColor: type: string nullable: true example: '#7c3aed' accentColor: type: string nullable: true example: '#f59e0b' fontFamily: type: string nullable: true description: '`google:` or a system font name' example: google:Bricolage Grotesque required: - brandColor - accentColor - fontFamily StorefrontAdministratorDto: type: object properties: nickname: type: string example: Notch role: type: string example: Właściciel required: - nickname - role StorefrontServerDto: type: object properties: id: type: string example: 664f1a2b3c4d5e6f7a8b9c0d name: type: string example: Survival domain: type: string nullable: true example: play.moj-sklep.pl description: type: string nullable: true example: Klasyczny survival 1.21 minecraftVersion: type: string nullable: true example: 1.21.4 isOnline: type: boolean description: The plugin reported within the last 5 minutes example: true playersOnline: type: number description: 0 when the server is offline example: 42 maxPlayers: type: number example: 200 required: - id - name - domain - description - minecraftVersion - isOnline - playersOnline - maxPlayers StorefrontLegalDto: type: object properties: termsUrl: type: string nullable: true description: Platform-hosted terms page (link next to the consent) example: https://itemshop.pl/s/moj-sklep/regulamin privacyUrl: type: string nullable: true description: Platform-hosted privacy policy page example: https://itemshop.pl/s/moj-sklep/polityka-prywatnosci termsHtml: type: string nullable: true description: Seller terms (sanitized HTML) example:

Regulamin

…

privacyHtml: type: string nullable: true description: Privacy policy (sanitized HTML) example: null companyInfo: type: string nullable: true example: Jan Kowalski, NIP 0000000000 version: type: string description: >- SHA-256 of the shown documents — send back as `consents.legalVersion` at checkout example: a3f1c2…000000000000000000000000000000000000000000000000000000000 required: - termsUrl - privacyUrl - termsHtml - privacyHtml - companyInfo - version StorefrontPublicDataDto: type: object properties: recentPurchases: type: boolean example: true topSpenders: type: boolean example: true monthlyGoal: type: boolean example: true onlinePlayers: type: boolean example: true required: - recentPurchases - topSpenders - monthlyGoal - onlinePlayers ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.