openapi: 3.2.0
info:
  title: Online Store Variant Groups API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: Variant Groups
paths:
  /variant_groups:
    get:
      summary: Get Variant Groups
      tags:
      - Variant Groups
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  variant_groups:
                    type: array
                    items:
                      $ref: '#/components/schemas/variant_groups'
      operationId: get-variant_groups
      description: 'Gets an array of variant groups.


        For more information on variant groups, please see our knowledge base: [Variant Group Overview](https://support.americommerce.com/hc/en-us/articles/213282337-Product-Variant-Overview).'
    post:
      summary: Create a Variant Group
      operationId: post-variant_groups
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/variant_groups'
      tags:
      - Variant Groups
      description: 'Creates a variant group.


        For more information on variant groups, please see our knowledge base: [Variant Group Overview](https://support.americommerce.com/hc/en-us/articles/213282337-Product-Variant-Overview).'
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: Shirt Size
                  sort_order: 1
                  is_hidden: false
                  display_type: DropDown
                  group_header_html: ''
                  public_description_html: ''
                  group_footer_html: ''
                  is_non_inventory: false
              properties:
                name:
                  type: string
                sort_order:
                  type: integer
                is_hidden:
                  type: boolean
                display_type:
                  type: string
                group_header_html:
                  type: string
                public_description_html:
                  type: string
                group_footer_html:
                  type: string
                is_non_inventory:
                  type: boolean
            examples:
              Example:
                value:
                  name: Shirt Size
                  sort_order: 1
                  is_hidden: false
                  display_type: DropDown
                  group_header_html: ''
                  public_description_html: ''
                  group_footer_html: ''
                  is_non_inventory: false
  /variant_groups/{id}:
    parameters:
    - schema:
        type: integer
      name: id
      in: path
      required: true
      description: The ID of the `variant_group`
    put:
      summary: Update a Variant Group
      operationId: put-variant_groups-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/variant_groups'
      description: 'Updates a varaint group.


        For more information on variant groups, please see our knowledge base: [Variant Group Overview](https://support.americommerce.com/hc/en-us/articles/213282337-Product-Variant-Overview).'
      tags:
      - Variant Groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/variant_groups'
    delete:
      summary: Delete a Variant Group
      operationId: delete-variant_groups-id
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
      description: 'Deletes a variant group.


        For more information on variant groups, please see our knowledge base: [Variant Group Overview](https://support.americommerce.com/hc/en-us/articles/213282337-Product-Variant-Overview).'
      tags:
      - Variant Groups
components:
  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: {}
  schemas:
    variant_groups:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        sort_order:
          type: integer
        is_hidden:
          type: boolean
        updated_at:
          type: string
        created_at:
          type: string
        display_type:
          type: string
        group_header_html:
          type: string
        public_description_html:
          type: string
        group_footer_html:
          type: string
        is_non_inventory:
          type: boolean
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header