Generated by API Evangelist
Written by API Evangelist tooling for Square's API. It is a proposal applied on top of the contract, not a document Square publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Square V1Transactions API
version: 1.0.0
extends: openapi/square-v1transactions-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['/v1/{location_id}/orders'].get
update:
x-apievangelist-phrasing:
intent: List online store orders (V1)
effect: read
questions:
- Which online store orders came in at a location under the V1 API?
- Can I sort V1 online store orders oldest first?
instructions:
- text: List V1 online store orders for location {location_id}.
slots:
location_id: path.location_id
- text: List V1 orders at {location_id} in {order} order, {limit} at a time.
slots:
location_id: path.location_id
order: query.order
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/{location_id}/orders/{order_id}'].get
update:
x-apievangelist-phrasing:
intent: Get an online store order with history (V1)
effect: read
questions:
- What is the full history of one V1 online store order?
- Can I see everything about a single online order from the V1 API?
instructions:
- text: Get V1 order {order_id} at location {location_id}.
slots:
order_id: path.order_id
location_id: path.location_id
- text: Show the history of online store order {order_id} at {location_id}.
slots:
order_id: path.order_id
location_id: path.location_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/{location_id}/orders/{order_id}'].put
update:
x-apievangelist-phrasing:
intent: Complete, cancel or refund an online store order (V1)
effect: write
questions:
- How do I mark a V1 online store order as shipped with a tracking number?
- Can I cancel or refund a V1 online order and leave a note?
instructions:
- text: Apply action {action} to V1 order {order_id} at location {location_id}.
slots:
action: requestBody.action
order_id: path.order_id
location_id: path.location_id
- text: Complete V1 order {order_id} at {location_id} with action {action} and tracking {shipped_tracking_number}.
slots:
order_id: path.order_id
location_id: path.location_id
action: requestBody.action
shipped_tracking_number: requestBody.shipped_tracking_number
method: generated
generated: '2026-09-26'
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.