Avalara · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Avalara Business Orders API

3 actions 3 updates phrasing extends openapi/avalara-orders-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Avalara's API. It is a proposal applied on top of the contract, not a document Avalara publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/orders'].post

$.paths['/orders/{orderId}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara Business Orders API
  version: 1.0.0
extends: openapi/avalara-orders-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/orders'].post
  update:
    x-apievangelist-phrasing:
      intent: Place a sales order for Avalara products
      effect: write
      questions:
      - Can I place an order for Avalara services on behalf of a customer account?
      - Is it possible to attach a campaign ID to a new sales order?
      instructions:
      - text: Create a sales order for account {accountId} with products {products}.
        slots:
          accountId: requestBody.accountId
          products: requestBody.products
      - text: Order {products} for account {accountId} under campaign {campaignId}.
        slots:
          products: requestBody.products
          accountId: requestBody.accountId
          campaignId: requestBody.campaignId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders/{orderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sales order
      effect: read
      questions:
      - Can I check the details of a sales order I placed?
      - What products were on a specific order?
      instructions:
      - text: Get order {orderId}.
        slots:
          orderId: path.orderId
      - text: Show the details of sales order {orderId}.
        slots:
          orderId: path.orderId
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
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 overlay

curl "https://apis.io/api/v1/overlays/avalara-orders-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?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.