medusa-store/docs/api/admin/paths/tax-rates.yaml

post:
  operationId: PostTaxRates
  summary: Create a Tax Rate
  description: Creates a Tax Rate
  parameters:
    - in: query
      name: fields
      description: Which fields should be included in the result.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    - in: query
      name: expand
      description: Which fields should be expanded and retrieved in the result.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
  x-authenticated: true
  requestBody:
    content:
      application/json:
        schema:
          $ref: ../components/schemas/AdminPostTaxRatesReq.yaml
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/tax-rates/postundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/tax-rates/postundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Tax Rate
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              tax_rate:
                $ref: ../components/schemas/TaxRate.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
get:
  operationId: GetTaxRates
  summary: List Tax Rates
  description: Retrieves a list of TaxRates
  x-authenticated: true
  parameters:
    - in: query
      name: name
      description: Name of tax rate to retrieve
      schema:
        type: string
    - in: query
      name: region_id
      style: form
      explode: false
      description: Filter by Region ID
      schema:
        oneOf:
          - type: string
          - type: array
            items:
              type: string
    - in: query
      name: code
      description: code to search for.
      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: How many tax rates to skip before retrieving the result.
      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: Which fields should be included in each item.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    - in: query
      name: expand
      description: Which fields should be expanded and retrieved for each item.
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/tax-rates/getundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/tax-rates/getundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Tax Rate
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              tax_rates:
                type: array
                items:
                  $ref: ../components/schemas/TaxRate.yaml
              count:
                type: integer
                description: The total number of items available
              offset:
                type: integer
                description: The number of items skipped before these items
              limit:
                type: integer
                description: The number of items per page
    '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