Optimizely Local Tax Rates API

The Local Tax Rates API from Optimizely — 6 operation(s) for local tax rates.

Business capability
Indirect Tax Management BC-220.20

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/LocalTaxRates List local tax rates · Returns the EntitySet LocalTaxRates #
Ask an LLM
“How do I see every local tax rate configured by postal code?”
“Can I filter the local tax rate list to a single postal code with $filter?”
Tell an agent
List local tax rates matching {filter}.
Show all postal-code tax rates sorted by {orderby}.
POST /api/v1/admin/LocalTaxRates Add a local tax rate for a postal code · Post a new entity to EntitySet LocalTaxRates #
Ask an LLM
“What do I need to add a new sales tax rate for a postal code?”
“Can I choose whether a new local tax rate also applies to freight?”
Tell an agent
Create a local tax rate of {taxRate} for postal code {postalCode} with tax code {taxCode}.
Add tax code {taxCode} for postal code {postalCode} and tax freight: {taxFreight}.
GET /api/v1/admin/LocalTaxRates({id}) Get one local tax rate · Returns the entity with the key from LocalTaxRates #
Ask an LLM
“Where do I look up a single local tax rate by its id?”
“Which postal code and tax code does a given local tax rate record hold?”
Tell an agent
Get local tax rate {id}.
Show the postal code and rate stored on tax rate record {id}.
PUT /api/v1/admin/LocalTaxRates({id}) Replace a local tax rate record · Replace entity in EntitySet LocalTaxRates #
Ask an LLM
“How do I overwrite a local tax rate record with a complete new version?”
“Does a full replace of a tax rate require the postal code and tax code again?”
Tell an agent
Replace local tax rate {id} with postal code {postalCode}, tax code {taxCode} and rate {taxRate}.
Overwrite the whole tax rate record {id}.
DELETE /api/v1/admin/LocalTaxRates({id}) Delete a local tax rate · Delete entity in EntitySet LocalTaxRates #
Ask an LLM
“Can I remove one local tax rate that no longer applies?”
“Is there an ETag check to avoid deleting a tax rate someone just edited?”
Tell an agent destructive · confirm first
Delete local tax rate {id}.
Delete tax rate {id} if its ETag is still {etag}.
PATCH /api/v1/admin/LocalTaxRates({id}) Change fields on a local tax rate · Update entity in EntitySet LocalTaxRates #
Ask an LLM
“Can I change just the percentage on an existing local tax rate?”
“How do I stop taxing freight for one postal code's rate without replacing it?”
Tell an agent
Change the rate on local tax rate {id} to {taxRate}.
Set tax freight on local tax rate {id} to {taxFreight}.
GET /api/v1/admin/LocalTaxRates/Default.Default() Call the Default function on local tax rates · Call operation Default #
Ask an LLM
“What does the Default function on the LocalTaxRates set return?”
“Where do I get the default local tax rate entity?”
Tell an agent
Call the Default function on LocalTaxRates.
Fetch the default local tax rate entity.
DELETE /api/v1/admin/localtaxrates/delete Bulk delete local tax rates · Local tax rates delete route #
Ask an LLM
“Can I delete many local tax rates at once by listing their ids?”
“Is there a bulk delete for outdated postal-code tax rates?”
Tell an agent destructive · confirm first
Bulk delete local tax rates {ids}.
Remove every tax rate in the id list {ids}.
GET /api/v1/admin/localtaxrates({key})/customproperties({custompropertyKey}) Get a custom property on a local tax rate · Local tax rates get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a local tax rate?”
“Can I fetch one extension field value from a tax rate record?”
Tell an agent
Get custom property {custompropertyKey} of local tax rate {key}.
Show custom field {custompropertyKey} on tax rate {key}.
GET /api/v1/admin/localtaxrates({key})/taxexemptions({taxexemptionKey}) Get a tax exemption linked to a local tax rate · Local tax rates get tax exemption by key and taxexemptionkey #
Ask an LLM
“Which tax exemption is attached to a given local tax rate?”
“Can I read one exemption record through the local tax rate it applies to?”
Tell an agent
Get tax exemption {taxexemptionKey} for local tax rate {key}.
Show exemption {taxexemptionKey} applied to tax rate {key}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/optimizely:optimizely-local-tax-rates-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-local-tax-rates-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Local Tax Rates API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Local Tax Rates
paths:
  /api/v1/admin/LocalTaxRates:
    get:
      tags:
      - Local Tax Rates
      summary: Returns the EntitySet LocalTaxRates
      operationId: LocalTaxRates_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Local Tax Rates
      summary: Post a new entity to EntitySet LocalTaxRates
      operationId: LocalTaxRates_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.LocalTaxRate'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/LocalTaxRates({id}):
    get:
      tags:
      - Local Tax Rates
      summary: Returns the entity with the key from LocalTaxRates
      operationId: LocalTaxRates_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Local Tax Rates
      summary: Replace entity in EntitySet LocalTaxRates
      operationId: LocalTaxRates_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.LocalTaxRate'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Local Tax Rates
      summary: Delete entity in EntitySet LocalTaxRates
      operationId: LocalTaxRates_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Local Tax Rates
      summary: Update entity in EntitySet LocalTaxRates
      operationId: LocalTaxRates_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.LocalTaxRate'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/LocalTaxRates/Default.Default():
    get:
      tags:
      - Local Tax Rates
      summary: Call operation Default
      operationId: LocalTaxRates_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/localtaxrates/delete:
    delete:
      tags:
      - Local Tax Rates
      operationId: LocalTaxRates_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Local tax rates delete route
      x-summary-source: derived
  /api/v1/admin/localtaxrates({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Local Tax Rates
      operationId: LocalTaxRates_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Local tax rates get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/localtaxrates({key})/taxexemptions({taxexemptionKey}):
    get:
      tags:
      - Local Tax Rates
      operationId: LocalTaxRates_GetTaxExemptionByKeyAndTaxexemptionkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: taxexemptionKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Local tax rates get tax exemption by key and taxexemptionkey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.LocalTaxRate:
      required:
      - postalCode
      - taxCode
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        postalCode:
          maxLength: 50
          minLength: 0
          type: string
        taxRate:
          format: decimal
          type: number
        taxCode:
          maxLength: 50
          minLength: 0
          type: string
        taxFreight:
          type: boolean
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query