openapi: 3.2.0
info:
  title: Online Store Product Variants API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: Product Variants
paths:
  /product_variants:
    get:
      summary: Get Product Variants
      tags:
      - Product Variants
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  product_variants:
                    type: array
                    items:
                      $ref: '#/components/schemas/product_variants'
      operationId: get-product_variants
      description: Gets an array of product variants.
    post:
      summary: Create a Product Variant
      operationId: post-product_variants
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_variants'
      tags:
      - Product Variants
      description: Creates a product variant.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  product_id: 32
                  variant_group_id: 4
                  description: Cart.com Blue
                  price_adjustment: 0
                  price_adjustment_type: total
                  sort_order: 0
                  item_number_extension: '101520'
                  is_hidden: false
                  weight: 1.0
                  weight_type: +
                  is_default_selection: true
                  swatch_file: ''
                  swatch_thumbnail: /images/blue.jpg
                  swatch_thumbnail_color: ''
              properties:
                product_id:
                  type: integer
                variant_group_id:
                  type: integer
                description:
                  type: string
                price_adjustment:
                  type: number
                price_adjustment_type:
                  type: string
                sort_order:
                  type: integer
                item_number_extension:
                  type: string
                item_number_sort_order:
                  type: integer
                  default: 0
                  minimum: 0
                weight:
                  type: number
                weight_type:
                  type: string
                is_hidden:
                  type: boolean
                is_default_selection:
                  type: boolean
                swatch_file:
                  type: string
                swatch_thumbnail:
                  type: string
                swatch_thumbnail_color:
                  type: string
              required:
              - product_id
              - variant_group_id
            examples:
              Example:
                value:
                  product_id: 32
                  variant_group_id: 4
                  description: Cart.com Blue
                  price_adjustment: 0
                  price_adjustment_type: total
                  sort_order: 0
                  item_number_extension: '101520'
                  is_hidden: false
                  weight: 1.0
                  weight_type: +
                  is_default_selection: true
                  swatch_file: ''
                  swatch_thumbnail: /images/blue.jpg
                  swatch_thumbnail_color: ''
  /product_variants/{id}:
    parameters:
    - schema:
        type: integer
      name: id
      in: path
      required: true
      description: The ID of the `product_variant`
    put:
      summary: Update a Product Variant
      operationId: put-product_variants-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/product_variants'
      tags:
      - Product Variants
      description: Updates a product variant.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/product_variants'
    delete:
      summary: Delete a Product Variant
      operationId: delete-product_variants-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      tags:
      - Product Variants
      description: Deletes a product variant.
components:
  schemas:
    product_variants:
      type: object
      properties:
        id:
          type: integer
        product_id:
          type: integer
        variant_group_id:
          type: integer
        description:
          type: string
        price_adjustment:
          type: integer
        price_adjustment_type:
          type: string
        sort_order:
          type: integer
        item_number_extension:
          type: string
        item_number_sort_order:
          type: integer
          default: 0
        is_hidden:
          type: boolean
        weight:
          type: number
        weight_type:
          type: string
        updated_at:
          type: string
        created_at:
          type: string
        is_default_selection:
          type: boolean
        swatch_file:
          type: string
        swatch_thumbnail:
          type: string
        swatch_thumbnail_color:
          type: string
  responses:
    '404':
      description: Resource Not Found
      content:
        application/json:
          schema:
            description: Not Found
            type: object
            x-examples:
              example-1:
                status_code: 404
                message: Not Found
                details: No resource found
            properties:
              status_code:
                type: number
              message:
                type: string
              details:
                type: string
          examples: {}
      headers: {}
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header