> ## Documentation Index
> Fetch the complete documentation index at: https://docs.printools.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a garment variant

> Requires the scope garments.write.

Required scopes: `garments.write`.


## OpenAPI

````yaml POST /v1/garment-variants
openapi: 3.1.0
info:
  title: PRINTOOLS API
  version: 1.0.0
  description: >-
    The PRINTOOLS public REST API. This document is generated from the live
    route table and service GraphQL SDL; do not edit it by hand.


    Every 2xx response has {status, message, data}. Every non-2xx response has
    {error, message, status: false}.


    Tenant credential: send X-API-Key only. It is bound to one shop.
    X-PrintTools-Organization-Id is optional for that credential and, if sent,
    must match its shop.


    Partner credential: send X-API-Key, X-API-Secret, Authorization: Bearer
    <Cognito access token>, and X-PrintTools-Organization-Id. The OAuth flow is
    documented at https://app.printools.io/api/index.html#partner-auth.


    Read live limits from GET /v1/reference/limits. Field shapes are projected
    from operation declarations; local endpoints have explicit handler-derived
    schemas.
servers:
  - url: https://api.printools.io
    description: Production
security: []
externalDocs:
  description: Getting started, OAuth and webhook guidance
  url: https://app.printools.io/api/index.html
paths:
  /v1/garment-variants:
    post:
      tags:
        - garment-variants
      summary: Create a garment variant.
      description: Requires the scope garments.write.
      operationId: post_v1_garment_variants
      parameters:
        - name: X-PrintTools-Organization-Id
          in: header
          required: false
          schema:
            type: string
            format: uuid
          description: >-
            Tenant credential: optional and, when sent, must equal the shop
            bound to the key. Partner credential: required; it selects an
            organisation the user previously authorised.
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 200
          description: >-
            Optional client-generated key for write retries. Reusing it with a
            different request returns 409; a replay includes
            Idempotency-Replayed: true.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                garmentCatalogueItemId:
                  type: string
                styleCode:
                  type: string
                stockCode:
                  type: string
                color:
                  type: string
                colorHex:
                  type: string
                size:
                  type: string
                countryOfManufacture:
                  type: string
                stockOnHand:
                  type: integer
                stockReserved:
                  type: integer
                supplierStock:
                  type: integer
                unitPrice:
                  type: number
                images:
                  type: array
                  items:
                    type: string
              required:
                - styleCode
                - color
                - size
            examples:
              example:
                summary: Replace example values with a request for your shop.
                value:
                  garmentCatalogueItemId: example
                  styleCode: example
                  stockCode: example
                  color: example
                  colorHex: example
                  size: example
                  countryOfManufacture: example
                  stockOnHand: 1
      responses:
        '201':
          description: Successful response.
          headers:
            Idempotency-Replayed:
              description: >-
                Present and true when this response was replayed from a prior
                Idempotency-Key request.
              schema:
                type: string
                enum:
                  - 'true'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Success'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/Output_GarmentVariant'
        '400':
          description: >-
            Validation or request-shape error. Correct the request before
            retrying.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Credential authentication failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            WWW-Authenticate:
              schema:
                type: string
                example: ApiKey
        '403':
          description: >-
            The credential lacks a required scope, or its actor lacks
            permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The resource or endpoint was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            Conflict, including idempotency-key reuse or an in-flight idempotent
            request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: The JSON request body exceeds the published size limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. Retry after the returned delay.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              description: Whole seconds to wait.
              schema:
                type: integer
                minimum: 0
        '500':
          description: An unexpected server error. A retry can be appropriate.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - tenantApiKey: []
        - partnerApiKey: []
          partnerApiSecret: []
          partnerBearer: []
      x-codeSamples:
        - lang: curl
          label: Tenant credential
          source: |-
            curl --request POST 'https://api.printools.io/v1/garment-variants' \
              --header 'X-API-Key: $PRINTOOLS_API_KEY' \
              --header 'Content-Type: application/json' \
              --data '{"garmentCatalogueItemId":"example","styleCode":"example","stockCode":"example","color":"example","colorHex":"example","size":"example","countryOfManufacture":"example","stockOnHand":1}'
components:
  schemas:
    Success:
      type: object
      required:
        - status
        - message
        - data
      properties:
        status:
          type: boolean
          description: >-
            The actual resolver result. It can be false when an operation
            returns false or null without throwing.
        message:
          type: string
          example: OK
        data: {}
      description: Every 2xx response uses this envelope.
    Output_GarmentVariant:
      type: object
      properties:
        id:
          type: string
        garmentCatalogueItemId:
          type:
            - string
            - 'null'
        styleCode:
          type: string
        stockCode:
          type:
            - string
            - 'null'
        color:
          type: string
        colorHex:
          type:
            - string
            - 'null'
        size:
          type: string
        countryOfManufacture:
          type:
            - string
            - 'null'
        stockOnHand:
          type: integer
        stockReserved:
          type: integer
        supplierStock:
          type: integer
        stockByLocation:
          type: array
          items:
            $ref: '#/components/schemas/Output_SupplierStockAtLocation'
        nextDeliveryEta:
          type:
            - string
            - 'null'
          format: date-time
        isDiscontinued:
          type: boolean
        unitPrice:
          type:
            - number
            - 'null'
        images:
          type: array
          items:
            type: string
        source:
          $ref: '#/components/schemas/Enum_CatalogSource'
        externalId:
          type:
            - string
            - 'null'
        lastSyncedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - styleCode
        - color
        - size
        - stockOnHand
        - stockReserved
        - supplierStock
        - stockByLocation
        - isDiscontinued
        - images
        - source
        - createdAt
        - updatedAt
    Error:
      type: object
      required:
        - error
        - message
        - status
      properties:
        error:
          type: string
          description: Stable machine-readable error code.
        message:
          type: string
        status:
          type: boolean
          const: false
      description: Every non-2xx response uses this envelope.
    Output_SupplierStockAtLocation:
      type: object
      description: Supplier stock at one warehouse (AS Colour inventory is per-location).
      properties:
        location:
          type: string
        quantity:
          type: integer
      required:
        - location
        - quantity
    Enum_CatalogSource:
      type: string
      enum:
        - manual
        - ascolour
  securitySchemes:
    tenantApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Tenant credential. This is sufficient by itself.
    partnerApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Partner application client ID.
    partnerApiSecret:
      type: apiKey
      in: header
      name: X-API-Secret
      description: Partner application secret.
    partnerBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Cognito access token obtained through OAuth.

````