How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Brevo

Brevo Ecommerce API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Brevo Ecommerce API is one of 53 APIs that Brevo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include E-Commerce. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 18 operations across 15 paths, and defines 78 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.brevo.com/v3.

18 operations 15 paths 78 schemas 9 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.brevo.com/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Brevo Ecommerce API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key).

  • api-key — The API key should be passed in the request headers as api-key for authentication.

Paths & Operations 18

Across 15 paths, the API surfaces 18 operations — 9 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

ecommerce 18
POST
/orders/status
Managing the status of the order
createOrder 1 param body → 204400
POST
/orders/status/batch
Create orders in batch
createBatchOrder 1 param body → 202400
GET
/orders
Get order details
getOrders 6 params → 200400
POST
/products
Create/Update a product
createUpdateProduct 1 param body → 201400
GET
/products
Return all your products
getProducts 24 params → 200400
GET
/products/{id}
Get a product's details
getProductInfo 2 params → 200400404
POST
/products/batch
Create products in batch
createUpdateBatchProducts 1 param body → 201400
POST
/products/{id}/alerts/{type}
Create a product alert for a contact
createProductAlert 3 params body → 204400401403404
GET
/categories
Return all your categories
getCategories 9 params → 200400
POST
/categories
Create/Update a category
createUpdateCategory 1 param body → 201400
GET
/categories/{id}
Get a category details
getCategoryInfo 2 params → 200400404
POST
/categories/batch
Create categories in batch
createUpdateBatchCategory 1 param body → 201400
GET
/ecommerce/attribution/metrics/{conversionSource}/{conversionSourceId}
Get detailed attribution metrics for a single Brevo campaign or workflow
getDetailedAttributionMetricsForASingleBrevoCampaignOrWorkflow 3 params → 200400
GET
/ecommerce/attribution/products/{conversionSource}/{conversionSourceId}
Get attributed product sales for a single Brevo campaign or workflow
getAttributedProductSalesForASingleBrevoCampaignOrWorkflow 3 params → 200400
GET
/ecommerce/attribution/metrics
Get attribution metrics for one or more Brevo campaigns or workflows
getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows 7 params → 200400
POST
/ecommerce/activate
Activate the eCommerce app
activateTheECommerceApp 1 param → 200401404
POST
/ecommerce/config/displayCurrency
Set the ISO 4217 compliant display currency code for your Brevo account
setConfigDisplayCurrency 1 param body → 200400401403422
GET
/ecommerce/config/displayCurrency
Get the ISO 4217 compliant display currency code for your Brevo account
getTheIso4217CompliantDisplayCurrencyCodeForYourBrevoAccount 1 param → 200400401403

Schemas 78

The contract defines 78 schemas that model the data the API accepts and returns. The most detailed are getProductDetails (19 properties), ProductsBatchPostRequestBodyContentApplicationJsonSchemaProductsItems (15 properties), order (11 properties), OrderBilling (8 properties). Each schema is shown below with its type and property counts.

OrderMetaInfo
Ecommerce_getCategories_Response_200
object
2 properties 2 required
Ecommerce_activateTheECommerceApp_Response_200
object
Empty response body
GetProductInfoRequestBadRequestError
object
2 properties 2 required
CreateBatchOrderRequestBadRequestError
object
2 properties 2 required
EcommerceActivatePostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
GetProductDetailsMetaInfo
object
Meta data of product such as description, vendor, producer, stock level, etc.
GetAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflowsRequestBadRequestError
object
2 properties 2 required
Ecommerce_setConfigDisplayCurrency_Response_200
object
1 property 1 required
OrderIdentifiers
object
Identifies the contact associated with the order.
4 properties
SetConfigDisplayCurrencyRequestBadRequestError
object
2 properties 2 required
OrderProductsItems
object
Details for the Products in an order.
5 properties 2 required
SetConfigDisplayCurrencyRequestUnauthorizedError
object
2 properties 2 required
ProductsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
EcommerceConfigDisplayCurrencyGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
order
object
11 properties 6 required
Ecommerce_getAttributedProductSalesForASingleBrevoCampaignOrWorkflow_Response_200
object
1 property 1 required
EcommerceConfigDisplayCurrencyPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
OrdersStatusPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ActivateTheECommerceAppRequestNotFoundError
object
2 properties 2 required
GetCategoriesRequestBadRequestError
object
2 properties 2 required
ProductsPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
Ecommerce_getDetailedAttributionMetricsForASingleBrevoCampaignOrWorkflow_Response_200
object
6 properties 6 required
CreateUpdateProductRequestBadRequestError
object
2 properties 2 required
Ecommerce_createUpdateBatchProducts_Response_201
object
2 properties
CategoriesGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
CreateUpdateBatchCategoryRequestBadRequestError
object
2 properties 2 required
GetOrdersRequestBadRequestError
object
2 properties 2 required
CategoriesPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ProductsIdGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
CreateUpdateCategoryRequestBadRequestError
object
2 properties 2 required
EcommerceAttributionMetricsConversionSourceConversionSourceIdGetResponsesContentApplicationJsonSchemaConversionSource
string
CategoriesGetParametersSort
string
errorModel
object
2 properties 1 required
Ecommerce_getAttributionMetricsForOneOrMoreBrevoCampaignsOrWorkflows_Response_200
object
2 properties 2 required
ActivateTheECommerceAppRequestUnauthorizedError
object
2 properties 2 required
ProductsBatchPostRequestBodyContentApplicationJsonSchemaProductsItems
object
15 properties 2 required
CategoriesBatchPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
Ecommerce_getOrders_Response_200
object
Empty response body
OrdersGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
Ecommerce_createBatchOrder_Response_202
object
2 properties 1 required
Ecommerce_getProducts_Response_200
object
2 properties 2 required
GetCategoryInfoRequestNotFoundError
object
2 properties 2 required
CategoriesIdGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
EcommerceAttributionProductsConversionSourceConversionSourceIdGetParametersConversionSource
string
Ecommerce_createUpdateBatchCategory_Response_201
object
2 properties
CategoriesBatchPostRequestBodyContentApplicationJsonSchemaCategoriesItems
object
5 properties 1 required
ProductsGetParametersSort
string
GetAttributedProductSalesForASingleBrevoCampaignOrWorkflowRequestBadRequestError
object
2 properties 2 required
CreateOrderRequestBadRequestError
object
2 properties 2 required
ConversionSourceMetricsConversionSource
string
GetTheIso4217CompliantDisplayCurrencyCodeForYourBrevoAccountRequestUnauthorizedError
object
2 properties 2 required
EcommerceAttributionMetricsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
EcommerceAttributionProductsConversionSourceConversionSourceIdGetResponsesContentApplicationJsonSchemaProductsItems
object
8 properties 1 required
getProductDetails
object
19 properties 6 required
GetDetailedAttributionMetricsForASingleBrevoCampaignOrWorkflowRequestBadRequestError
object
2 properties 2 required
getCategoryDetails
object
6 properties 5 required
GetTheIso4217CompliantDisplayCurrencyCodeForYourBrevoAccountRequestBadRequestError
object
2 properties 2 required
ProductsBatchPostRequestBodyContentApplicationJsonSchemaProductsItemsMetaInfo
GetProductsRequestBadRequestError
object
2 properties 2 required
Ecommerce_getTheIso4217CompliantDisplayCurrencyCodeForYourBrevoAccount_Response_200
object
1 property 1 required
ProductsIdAlertsTypePostRequestBodyContentApplicationJsonSchemaContactIdentifiers
object
3 properties
ProductsPostRequestBodyContentApplicationJsonSchemaMetaInfo
EcommerceAttributionProductsConversionSourceConversionSourceIdGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
EcommerceAttributionMetricsConversionSourceConversionSourceIdGetParametersConversionSource
string
OrdersStatusBatchPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ProductsBatchPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
GetCategoryInfoRequestBadRequestError
object
2 properties 2 required
CreateUpdateBatchProductsRequestBadRequestError
object
2 properties 2 required
OrderBilling
object
Billing details of an order.
8 properties
ConversionSourceMetrics
object
5 properties 5 required
EcommerceAttributionMetricsGetResponsesContentApplicationJsonSchemaTotals
object
Attribution list aggregated totals
3 properties 3 required
ProductsIdAlertsTypePostParametersType
string
OrdersGetParametersSort
string
Ecommerce_createUpdateCategory_Response_201
object
1 property
EcommerceAttributionMetricsConversionSourceConversionSourceIdGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
Ecommerce_createUpdateProduct_Response_201
object
1 property
ProductsGetParametersSortByField
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brevo-ecommerce-api-openapi.yml Raw ↑

Other APIs Brevo publishes across the network.

brevo Agent Status API
AE Profile APIs.io
brevo Automated Messages API
AE Profile APIs.io
brevo Campaign Statistics API
AE Profile APIs.io
brevo Categories API
AE Profile APIs.io
brevo Contact Attributes API
AE Profile APIs.io
brevo Contact Lists API
AE Profile APIs.io
brevo Contacts API
AE Profile APIs.io
brevo Email Activity API
AE Profile APIs.io
brevo Email Campaigns API
AE Profile APIs.io
brevo Email Templates API
AE Profile APIs.io
brevo Folders API
AE Profile APIs.io
brevo Import API
AE Profile APIs.io
#E-Commerce
← Back to B APIs
API Details
ID
brevo:brevo-ecommerce-api
Base URL
https://api.brevo.com/v3
Docs
https://developers.brevo.com/reference
Provider
Brevo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=brevo-ecommerce-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/brevo-ecommerce-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Brevo Ecommerce API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.