Optimizely

Optimizely Vat Codes API

The Vat Codes API from Optimizely — 6 operation(s) for vat codes.

GitHub OpenAPI
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/VatCodes List VAT codes · Returns the EntitySet VatCodes #
Ask an LLM
“How do I list every VAT code configured in the commerce admin?”
“Can I filter VAT codes by name?”
Tell an agent
List all VAT codes.
Find VAT codes matching {filter}.
POST /api/v1/admin/VatCodes Create a VAT code · Post a new entity to EntitySet VatCodes #
Ask an LLM
“How do I add a new VAT code for taxing products?”
“What does a VAT code need besides a name?”
Tell an agent
Create a VAT code named {name} described as {description}.
Add VAT code {name} with description {description}.
GET /api/v1/admin/VatCodes({id}) Get a VAT code · Returns the entity with the key from VatCodes #
Ask an LLM
“How do I look up a single VAT code by ID?”
“Can I expand a VAT code to include its country rates?”
Tell an agent
Get VAT code {id}.
Show VAT code {id} expanded with {expand}.
PUT /api/v1/admin/VatCodes({id}) Replace a VAT code · Replace entity in EntitySet VatCodes #
Ask an LLM
“How do I overwrite a VAT code record in full?”
“Does replacing a VAT code require both name and description?”
Tell an agent
Replace VAT code {id} with name {name} and description {description}.
Overwrite every field of VAT code {id}.
DELETE /api/v1/admin/VatCodes({id}) Delete a VAT code · Delete entity in EntitySet VatCodes #
Ask an LLM
“How do I delete one VAT code?”
“Can I delete a VAT code only if it hasn't changed since I read it?”
Tell an agent destructive · confirm first
Delete VAT code {id}.
Delete VAT code {id} if its ETag is {etag}.
PATCH /api/v1/admin/VatCodes({id}) Update a VAT code · Update entity in EntitySet VatCodes #
Ask an LLM
“How do I rename an existing VAT code?”
“Can I change just a VAT code's description?”
Tell an agent
Rename VAT code {id} to {name}.
Change the description of VAT code {id} to {description}.
GET /api/v1/admin/VatCodes/Default.Default() Get a default VAT code template · Call operation Default #
Ask an LLM
“What default values does a new VAT code start with?”
“Can I fetch a blank VAT code template?”
Tell an agent
Fetch the default VAT code template.
Show me the defaults for a new VAT code.
DELETE /api/v1/admin/vatcodes/delete Bulk delete VAT codes · Vat codes delete route #
Ask an LLM
“How do I delete several VAT codes at once?”
“Can I remove VAT codes by passing a list of IDs?”
Tell an agent destructive · confirm first
Bulk delete the VAT codes {ids}.
Remove these VAT codes in one call: {ids}.
GET /api/v1/admin/vatcodes({key})/countryvatrates({countryvatrateKey}) Get a country VAT rate for a VAT code · Vat codes get country vat rate by key and countryvatratekey #
Ask an LLM
“What VAT rate applies to a VAT code in a particular country?”
“Can I look up one country rate under a VAT code?”
Tell an agent
Get country VAT rate {countryvatrateKey} for VAT code {key}.
Show the country rate {countryvatrateKey} under VAT code {key}.
GET /api/v1/admin/vatcodes({key})/customproperties({custompropertyKey}) Get a custom property on a VAT code · Vat codes get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a VAT code?”
“Can I fetch one extra property from a VAT code record?”
Tell an agent
Get custom property {custompropertyKey} on VAT code {key}.
Show VAT code {key}'s custom property {custompropertyKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-vat-codes-api-openapi.yml

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-vat-codes-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.

GitHub Google LinkedIn

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

OpenAPI Specification

optimizely-vat-codes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Vat Codes API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: VAT Codes
paths:
  /api/v1/admin/VatCodes:
    get:
      tags:
      - VAT Codes
      summary: Returns the EntitySet VatCodes
      operationId: VatCodes_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:
      - VAT Codes
      summary: Post a new entity to EntitySet VatCodes
      operationId: VatCodes_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.VatCode'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/VatCodes({id}):
    get:
      tags:
      - VAT Codes
      summary: Returns the entity with the key from VatCodes
      operationId: VatCodes_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:
      - VAT Codes
      summary: Replace entity in EntitySet VatCodes
      operationId: VatCodes_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.VatCode'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - VAT Codes
      summary: Delete entity in EntitySet VatCodes
      operationId: VatCodes_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:
      - VAT Codes
      summary: Update entity in EntitySet VatCodes
      operationId: VatCodes_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.VatCode'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/VatCodes/Default.Default():
    get:
      tags:
      - VAT Codes
      summary: Call operation Default
      operationId: VatCodes_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/vatcodes/delete:
    delete:
      tags:
      - VAT Codes
      operationId: VatCodes_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: Vat codes delete route
      x-summary-source: derived
  /api/v1/admin/vatcodes({key})/countryvatrates({countryvatrateKey}):
    get:
      tags:
      - VAT Codes
      operationId: VatCodes_GetCountryVatRateByKeyAndCountryvatratekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: countryvatrateKey
        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: Vat codes get country vat rate by key and countryvatratekey
      x-summary-source: derived
  /api/v1/admin/vatcodes({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - VAT Codes
      operationId: VatCodes_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: Vat codes get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.VatCode:
      required:
      - name
      - description
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 100
          minLength: 0
          type: string
        description:
          maxLength: 100
          minLength: 0
          type: string
        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