Generated by API Evangelist
Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Storefront API V1 Invoices API
version: 1.0.0
extends: openapi/optimizely-invoices-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: 3
- target: $.paths['/api/v1/invoices'].get
update:
x-apievangelist-phrasing:
intent: Search a customer's invoices
effect: read
questions:
- Which of my invoices are still open?
- Can I find invoices by order number, PO number or date range?
- How do I page through my invoice history?
instructions:
- text: List my open invoices ({showOpenOnly}).
slots:
showOpenOnly: query.parameter.showOpenOnly
- text: Find invoices for order {orderNumber}.
slots:
orderNumber: query.parameter.orderNumber
- text: Show invoices dated from {fromDate} to {toDate}.
slots:
fromDate: query.parameter.fromDate
toDate: query.parameter.toDate
- text: Find invoices with PO number {poNumber}.
slots:
poNumber: query.parameter.poNumber
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/invoices/{invoiceId}'].get
update:
x-apievangelist-phrasing:
intent: Get one invoice
effect: read
questions:
- What are the line items and totals on a specific invoice?
- Can I pull up a single invoice by its ID?
instructions:
- text: Get invoice {invoiceId}.
slots:
invoiceId: path.invoiceId
- text: Show the details of invoice {invoiceId}.
slots:
invoiceId: path.invoiceId
method: generated
generated: '2026-09-26'
- target: $.paths['/api/v1/invoices/shareinvoice'].post
update:
x-apievangelist-phrasing:
intent: Email an invoice to someone
effect: write
questions:
- How do I share an invoice by email with a colleague?
- Can I add a subject and message when sending an invoice?
instructions:
- text: Email invoice {entityId} to {emailTo}.
slots:
entityId: requestBody.entityId
emailTo: requestBody.emailTo
- text: Share invoice {entityId} with {emailTo}, subject {subject}, message {message}.
slots:
entityId: requestBody.entityId
emailTo: requestBody.emailTo
subject: requestBody.subject
message: requestBody.message
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.