medusa-store/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml

get:
  operationId: GetTaxRates
  summary: List Tax Rates
  description: >-
    Retrieve a list of Tax Rates. The tax rates can be filtered by fields such
    as `name` or `rate`. The tax rates can also be paginated.
  x-authenticated: true
  parameters:
    - in: query
      name: name
      description: Filter by name.
      schema:
        type: string
    - in: query
      name: region_id
      style: form
      explode: false
      description: Filter by Region IDs
      schema:
        oneOf:
          - type: string
          - type: array
            items:
              type: string
    - in: query
      name: code
      description: Filter by code.
      schema:
        type: string
    - in: query
      name: rate
      style: form
      explode: false
      description: Filter by Rate
      schema:
        oneOf:
          - type: number
          - type: object
            properties:
              lt:
                type: number
                description: filter by rates less than this number
              gt:
                type: number
                description: filter by rates greater than this number
              lte:
                type: number
                description: filter by rates less than or equal to this number
              gte:
                type: number
                description: filter by rates greater than or equal to this number
    - in: query
      name: offset
      description: The number of tax rates to skip when retrieving the tax rates.
      schema:
        type: integer
        default: 0
    - in: query
      name: limit
      description: Limit the number of tax rates returned.
      schema:
        type: integer
        default: 50
    - in: query
      name: fields
      description: Comma-separated fields that should be included in the returned tax rate.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    - in: query
      name: expand
      description: >-
        Comma-separated relations that should be expanded in the returned tax
        rate.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
  x-codegen:
    method: list
    queryParams: AdminGetTaxRatesParams
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/admin_tax-rates/get.js
    - lang: tsx
      label: Medusa React
      source:
        $ref: ../code_samples/tsx/admin_tax-rates/get.tsx
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/admin_tax-rates/get.sh
  security:
    - api_token: []
    - cookie_auth: []
    - jwt_token: []
  tags:
    - Tax Rates
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            $ref: ../components/schemas/AdminTaxRatesListRes.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.yaml
    '404':
      $ref: ../components/responses/not_found_error.yaml
    '409':
      $ref: ../components/responses/invalid_state_error.yaml
    '422':
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml
post:
  operationId: PostTaxRates
  summary: Create a Tax Rate
  description: Create a Tax Rate.
  parameters:
    - in: query
      name: fields
      description: Comma-separated fields that should be included in the returned tax rate.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    - in: query
      name: expand
      description: >-
        Comma-separated relations that should be expanded in the returned tax
        rate.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
  x-authenticated: true
  requestBody:
    content:
      application/json:
        schema:
          $ref: ../components/schemas/AdminPostTaxRatesReq.yaml
  x-codegen:
    method: create
    queryParams: AdminPostTaxRatesParams
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/admin_tax-rates/post.js
    - lang: tsx
      label: Medusa React
      source:
        $ref: ../code_samples/tsx/admin_tax-rates/post.tsx
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/admin_tax-rates/post.sh
  security:
    - api_token: []
    - cookie_auth: []
    - jwt_token: []
  tags:
    - Tax Rates
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            $ref: ../components/schemas/AdminTaxRatesRes.yaml
    '400':
      $ref: ../components/responses/400_error.yaml
    '401':
      $ref: ../components/responses/unauthorized.yaml
    '404':
      $ref: ../components/responses/not_found_error.yaml
    '409':
      $ref: ../components/responses/invalid_state_error.yaml
    '422':
      $ref: ../components/responses/invalid_request_error.yaml
    '500':
      $ref: ../components/responses/500_error.yaml