medusa-store/docs/api/admin/paths/tax-rates_{id}.yaml

delete:
  operationId: DeleteTaxRatesTaxRate
  summary: Delete a Tax Rate
  description: Deletes a Tax Rate
  x-authenticated: true
  parameters:
    - in: path
      name: id
      required: true
      description: The ID of the Shipping Option.
      schema:
        type: string
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/tax-rates_{id}/deleteundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/tax-rates_{id}/deleteundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Tax Rate
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            properties:
              id:
                type: string
                description: The ID of the deleted Shipping Option.
              object:
                type: string
                description: The type of the object that was deleted.
                default: tax-rate
              deleted:
                type: boolean
                description: Whether or not the items were deleted.
                default: true
    '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: GetTaxRatesTaxRate
  summary: Get a Tax Rate
  description: Retrieves a TaxRate
  parameters:
    - in: path
      name: id
      required: true
      description: ID of the tax rate.
      schema:
        type: string
    - 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
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/tax-rates_{id}/getundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/tax-rates_{id}/getundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Tax Rate
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            properties:
              tax_rate:
                $ref: ../components/schemas/tax_rate.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: PostTaxRatesTaxRate
  summary: Update a Tax Rate
  description: Updates a Tax Rate
  parameters:
    - in: path
      name: id
      required: true
      description: ID of the tax rate.
      schema:
        type: string
    - 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:
          properties:
            code:
              type: string
              description: A code to identify the tax type by
            name:
              type: string
              description: A human friendly name for the tax
            region_id:
              type: string
              description: The ID of the Region that the rate belongs to
            rate:
              type: number
              description: The numeric rate to charge
            products:
              type: array
              description: The IDs of the products associated with this tax rate
              items:
                type: string
            shipping_options:
              type: array
              description: The IDs of the shipping options associated with this tax rate
              items:
                type: string
            product_types:
              type: array
              description: The IDs of the types of products associated with this tax rate
              items:
                type: string
  x-codeSamples:
    - lang: JavaScript
      label: JS Client
      source:
        $ref: ../code_samples/JavaScript/tax-rates_{id}/postundefined
    - lang: Shell
      label: cURL
      source:
        $ref: ../code_samples/Shell/tax-rates_{id}/postundefined
  security:
    - api_token: []
    - cookie_auth: []
  tags:
    - Tax Rate
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            properties:
              tax_rate:
                $ref: ../components/schemas/tax_rate.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