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

# List coupon categories

> The categories the store files its coupons in, in the store's own order, each with how many coupons it holds. Two are the store's from the start and cannot be renamed or deleted: Default, and First Timer, which holds the codes the first-order reward makes.

Needs the `coupons.read` permission (Read Coupons).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/coupon-categories
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}/coupon-categories:
    get:
      tags:
        - Coupon categories
      summary: List coupon categories
      description: >-
        The categories the store files its coupons in, in the store's own order,
        each with how many coupons it holds. Two are the store's from the start
        and cannot be renamed or deleted: Default, and First Timer, which holds
        the codes the first-order reward makes.


        Needs the `coupons.read` permission (Read Coupons).
      operationId: couponCategories.list
      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: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        storeId:
                          type: string
                        name:
                          type: string
                        slug:
                          type: string
                        description:
                          type: string
                        sort:
                          type: integer
                        systemKey:
                          type: string
                        couponCount:
                          type: integer
                        activeCount:
                          type: integer
                        uses:
                          type: integer
                        discountGiven:
                          type: integer
                        dateCreated:
                          type: string
                        updatedAt:
                          type: string
              example:
                success: true
                message: null
                code: null
                data:
                  - id: 406d63ce-4ba1-487b-9e7e-05cfc9f03b18
                    storeId: 743d82fb-6aad-44bb-ab00-d54c4b0eecb7
                    name: Default
                    slug: default
                    description: Coupons without another category.
                    sort: 0
                    systemKey: default
                    couponCount: 0
                    activeCount: 0
                    uses: 0
                    discountGiven: 0
                    dateCreated: '2026-10-22T16:20:18Z'
                    updatedAt: '2026-10-22T16:20:18.796Z'
                  - id: 62fc3f0e-0160-47f3-9ba0-b02592d4590f
                    storeId: 743d82fb-6aad-44bb-ab00-d54c4b0eecb7
                    name: Partners
                    slug: partners
                    description: Codes handed to partners.
                    sort: 0
                    systemKey: ''
                    couponCount: 1
                    activeCount: 1
                    uses: 0
                    discountGiven: 0
                    dateCreated: '2026-10-22T16:20:18Z'
                    updatedAt: '2026-10-22T16:20:18.770Z'
        '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.couponCategories.list();
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

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

            $result = $shoply->couponCategories->list();
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.couponCategories.list()
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.