> ## 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 a product

> One product, with everything its editor shows.

Needs the `products.read` permission (Read Products).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/products/{productId}
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}/products/{productId}:
    get:
      tags:
        - Products
      summary: Get a product
      description: |-
        One product, with everything its editor shows.

        Needs the `products.read` permission (Read Products).
      operationId: products.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
        - name: productId
          in: path
          required: true
          description: The product.
          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
                      storeId:
                        type: string
                      name:
                        type: string
                      slug:
                        type: string
                      description:
                        type: string
                      seoTitle:
                        type: string
                      seoDescription:
                        type: string
                      image:
                        type: string
                      imageUrl:
                        nullable: true
                      visibility:
                        type: string
                      sort:
                        type: integer
                      isBestSeller:
                        type: boolean
                      badges:
                        type: array
                        items:
                          type: object
                          properties:
                            label:
                              type: string
                            color:
                              type: string
                            kind:
                              type: string
                      features:
                        type: array
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                            name:
                              type: string
                      deliveryInstructions:
                        type: string
                      blockedPaymentMethods:
                        type:
                          - array
                          - object
                      paymentFees:
                        type:
                          - array
                          - object
                      showViewers:
                        type: boolean
                      showSales:
                        type: boolean
                      salesWindow:
                        type: string
                      saleNotifications:
                        type: boolean
                      metadata:
                        type: string
                      dateCreated:
                        type: string
                      updatedAt:
                        type: string
                      categoryIds:
                        type: array
                        items:
                          type: string
                      unitsSold:
                        type: integer
                      revenue:
                        type: integer
                      lowPrice:
                        type: number
                      highPrice:
                        type: integer
                      totalStock:
                        type: integer
                      untrackedVariants:
                        type: integer
                      imageCount:
                        type: integer
                      images:
                        type:
                          - array
                          - object
                      variants:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            label:
                              type: string
                            price:
                              type: number
                            duration:
                              type: string
                            durationDays:
                              type: integer
                            stockMode:
                              type: integer
                            minQuantity:
                              type: integer
                            maxQuantity:
                              type: integer
                            stock:
                              type: integer
                            keyCount:
                              type: integer
                            deliveryMethods:
                              type: array
                              items:
                                type: string
                            deliveryType:
                              type: string
                            deliveryInstructions:
                              type: string
                            dynamicUrl:
                              type: string
                            customFieldsOn:
                              type: boolean
                            customFields:
                              type:
                                - array
                                - object
                            sort:
                              type: integer
                            blockedPaymentMethods:
                              type:
                                - array
                                - object
                      runningSubscriptions:
                        type: integer
                  meta:
                    type: object
                    properties:
                      categories:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            storeId:
                              type: string
                            name:
                              type: string
                            slug:
                              type: string
                            visibility:
                              type: string
                            isPopular:
                              type: boolean
                            description:
                              type: string
                            seoTitle:
                              type: string
                            seoDescription:
                              type: string
                            image:
                              type: string
                            imageUrl:
                              nullable: true
                            sort:
                              type: integer
                            productIds:
                              type: array
                              items:
                                type: string
                            productCount:
                              type: integer
                            dateCreated:
                              type: string
                            updatedAt:
                              type: string
              example:
                success: true
                message: null
                code: null
                data:
                  id: f463e265-097a-4235-bc2f-5239b19a9874
                  storeId: 743d82fb-6aad-44bb-ab00-d54c4b0eecb7
                  name: Northwind Pro
                  slug: northwind-pro
                  description: A licence for Northwind Pro, sent the moment you pay.
                  seoTitle: ''
                  seoDescription: ''
                  image: ''
                  imageUrl: null
                  visibility: public
                  sort: 0
                  isBestSeller: false
                  badges:
                    - label: New
                      color: green
                      kind: label
                  features:
                    - type: feature
                      name: Lifetime updates
                    - type: category
                      name: Support
                      features:
                        - Email
                        - Discord
                  deliveryInstructions: ''
                  blockedPaymentMethods: []
                  paymentFees: []
                  showViewers: false
                  showSales: false
                  salesWindow: all
                  saleNotifications: false
                  metadata: '{"sku":"NW-PRO"}'
                  dateCreated: '2026-10-22T16:20:18Z'
                  updatedAt: '2026-10-22T16:20:18.000Z'
                  categoryIds:
                    - e31dbb6f-c007-4e28-b0f8-49c4b432cfec
                  unitsSold: 0
                  revenue: 0
                  lowPrice: 9.99
                  highPrice: 79
                  totalStock: 0
                  untrackedVariants: 0
                  imageCount: 0
                  images: []
                  variants:
                    - id: 00e1d395-9ba2-4db3-900a-cb5e2811a2a9
                      label: 1 month
                      price: 9.99
                      duration: 1 month
                      durationDays: 30
                      stockMode: 2
                      minQuantity: 1
                      maxQuantity: -1
                      stock: 0
                      keyCount: 0
                      deliveryMethods:
                        - license_keys
                      deliveryType: license_keys
                      deliveryInstructions: ''
                      dynamicUrl: ''
                      customFieldsOn: false
                      customFields: []
                      sort: 0
                      blockedPaymentMethods: []
                    - id: defa3f9e-8aaf-423d-a0a6-fe65ab8043d4
                      label: 1 year
                      price: 79
                      duration: 1 year
                      durationDays: 365
                      stockMode: 2
                      minQuantity: 1
                      maxQuantity: -1
                      stock: 0
                      keyCount: 0
                      deliveryMethods:
                        - license_keys
                        - instructions
                      deliveryType: license_keys
                      deliveryInstructions: Paste the key under Help, Activate.
                      dynamicUrl: ''
                      customFieldsOn: false
                      customFields: []
                      sort: 1
                      blockedPaymentMethods: []
                  runningSubscriptions: 0
                meta:
                  categories:
                    - id: e31dbb6f-c007-4e28-b0f8-49c4b432cfec
                      storeId: 743d82fb-6aad-44bb-ab00-d54c4b0eecb7
                      name: Software
                      slug: software
                      visibility: public
                      isPopular: false
                      description: Licences for desktop apps.
                      seoTitle: ''
                      seoDescription: ''
                      image: ''
                      imageUrl: null
                      sort: 0
                      productIds:
                        - f463e265-097a-4235-bc2f-5239b19a9874
                      productCount: 1
                      dateCreated: '2026-10-22T16:20:18Z'
                      updatedAt: '2026-10-22T16:20:18.000Z'
        '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.products.show("PRODUCT_ID");
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $result = $shoply->products->show('PRODUCT_ID');
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.products.show("PRODUCT_ID")
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.