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

# Katalogvarianten suchen

> Sucht Shopify-Produktvarianten und gibt Varianten-IDs, Cursor und Seiteninformationen zurück.



## OpenAPI

````yaml /openapi.de.json get /catalog/variants
openapi: 3.1.0
info:
  title: PricePirate Admin API
  version: 1.0.0
  description: >-
    Anfragelimits: Jeder Shop kann 60 Anfragen pro Minute über alle
    API-Schlüssel hinweg senden. Wenn das Limit überschritten wird, gibt die API
    429 TOO_MANY_REQUESTS mit einem Retry-After-Header zurück.
servers:
  - url: https://app.pricepirate.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: reports
    x-group: Berichte
  - name: catalog
    x-group: Katalog
  - name: listings
    x-group: Listings
  - name: metrics
    x-group: Metriken
  - name: price-changes
    x-group: Preisänderungen
  - name: pricing
    x-group: Preisgestaltung
  - name: shop
    x-group: Shop
  - name: tracked-variants
    x-group: Überwachte Varianten
paths:
  /catalog/variants:
    get:
      tags:
        - catalog
      summary: Katalogvarianten suchen
      description: >-
        Sucht Shopify-Produktvarianten und gibt Varianten-IDs, Cursor und
        Seiteninformationen zurück.
      operationId: catalog.variants.search
      parameters:
        - name: query
          in: query
          description: Suchtext, der mit Shopify-Produkttiteln abgeglichen wird.
          required: false
          schema:
            type: string
          example: watch
        - name: sortKey
          in: query
          description: >-
            Sortierschlüssel für Shopify-Produktvarianten. Werte werden zur
            Laufzeit ohne Beachtung der Groß- und Kleinschreibung verarbeitet.
          required: false
          schema:
            type: string
            enum:
              - FULL_TITLE
              - ID
              - INVENTORY_LEVELS_AVAILABLE
              - INVENTORY_MANAGEMENT
              - INVENTORY_POLICY
              - INVENTORY_QUANTITY
              - NAME
              - POPULAR
              - POSITION
              - RELEVANCE
              - SKU
              - TITLE
          example: RELEVANCE
        - name: first
          in: query
          description: Maximale Anzahl der zurückzugebenden Varianten.
          required: false
          schema:
            type: integer
            minimum: 1
          example: 10
        - name: after
          in: query
          description: Cursor, der von einer vorherigen Seite zurückgegeben wurde.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Erfolgreiche Antwort.
          content:
            application/json:
              schema:
                type: object
                properties:
                  variants:
                    type: array
                    items:
                      type: object
                      properties: {}
                      additionalProperties: true
                  pageInfo:
                    type: object
                    properties: {}
                    additionalProperties: true
                  variantIds:
                    type: array
                    items:
                      type: string
                additionalProperties: false
              example:
                variants:
                  - id: gid://shopify/ProductVariant/1001
                    displayName: Example Product - Black
                    cursor: eyJsYXN0X2lkIjoxMDAxfQ==
                pageInfo:
                  hasNextPage: false
                  endCursor: eyJsYXN0X2lkIjoxMDAxfQ==
                variantIds:
                  - gid://shopify/ProductVariant/1001
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/DefaultError'
components:
  responses:
    BadRequest:
      description: Ungültige Anfrage oder Validierungsfehler.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: BAD_REQUEST
              message: JSON body must be an object
              details: Validation details may be included for invalid inputs.
              requestId: 1b11c2c2-7c6f-44d9-9980-02a77681b91f
    Unauthorized:
      description: Fehlendes oder ungültiges Bearer-Token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Missing or invalid Authorization header
              requestId: 1b11c2c2-7c6f-44d9-9980-02a77681b91f
    Forbidden:
      description: Das Token ist gültig, aber die Anfrage ist nicht erlaubt.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: FORBIDDEN
              message: Forbidden
              requestId: 1b11c2c2-7c6f-44d9-9980-02a77681b91f
    NotFound:
      description: Endpunkt oder Domain-Ressource wurde nicht gefunden.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              requestId: 1b11c2c2-7c6f-44d9-9980-02a77681b91f
    TooManyRequests:
      description: Anfragelimit überschritten.
      headers:
        Retry-After:
          description: Sekunden, die vor einem erneuten Versuch gewartet werden sollen.
          schema:
            type: string
          example: '60'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: TOO_MANY_REQUESTS
              message: Rate limit exceeded
              requestId: 1b11c2c2-7c6f-44d9-9980-02a77681b91f
    InternalServerError:
      description: Interner Serverfehler.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_SERVER_ERROR
              message: Internal server error
              requestId: 1b11c2c2-7c6f-44d9-9980-02a77681b91f
    DefaultError:
      description: Unerwartete Fehlerantwort.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_SERVER_ERROR
              message: Internal server error
              requestId: 1b11c2c2-7c6f-44d9-9980-02a77681b91f
  schemas:
    Error:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
            - requestId
          properties:
            code:
              type: string
              description: >-
                Fehlercode zur Laufzeit. Beispiele sind BAD_REQUEST,
                UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT, TOO_MANY_REQUESTS,
                INTERNAL_SERVER_ERROR, idempotency_key_required,
                idempotency_key_reuse und idempotency_key_in_progress.
            message:
              type: string
            details:
              description: >-
                Zusätzliche Validierungsdetails, typischerweise bei
                400-Antworten vorhanden.
            requestId:
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Public-API-Token, das als Authorization: Bearer <token> übergeben wird.'

````