Medusa Product Variants API

openapi: 3.2.0
info:
  title: Medusa Product Variants API
  version: 2.19.0
  description: 'Operations tagged Product Variants across 2 of this provider''s published API definitions: medusa-admin-openapi.yaml, medusa-store-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:9000
- url: https://api.medusajs.com
tags:
- name: Product Variants
  description: 'A product variant is a saleable form of the product.


    Each variant has different option values. For example, a "Shirt" product may have a  "Blue" variant and a "Green" variant. Customers choose from these variants when they buy the product.


    These API routes allow admin users to manage product variants.

    '
  externalDocs:
    description: Learn more about the Product Module
    url: https://docs.medusajs.com/resources/commerce-modules/product
  x-associatedSchema:
    $ref: '#/components/schemas/AdminProductVariant'
paths:
  /admin/product-variants:
    get:
      operationId: GetProductVariants
      summary: List Product Variants
      description: Retrieve a list of product variants. The product variants can be filtered by fields such as `id`. The product variants can also be sorted or paginated.
      x-authenticated: true
      parameters:
      - name: fields
        in: query
        description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields.
        required: false
        schema:
          type: string
          title: fields
          description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields.
          externalDocs:
            url: '#select-fields-and-relations'
      - name: offset
        in: query
        description: The number of items to skip when retrieving a list.
        required: false
        schema:
          type: number
          title: offset
          description: The number of items to skip when retrieving a list.
          externalDocs:
            url: '#pagination'
      - name: limit
        in: query
        description: Limit the number of items returned in the list.
        required: false
        schema:
          type: number
          title: limit
          description: Limit the number of items returned in the list.
          externalDocs:
            url: '#pagination'
      - name: order
        in: query
        description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
        required: false
        schema:
          type: string
          title: order
          description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
      - name: q
        in: query
        description: Search term to filter the product variant's searchable properties.
        required: false
        schema:
          type: string
          title: q
          description: Search term to filter the product variant's searchable properties.
      - name: id
        in: query
        required: false
        schema:
          oneOf:
          - type: string
            title: id
            description: Filter by a variant's ID.
          - type: array
            description: Filter by variant IDs.
            items:
              type: string
              title: id
              description: A variant's ID.
      - name: manage_inventory
        in: query
        description: Filter by whether a variant's `manage_inventory` is enabled.
        required: false
        schema:
          type: boolean
          title: manage_inventory
          description: Filter by whether a variant's `manage_inventory` is enabled.
      - name: allow_backorder
        in: query
        description: Filter by whether backorder is allowed for a variant.
        required: false
        schema:
          type: boolean
          title: allow_backorder
          description: Filter by whether backorder is allowed for a variant.
      - name: created_at
        in: query
        description: Filter by the product variant's creation date.
        required: false
        schema:
          type: object
          description: Filter by the product variant's creation date.
          properties:
            $and:
              type: array
              description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
              title: $and
            $or:
              type: array
              description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
              title: $or
            $eq:
              oneOf:
              - type: string
                title: $eq
                description: Filter by an exact match.
              - type: array
                description: Filter by an exact match.
                items:
                  type: string
                  title: $eq
                  description: Filter by an exact match.
            $ne:
              type: string
              title: $ne
              description: Filter by values not equal to this parameter.
            $in:
              type: array
              description: Filter by values in this array.
              items:
                type: string
                title: $in
                description: Filter by values in this array.
            $nin:
              type: array
              description: Filter by values not in this array.
              items:
                type: string
                title: $nin
                description: Filter by values not in this array.
            $not:
              oneOf:
              - type: string
                title: $not
                description: Filter by values not matching the conditions in this parameter.
              - type: object
                description: Filter by values not matching the conditions in this parameter.
              - type: array
                description: Filter by values not matching the conditions in this parameter.
                items:
                  type: string
                  title: $not
                  description: Filter by values not matching the conditions in this parameter.
            $gt:
              type: string
              title: $gt
              description: Filter by values greater than this parameter. Useful for numbers and dates only.
            $gte:
              type: string
              title: $gte
              description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
            $lt:
              type: string
              title: $lt
              description: Filter by values less than this parameter. Useful for numbers and dates only.
            $lte:
              type: string
              title: $lte
              description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
            $like:
              type: string
              title: $like
              description: Apply a `like` filter. Useful for strings only.
            $re:
              type: string
              title: $re
              description: Apply a regex filter. Useful for strings only.
            $ilike:
              type: string
              title: $ilike
              description: Apply a case-insensitive `like` filter. Useful for strings only.
            $fulltext:
              type: string
              title: $fulltext
              description: Filter to apply on full-text properties.
            $overlap:
              type: array
              description: Filter arrays that have overlapping values with this parameter.
              items:
                type: string
                title: $overlap
                description: Filter arrays that have overlapping values with this parameter.
            $contains:
              type: array
              description: Filter arrays that contain some of the values of this parameter.
              items:
                type: string
                title: $contains
                description: Filter arrays that contain some of the values of this parameter.
            $contained:
              type: array
              description: Filter arrays that contain all values of this parameter.
              items:
                type: string
                title: $contained
                description: Filter arrays that contain all values of this parameter.
            $exists:
              type: boolean
              title: $exists
              description: Filter by whether a value for this parameter exists (not `null`).
          title: created_at
      - name: updated_at
        in: query
        description: Filter by the product variant's update date.
        required: false
        schema:
          type: object
          description: Filter by the product variant's update date.
          properties:
            $and:
              type: array
              description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
              title: $and
            $or:
              type: array
              description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
              title: $or
            $eq:
              oneOf:
              - type: string
                title: $eq
                description: Filter by an exact match.
              - type: array
                description: Filter by an exact match.
                items:
                  type: string
                  title: $eq
                  description: Filter by an exact match.
            $ne:
              type: string
              title: $ne
              description: Filter by values not equal to this parameter.
            $in:
              type: array
              description: Filter by values in this array.
              items:
                type: string
                title: $in
                description: Filter by values in this array.
            $nin:
              type: array
              description: Filter by values not in this array.
              items:
                type: string
                title: $nin
                description: Filter by values not in this array.
            $not:
              oneOf:
              - type: string
                title: $not
                description: Filter by values not matching the conditions in this parameter.
              - type: object
                description: Filter by values not matching the conditions in this parameter.
              - type: array
                description: Filter by values not matching the conditions in this parameter.
                items:
                  type: string
                  title: $not
                  description: Filter by values not matching the conditions in this parameter.
            $gt:
              type: string
              title: $gt
              description: Filter by values greater than this parameter. Useful for numbers and dates only.
            $gte:
              type: string
              title: $gte
              description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
            $lt:
              type: string
              title: $lt
              description: Filter by values less than this parameter. Useful for numbers and dates only.
            $lte:
              type: string
              title: $lte
              description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
            $like:
              type: string
              title: $like
              description: Apply a `like` filter. Useful for strings only.
            $re:
              type: string
              title: $re
              description: Apply a regex filter. Useful for strings only.
            $ilike:
              type: string
              title: $ilike
              description: Apply a case-insensitive `like` filter. Useful for strings only.
            $fulltext:
              type: string
              title: $fulltext
              description: Filter to apply on full-text properties.
            $overlap:
              type: array
              description: Filter arrays that have overlapping values with this parameter.
              items:
                type: string
                title: $overlap
                description: Filter arrays that have overlapping values with this parameter.
            $contains:
              type: array
              description: Filter arrays that contain some of the values of this parameter.
              items:
                type: string
                title: $contains
                description: Filter arrays that contain some of the values of this parameter.
            $contained:
              type: array
              description: Filter arrays that contain all values of this parameter.
              items:
                type: string
                title: $contained
                description: Filter arrays that contain all values of this parameter.
            $exists:
              type: boolean
              title: $exists
              description: Filter by whether a value for this parameter exists (not `null`).
          title: updated_at
      - name: deleted_at
        in: query
        description: Filter by the product variant's deletion date.
        required: false
        schema:
          type: object
          description: Filter by the product variant's deletion date.
          properties:
            $and:
              type: array
              description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
              title: $and
            $or:
              type: array
              description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
              title: $or
            $eq:
              oneOf:
              - type: string
                title: $eq
                description: Filter by an exact match.
              - type: array
                description: Filter by an exact match.
                items:
                  type: string
                  title: $eq
                  description: Filter by an exact match.
            $ne:
              type: string
              title: $ne
              description: Filter by values not equal to this parameter.
            $in:
              type: array
              description: Filter by values in this array.
              items:
                type: string
                title: $in
                description: Filter by values in this array.
            $nin:
              type: array
              description: Filter by values not in this array.
              items:
                type: string
                title: $nin
                description: Filter by values not in this array.
            $not:
              oneOf:
              - type: string
                title: $not
                description: Filter by values not matching the conditions in this parameter.
              - type: object
                description: Filter by values not matching the conditions in this parameter.
              - type: array
                description: Filter by values not matching the conditions in this parameter.
                items:
                  type: string
                  title: $not
                  description: Filter by values not matching the conditions in this parameter.
            $gt:
              type: string
              title: $gt
              description: Filter by values greater than this parameter. Useful for numbers and dates only.
            $gte:
              type: string
              title: $gte
              description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
            $lt:
              type: string
              title: $lt
              description: Filter by values less than this parameter. Useful for numbers and dates only.
            $lte:
              type: string
              title: $lte
              description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
            $like:
              type: string
              title: $like
              description: Apply a `like` filter. Useful for strings only.
            $re:
              type: string
              title: $re
              description: Apply a regex filter. Useful for strings only.
            $ilike:
              type: string
              title: $ilike
              description: Apply a case-insensitive `like` filter. Useful for strings only.
            $fulltext:
              type: string
              title: $fulltext
              description: Filter to apply on full-text properties.
            $overlap:
              type: array
              description: Filter arrays that have overlapping values with this parameter.
              items:
                type: string
                title: $overlap
                description: Filter arrays that have overlapping values with this parameter.
            $contains:
              type: array
              description: Filter arrays that contain some of the values of this parameter.
              items:
                type: string
                title: $contains
                description: Filter arrays that contain some of the values of this parameter.
            $contained:
              type: array
              description: Filter arrays that contain all values of this parameter.
              items:
                type: string
                title: $contained
                description: Filter arrays that contain all values of this parameter.
            $exists:
              type: boolean
              title: $exists
              description: Filter by whether a value for this parameter exists (not `null`).
          title: deleted_at
      - name: $and
        in: query
        description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
        required: false
        schema:
          type: array
          description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
          items:
            type: object
          title: $and
      - name: $or
        in: query
        description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
        required: false
        schema:
          type: array
          description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
          items:
            type: object
          title: $or
      - name: with_deleted
        in: query
        description: Whether to include deleted records in the result.
        required: false
        schema:
          type: boolean
          title: with_deleted
          description: Whether to include deleted records in the result.
      - name: ean
        in: query
        required: false
        schema:
          oneOf:
          - type: string
            title: ean
            description: The product variant's ean.
          - type: array
            description: The product variant's ean.
            items:
              type: string
              title: ean
              description: The ean's details.
      - name: upc
        in: query
        required: false
        schema:
          oneOf:
          - type: string
            title: upc
            description: The product variant's upc.
          - type: array
            description: The product variant's upc.
            items:
              type: string
              title: upc
              description: The upc's details.
      - name: barcode
        in: query
        required: false
        schema:
          oneOf:
          - type: string
            title: barcode
            description: The product variant's barcode.
          - type: array
            description: The product variant's barcode.
            items:
              type: string
              title: barcode
              description: The barcode's details.
      - name: sku
        in: query
        required: false
        schema:
          oneOf:
          - type: string
            title: sku
            description: Filter by an SKU.
          - type: array
            description: Filter by multiple SKUs.
            items:
              type: string
              title: sku
              description: An SKU.
      security:
      - api_token: []
      - cookie_auth: []
      - jwt_token: []
      x-codeSamples:
      - lang: JavaScript
        label: JS SDK
        source: "import Medusa from \"@medusajs/js-sdk\"\n\nexport const sdk = new Medusa({\n  baseUrl: import.meta.env.VITE_BACKEND_URL || \"/\",\n  debug: import.meta.env.DEV,\n  auth: {\n    type: \"session\",\n  },\n})\n\nsdk.admin.productVariant.list()\n.then(({ variants, count, limit, offset }) => {\n  console.log(variants)\n})"
      - lang: Shell
        label: cURL
        source: 'curl ''{backend_url}/admin/product-variants'' \

          -H ''Authorization: Bearer {jwt_token}'''
      tags:
      - Product Variants
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  description: The paginated list of product variants.
                  required:
                  - limit
                  - offset
                  - count
                  properties:
                    limit:
                      type: number
                      title: limit
                      description: The maximum number of items returned.
                    offset:
                      type: number
                      title: offset
                      description: The number of items skipped before retrieving the returned items.
                    count:
                      type: number
                      title: count
                      description: The total number of items.
                - type: object
                  description: The paginated list of product variants.
                  required:
                  - variants
                  properties:
                    variants:
                      type: array
                      description: The product variant's variants.
                      items:
                        $ref: '#/components/schemas/AdminProductVariant'
        '400':
          $ref: '#/components/responses/400_error'
        '401':
          $ref: '#/components/responses/unauthorized'
        '404':
          $ref: '#/components/responses/not_found_error'
        '409':
          $ref: '#/components/responses/invalid_state_error'
        '422':
          $ref: '#/components/responses/invalid_request_error'
        '500':
          $ref: '#/components/responses/500_error'
    servers:
    - url: http://localhost:9000
    - url: https://api.medusajs.com
  /store/product-variants:
    get:
      operationId: GetProductVariants
      summary: List Product Variants
      description: Retrieve a list of product variants. The product variants can be filtered by fields such as `id`. The product variants can also be sorted or paginated.
      x-authenticated: false
      parameters:
      - name: x-publishable-api-key
        in: header
        description: Publishable API Key created in the Medusa Admin.
        required: true
        schema:
          type: string
          externalDocs:
            url: https://docs.medusajs.com/api/store#publishable-api-key
      - name: x-medusa-locale
        in: header
        description: The locale in BCP 47 format to retrieve localized content.
        required: false
        schema:
          type: string
          example: en-US
          externalDocs:
            url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
            description: Learn more in the Serve Translations in Storefront guide.
      - name: locale
        in: query
        description: The locale in BCP 47 format to retrieve localized content.
        required: false
        schema:
          type: string
          example: en-US
          externalDocs:
            url: https://docs.medusajs.com/resources/commerce-modules/translation/storefront
            description: Learn more in the Serve Translations in Storefront guide.
      - name: sku
        in: query
        required: false
        schema:
          oneOf:
          - type: string
            title: sku
            description: Filter by a product variant's sku.
          - type: array
            description: Filter by product variant skus.
            items:
              type: string
              title: sku
              description: The product variant's sku.
      - name: manage_inventory
        in: query
        description: Filter by whether Medusa manages inventory for the product variant.
        required: false
        schema:
          type: boolean
          title: manage_inventory
          description: Filter by whether Medusa manages inventory for the product variant.
      - name: allow_backorder
        in: query
        description: Filter by whether backorders are allowed for the product variant.
        required: false
        schema:
          type: boolean
          title: allow_backorder
          description: Filter by whether backorders are allowed for the product variant.
      - name: product_id
        in: query
        required: false
        schema:
          oneOf:
          - type: string
            title: product_id
            description: Filter by a product ID to retrieve its variants.
          - type: array
            description: Filter by product IDs to retrieve their variants.
            items:
              type: string
              title: product_id
              description: The product's ID.
      - name: q
        in: query
        description: Query to search variants by their searchable fields.
        required: false
        schema:
          type: string
          title: q
          description: Query to search variants by their searchable fields.
      - name: id
        in: query
        required: false
        schema:
          oneOf:
          - type: string
            title: id
            description: Filter by a product variant's ID.
          - type: array
            description: Filter by product variant IDs.
            items:
              type: string
              title: id
              description: The product variant's ID.
      - name: options
        in: query
        description: Filter by the product variant's options.
        required: false
        schema:
          type: object
          description: Apply filters on the product variant's options.
          properties:
            value:
              type: string
              title: value
              description: The option's value.
            option_id:
              type: string
              title: option_id
              description: The option's ID.
      - name: created_at
        in: query
        description: Filter by the product variant's creation date.
        required: false
        schema:
          type: object
          properties:
            $and:
              type: array
              description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
            $or:
              type: array
              description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
            $eq:
              oneOf:
              - type: string
                title: $eq
                description: Filter by exact value.
              - type: array
                title: $eq
                description: Filter by exact value.
                items:
                  type: string
            $ne:
              type: string
              title: $ne
              description: Filter by not equal to the given value.
            $in:
              type: array
              title: $in
              description: Filter by values included in the given array.
              items:
                type: string
            $nin:
              type: array
              title: $nin
              description: Filter by values not included in the given array.
              items:
                type: string
            $not:
              oneOf:
              - type: string
                title: $not
                description: Filter by not equal to the given value.
              - type: object
                title: $not
                description: Filter by values not matching the conditions in this parameter.
              - type: array
                title: $not
                description: Filter by values not matching the conditions in this parameter.
                items:
                  type: string
            $gt:
              type: string
              title: $gt
              description: Filter by values greater than the given value.
            $gte:
              type: string
              title: $gte
              description: Filter by values greater than or equal to the given value.
            $lt:
              type: string
              title: $lt
              description: Filter by values less than the given value.
            $lte:
              type: string
              title: $lte
              description: Filter by values less than or equal to the given value.
            $like:
              type: string
              title: $like
              description: Apply a `like` filter. Useful for strings only.
            $re:
              type: string
              title: $re
              description: Apply a regex filter. Useful for strings only.
            $ilike:
              type: string
              title: $ilike
              description: Apply a case-insensitive `like` filter. Useful for strings only.
            $fulltext:
              type: string
              title: $fulltext
              description: Filter to apply on full-text properties.
            $overlap:
              type: array
              title: $overlap
              description: Filter to apply on array properties to find overlapping values.
              items:
                type: string
            $contains:
              type: array
              title: $contains
              description: Filter to apply on array properties to find contained values.
              items:
                type: string
            $contained:
              type: array
              title: $contained
              description: Filter to apply on array properties to find contained values.
              items:
                type: string
            $exists:
              type: boolean
              title: $exists
              description: Filter by whether a value exists or not.
          title: created_at
          description: Filter by the product variant's creation date.
      - name: updated_at
        in: query
        description: Filter by the product variant's last update date.
        required: false
        schema:
          type: object
          properties:
            $and:
              type: arr

# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/medusa/refs/heads/main/openapi/medusa-product-variants-api-openapi.yml