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

# Search catalog variants

> Search Shopify product variants and return variant IDs, cursors, and page info.



## OpenAPI

````yaml /openapi.json get /catalog/variants
openapi: 3.1.0
info:
  title: PricePirate Admin API
  version: 1.0.0
  description: >-
    Rate limits: each shop can send 60 requests per minute across all API keys.
    If the limit is exceeded, the API returns 429 TOO_MANY_REQUESTS with a
    Retry-After header.
servers:
  - url: https://app.pricepirate.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: catalog
    x-group: Catalog
  - name: listings
    x-group: Listings
  - name: metrics
    x-group: Metrics
  - name: price-changes
    x-group: Price changes
  - name: pricing
    x-group: Pricing
  - name: reports
    x-group: Reports
  - name: shop
    x-group: Shop
  - name: tracked-variants
    x-group: Tracked variants
paths:
  /catalog/variants:
    get:
      tags:
        - catalog
      summary: Search catalog variants
      description: >-
        Search Shopify product variants and return variant IDs, cursors, and
        page info.
      operationId: catalog.variants.search
      parameters:
        - name: query
          in: query
          description: Search text matched against Shopify product titles.
          required: false
          schema:
            type: string
          example: watch
        - name: sortKey
          in: query
          description: >-
            Shopify product variant sort key. Values are case-insensitive at
            runtime.
          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: Maximum number of variants to return.
          required: false
          schema:
            type: integer
            minimum: 1
          example: 10
        - name: after
          in: query
          description: Cursor returned by a previous page.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Successful response.
          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: Bad request or validation error.
      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: Missing or invalid 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: The token is valid but the request is not allowed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: FORBIDDEN
              message: Forbidden
              requestId: 1b11c2c2-7c6f-44d9-9980-02a77681b91f
    NotFound:
      description: Endpoint or domain resource not found.
      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: Rate limit exceeded.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          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: Internal server error.
      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: Unexpected error response.
      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: >-
                Runtime error code. Examples include BAD_REQUEST, UNAUTHORIZED,
                FORBIDDEN, NOT_FOUND, CONFLICT, TOO_MANY_REQUESTS,
                INTERNAL_SERVER_ERROR, idempotency_key_required,
                idempotency_key_reuse, and idempotency_key_in_progress.
            message:
              type: string
            details:
              description: >-
                Additional validation details, typically present on 400
                responses.
            requestId:
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Public API token passed as Authorization: Bearer <token>.'

````