Generated by API Evangelist
Written by API Evangelist tooling for Brevo's API. It is a proposal applied on top of the contract, not a document Brevo publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Brevo eCommerce Orders API
version: 1.0.0
extends: openapi/brevo-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: 3
- target: $.paths['/orders/status'].post
update:
x-apievangelist-phrasing:
intent: Create or update an order
effect: write
questions:
- How do I send a store order to Brevo for revenue attribution?
- Can I update an order's status after it ships or is refunded?
instructions:
- text: Record order {id} for {email} with status {status}, amount {amount}, products {products}, created {createdAt}.
slots:
id: requestBody.id
email: requestBody.email
status: requestBody.status
amount: requestBody.amount
products: requestBody.products
createdAt: requestBody.createdAt
- text: Set order {id} to status {status} for {email}, amount {amount}, products {products}, created {createdAt}, updated {updatedAt}.
slots:
id: requestBody.id
status: requestBody.status
email: requestBody.email
amount: requestBody.amount
products: requestBody.products
createdAt: requestBody.createdAt
updatedAt: requestBody.updatedAt
method: generated
generated: '2026-09-26'
- target: $.paths['/orders/status/batch'].post
update:
x-apievangelist-phrasing:
intent: Create or update orders in bulk
effect: write
questions:
- Can I import a large batch of historical orders in one call?
- Is there a bulk way to sync order statuses?
instructions:
- text: 'Batch upsert these orders: {orders}.'
slots:
orders: requestBody.orders
- text: Sync the order list {orders} in a single request.
slots:
orders: requestBody.orders
method: generated
generated: '2026-09-26'
- target: $.paths['/orders'].get
update:
x-apievangelist-phrasing:
intent: List eCommerce orders
effect: read
questions:
- Which orders has Brevo recorded from my store?
- Can I see orders placed within a date range?
instructions:
- text: List my recorded orders.
- text: List orders from {startDate} to {endDate}.
slots:
startDate: query.startDate
endDate: query.endDate
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.