Generated by API Evangelist
Written by API Evangelist tooling for Vendasta's API. It is a proposal applied on top of the contract, not a document Vendasta publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Sales Orders API
version: 1.0.0
extends: openapi/vendasta-sales-orders-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/v1/order/create'].post
update:
x-apievangelist-phrasing:
intent: Create a sales order
effect: write
questions:
- How do I place a sales order for a business with line items?
- Can I set a contract duration and requested activation date on a new order?
- Is there an idempotency key to avoid creating duplicate orders?
instructions:
- text: Create a sales order for business {businessId} with line items {lineItems}.
slots:
businessId: requestBody.businessId
lineItems: requestBody.lineItems
- text: Place an order for {businessId} assigned to salesperson {salespersonId} with notes {notes}.
slots:
businessId: requestBody.businessId
salespersonId: requestBody.salespersonId
notes: requestBody.notes
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/order/get'].post
update:
x-apievangelist-phrasing:
intent: Get one sales order
effect: read
questions:
- What's the status and content of a specific sales order?
- Can I retrieve a single order when I know its ID and business?
instructions:
- text: Get sales order {orderId} for business {businessId}.
slots:
orderId: requestBody.orderId
businessId: requestBody.businessId
- text: Show me the details of order {orderId}.
slots:
orderId: requestBody.orderId
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/order/list'].post
update:
x-apievangelist-phrasing:
intent: List a partner's sales orders
effect: read
questions:
- Which sales orders has my partner account received?
- Can I filter and sort the list of orders and page through them?
instructions:
- text: List sales orders for partner {partnerId}.
slots:
partnerId: requestBody.partnerId
- text: Show {pageSize} orders for {partnerId} sorted by {sortOption}.
slots:
pageSize: requestBody.pageSize
partnerId: requestBody.partnerId
sortOption: requestBody.sortOption
method: generated
generated: '2026-10-01'
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.