Brevo

Brevo Ecommerce API

The ecommerce API from Brevo — 15 operation(s) for ecommerce.

GitHub OpenAPI

Operations 18

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /orders/status Record or update an order's status · Managing the status of the order #
Ask an LLM
“How do I send an order and its status from my store into Brevo?”
“Can I include coupons and billing details when recording an order?”
Tell an agent
Record order {id} with status {status}, amount {amount}, products {products}, created {createdAt} and updated {updatedAt}.
Mark order {id} as {status}.
POST /orders/status/batch Create orders in batch · Create orders in batch #
Ask an LLM
“Can I upload many orders at once instead of one at a time?”
“Is there a way to import historical orders in bulk and get notified when done?”
Tell an agent
Create these orders in batch: {orders}.
Import historical orders {orders} and notify {notifyUrl} when finished.
GET /orders List orders · Get order details #
Ask an LLM
“What orders have been synced into my Brevo account?”
“Can I list only orders modified since a certain date?”
Tell an agent
List my ecommerce orders.
Show orders created since {createdSince}.
POST /products Create or update a product · Create/Update a product #
Ask an LLM
“How do I add a single product with price and SKU to my catalog?”
“What happens if I send a product ID that already exists?”
Tell an agent
Create product {id} named {name}.
Upsert product {id} named {name} with price {price} and SKU {sku}.
GET /products List and filter products · Return all your products #
Ask an LLM
“Which products are in my Brevo ecommerce catalog?”
“Can I filter products by price range or category?”
Tell an agent
List all my ecommerce products.
Show products in categories {categories}.
GET /products/{id} Get a product's details · Get a product's details #
Ask an LLM
“What is the stock level and price of a specific product?”
“Can I look up one product by its ID?”
Tell an agent
Show the details of product {id}.
Get product {id} with its images and categories.
POST /products/batch Create or update products in batch · Create products in batch #
Ask an LLM
“Can I upload many products in one request?”
“How many products can one batch hold?”
Tell an agent
Create these products in batch: {products}.
Batch-update existing products {products}.
POST /products/{id}/alerts/{type} Subscribe a contact to a product alert · Create a product alert for a contact #
Ask an LLM
“How do I notify a shopper when a product is back in stock?”
“Which contact identifiers can I use to register a product alert?”
Tell an agent
Create a {type} alert on product {id} for the contact.
Alert contact {contactIdentifiers} when product {id} is {type}.
GET /categories List product categories · Return all your categories #
Ask an LLM
“What product categories exist in my store catalog?”
“Can I search categories by name or modification date?”
Tell an agent
List all my product categories.
Find categories named {name}.
POST /categories Create or update a category · Create/Update a category #
Ask an LLM
“How do I add one product category with a URL?”
“Can I update a category's name by sending its existing ID?”
Tell an agent
Create category {id} named {name}.
Upsert category {id} with URL {url}.
GET /categories/{id} Get a category's details · Get a category details #
Ask an LLM
“What are the details of one product category?”
“Can I check whether a category was deleted?”
Tell an agent
Show category {id}.
Get the name and URL of category {id}.
POST /categories/batch Create or update categories in batch · Create categories in batch #
Ask an LLM
“Can I upload many product categories in one go?”
“What's the maximum number of categories in a single batch?”
Tell an agent
Create these categories in batch: {categories}.
Batch-update existing categories {categories}.
GET /ecommerce/attribution/metrics/{conversionSource}/{conversionSourceId} Get revenue attribution for one campaign · Get detailed attribution metrics for a single Brevo campaign or workflow #
Ask an LLM
“How much revenue did a single email campaign or workflow drive?”
“What is the average basket value attributed to one automation?”
Tell an agent
Show attribution metrics for {conversionSource} {conversionSourceId}.
Get orders and revenue driven by {conversionSource} {conversionSourceId}.
GET /ecommerce/attribution/products/{conversionSource}/{conversionSourceId} List products sold through one campaign · Get attributed product sales for a single Brevo campaign or workflow #
Ask an LLM
“Which products sold because of a particular campaign?”
“Can I see revenue per product for one workflow?”
Tell an agent
List products attributed to {conversionSource} {conversionSourceId}.
Show product-level sales for {conversionSource} {conversionSourceId}.
GET /ecommerce/attribution/metrics Compare attribution across campaigns · Get attribution metrics for one or more Brevo campaigns or workflows #
Ask an LLM
“Can I get combined revenue attribution for several email and SMS campaigns?”
“What revenue did my campaigns generate over a date range?”
Tell an agent
Get attribution metrics for email campaigns {emailCampaignIds}.
Show aggregated attribution from {periodFrom} to {periodTo}.
POST /ecommerce/activate Activate the eCommerce app · Activate the eCommerce app #
Ask an LLM
“How do I turn on Brevo eCommerce for my account?”
“What gives my account access to the ecommerce features?”
Tell an agent
Activate the eCommerce app on my account.
Enable eCommerce for the account with API key {api_key}.
POST /ecommerce/config/displayCurrency Set the ecommerce display currency · Set the ISO 4217 compliant display currency code for your Brevo account #
Ask an LLM
“Can I change the currency used in my ecommerce dashboard?”
“What format must the display currency code use?”
Tell an agent
Set my ecommerce display currency to {code}.
Switch dashboard currency to {code}.
GET /ecommerce/config/displayCurrency Get the ecommerce display currency · Get the ISO 4217 compliant display currency code for your Brevo account #
Ask an LLM
“What currency are my ecommerce reports shown in?”
“Which ISO 4217 code is configured for my store dashboard?”
Tell an agent
Show my ecommerce display currency.
Get the display currency for the account with API key {api_key}.

Documentation

📖
Documentation
https://developers.brevo.com/docs/loyalty-overview
📖
APIReference
https://developers.brevo.com/reference
📖
Documentation
https://developers.brevo.com/reference
📖
Documentation
https://developers.brevo.com/docs/getting-started-with-senders-and-domains
📖
Documentation
https://developers.brevo.com/docs/event-endpoints
📖
Documentation
https://developers.brevo.com/docs/custom-objects-management
📖
Documentation
https://developers.brevo.com/reference/get-wallet-pass-install-url

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/brevo/refs/heads/main/openapi/brevo-ecommerce-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/brevo/refs/heads/main/asyncapi/brevo-webhooks-asyncapi.yml

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/brevo:brevo-ecommerce-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

OpenAPI Specification

brevo-ecommerce-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ecommerce API
  version: 1.0.0
servers:
- url: https://api.brevo.com/v3
  description: https://api.brevo.com/v3
tags:


# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/brevo/refs/heads/main/openapi/brevo-ecommerce-api-openapi.yml