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

# Create a category

> Adds a category, with the products that go in it. A store holds up to 150.

Needs the `categories.write` permission (Change Categories).



## OpenAPI

````yaml /api-reference/openapi.json post /stores/{storeId}/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}/categories:
    post:
      tags:
        - Categories
      summary: Create a category
      description: >-
        Adds a category, with the products that go in it. A store holds up to
        150.


        Needs the `categories.write` permission (Change Categories).
      operationId: categories.create
      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
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The category's name.
                  example: Software
                slug:
                  type: string
                  description: >-
                    The last part of its address on the storefront. Left out, it
                    is made from the name.
                description:
                  type: string
                  description: What the category's page says under its name.
                visibility:
                  type: string
                  description: >-
                    `public` is listed on the storefront. `unlisted` is reached
                    by its link. `private` is not shown.
                  enum:
                    - public
                    - unlisted
                    - private
                  default: public
                isPopular:
                  type: boolean
                  description: Whether themes that feature a category may feature this one.
                  default: false
                productIds:
                  type: array
                  description: The products in it, in the order the category lists them.
                  items:
                    type: string
                seoTitle:
                  type: string
                  description: >-
                    The category's own title in search results, up to 70
                    characters. Empty is its name.
                seoDescription:
                  type: string
                  description: >-
                    Its own description in search results, up to 200 characters.
                    Empty is its description.
              required:
                - name
      responses:
        '201':
          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
                      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
                          - object
                      productCount:
                        type: integer
                      dateCreated:
                        type: string
                      updatedAt:
                        type: string
              example:
                success: true
                message: null
                code: null
                data:
                  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: []
                  productCount: 0
                  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'
        '422':
          $ref: '#/components/responses/Refused'
        '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.categories.create({
              name: "Software",
            });
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

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

            $result = $shoply->categories->create([
                'name' => 'Software',
            ]);
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.categories.create(name="Software")
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        A word of your own for this one change, up to 180 letters, digits, dots,
        dashes, underscores and colons. Sent again with the same key, the
        request is not carried out twice: the first answer comes back, with
        `Idempotent-Replay: true`.
      schema:
        type: string
  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'
    Refused:
      description: >-
        The request was understood and not carried out. `validation_failed` says
        what is wrong with each field under `errors`; other codes are the
        route's own.
      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.