openapi: 3.2.0
info:
  title: Online Store Tax Rates API
  version: '1.0'
  description: Online Store API
servers:
- url: https://www.yoursite.com/api/v1
  description: ''
security:
- X-AC-Auth-Token: []
tags:
- name: Tax Rates
paths:
  /tax_rates:
    get:
      summary: Tax Rates
      tags:
      - Tax Rates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_count:
                    type: integer
                  tax_rates:
                    type: array
                    items:
                      $ref: '#/components/schemas/tax_rates'
      operationId: get-tax_rates
      description: Gets an array of tax rates.
    post:
      summary: Create a Tax Rate
      operationId: post-tax_rates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tax_rates'
      description: Creates a tax rate.
      requestBody:
        content:
          application/json:
            schema:
              description: ''
              type: object
              x-examples:
                example-1:
                  name: Texas
                  rate: 0.0825
                  region_id: 1
                  is_shipping_included: true
                  is_handling_included: true
                  store_id: 0
              properties:
                name:
                  type: string
                rate:
                  type: number
                region_id:
                  type: integer
                is_shipping_included:
                  type: boolean
                is_handling_included:
                  type: boolean
                store_id:
                  type: integer
              required:
              - rate
              - region_id
              - store_id
            examples:
              Example:
                value:
                  name: Texas
                  rate: 0.0825
                  region_id: 1
                  is_shipping_included: true
                  is_handling_included: true
                  store_id: 0
      tags:
      - Tax Rates
  /tax_rates/{id}:
    parameters:
    - schema:
        type: integer
      name: id
      in: path
      required: true
      description: The ID of the `tax_rates`
    put:
      summary: Update a Tax Rate
      operationId: put-tax_rates-id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tax_rates'
      tags:
      - Tax Rates
      description: Updates a tax rate.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tax_rates'
    delete:
      summary: Delete a Tax Rate
      operationId: delete-tax_rates-id
      description: Deletes a tax rate.
      tags:
      - Tax Rates
      responses:
        '200':
          description: OK
        '404':
          $ref: '#/components/responses/404'
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:
    tax_rates:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        rate:
          type: number
        region_id:
          type: integer
        is_shipping_included:
          type: boolean
        is_handling_included:
          type: boolean
        store_id:
          type: integer
        updated_at:
          type: string
        created_at:
          type: string
  securitySchemes:
    X-AC-Auth-Token:
      name: X-AC-Auth-Token
      type: apiKey
      in: header