All URIs are relative to https://api.brevo.com/v3
| Method | HTTP request | Description |
|---|---|---|
| CreateBatchOrder | Post /orders/status/batch | Create orders in batch |
| CreateOrder | Post /orders/status | Managing the status of the order |
| CreateUpdateBatchCategory | Post /categories/batch | Create categories in batch |
| CreateUpdateBatchProducts | Post /products/batch | Create products in batch |
| CreateUpdateCategory | Post /categories | Create/Update a category |
| CreateUpdateProduct | Post /products | Create/Update a product |
| EcommerceActivatePost | Post /ecommerce/activate | Activate the eCommerce app |
| EcommerceAttributionMetricsConversionSourceConversionSourceIdGet | Get /ecommerce/attribution/metrics/{conversionSource}/{conversionSourceId} | Get detailed attribution metrics for a single Brevo campaign |
| EcommerceAttributionMetricsGet | Get /ecommerce/attribution/metrics | Get attribution metrics for one or more Brevo campaigns |
| EcommerceAttributionProductsConversionSourceConversionSourceIdGet | Get /ecommerce/attribution/products/{conversionSource}/{conversionSourceId} | Get attributed product sales for a single Brevo campaign |
| EcommerceConfigDisplayCurrencyGet | Get /ecommerce/config/displayCurrency | Get the ISO 4217 compliant display currency code for your Brevo account |
| GetCategories | Get /categories | Return all your categories |
| GetCategoryInfo | Get /categories/{id} | Get a category details |
| GetOrders | Get /orders | Get order details |
| GetProductInfo | Get /products/{id} | Get a product's details |
| GetProducts | Get /products | Return all your products |
| SetConfigDisplayCurrency | Post /ecommerce/config/displayCurrency | Set the ISO 4217 compliant display currency code for your Brevo account |
CreateBatchOrder(ctx, orderBatch) Create orders in batch
Create multiple orders at one time instead of one order at a time
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| orderBatch | OrderBatch |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateOrder(ctx, order) Managing the status of the order
Manages the transactional status of the order
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| order | Order |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateUpdateBatchCategoryModel CreateUpdateBatchCategory(ctx, createUpdateBatchCategory) Create categories in batch
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createUpdateBatchCategory | CreateUpdateBatchCategory | Values to create a batch of categories |
CreateUpdateBatchCategoryModel
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateUpdateBatchProductsModel CreateUpdateBatchProducts(ctx, createUpdateBatchProducts) Create products in batch
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createUpdateBatchProducts | CreateUpdateBatchProducts | Values to create a batch of products |
CreateUpdateBatchProductsModel
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateCategoryModel CreateUpdateCategory(ctx, createUpdateCategory) Create/Update a category
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createUpdateCategory | CreateUpdateCategory | Values to create/update a category |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateProductModel CreateUpdateProduct(ctx, createUpdateProduct) Create/Update a product
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createUpdateProduct | CreateUpdateProduct | Values to create/update a product |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
EcommerceActivatePost(ctx, ) Activate the eCommerce app
Getting access to Brevo eCommerce.
This endpoint does not need any parameter.
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2006 EcommerceAttributionMetricsConversionSourceConversionSourceIdGet(ctx, conversionSource, conversionSourceId) Get detailed attribution metrics for a single Brevo campaign
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| conversionSource | string | The Brevo campaign type for which data will be retrieved | |
| conversionSourceId | float32 | The Brevo campaign id for which data will be retrieved |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2005 EcommerceAttributionMetricsGet(ctx, optional) Get attribution metrics for one or more Brevo campaigns
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *EcommerceAttributionMetricsGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a EcommerceAttributionMetricsGetOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| periodFrom | optional.Time | When getting metrics for a specific period, define the starting datetime in RFC3339 format | |
| periodTo | optional.Time | When getting metrics for a specific period, define the end datetime in RFC3339 format | |
| emailCampaignId | optional.Interface of []float32 | The email campaign id(s) to get metrics for |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2007 EcommerceAttributionProductsConversionSourceConversionSourceIdGet(ctx, conversionSource, conversionSourceId) Get attributed product sales for a single Brevo campaign
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| conversionSource | string | The Brevo campaign type for which data will be retrieved | |
| conversionSourceId | float32 | The Brevo campaign id for which data will be retrieved |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InlineResponse2004 EcommerceConfigDisplayCurrencyGet(ctx, ) Get the ISO 4217 compliant display currency code for your Brevo account
This endpoint does not need any parameter.
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCategories GetCategories(ctx, optional) Return all your categories
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetCategoriesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetCategoriesOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | optional.Int64 | Number of documents per page | [default to 50] |
| offset | optional.Int64 | Index of the first document in the page | [default to 0] |
| sort | optional.String | Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed | [default to desc] |
| ids | optional.Interface of []string | Filter by category ids | |
| name | optional.String | Filter by category name | |
| modifiedSince | optional.String | Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | |
| createdSince | optional.String | Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetCategoryDetails GetCategoryInfo(ctx, id) Get a category details
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Category ID |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetOrders GetOrders(ctx, optional) Get order details
Get all the orders
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetOrdersOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetOrdersOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | optional.Int64 | Number of documents per page | [default to 50] |
| offset | optional.Int64 | Index of the first document in the page | [default to 0] |
| sort | optional.String | Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed | [default to desc] |
| modifiedSince | optional.String | Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | |
| createdSince | optional.String | Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetProductDetails GetProductInfo(ctx, id) Get a product's details
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | Product ID |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetProducts GetProducts(ctx, optional) Return all your products
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetProductsOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetProductsOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | optional.Int64 | Number of documents per page | [default to 50] |
| offset | optional.Int64 | Index of the first document in the page | [default to 0] |
| sort | optional.String | Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed | [default to desc] |
| ids | optional.Interface of []string | Filter by product ids | |
| name | optional.String | Filter by product name, minimum 3 characters should be present for search | |
| priceLte | optional.Float32 | Price filter for products less than and equals to particular amount | |
| priceGte | optional.Float32 | Price filter for products greater than and equals to particular amount | |
| priceLt | optional.Float32 | Price filter for products less than particular amount | |
| priceGt | optional.Float32 | Price filter for products greater than particular amount | |
| priceEq | optional.Float32 | Price filter for products equals to particular amount | |
| priceNe | optional.Float32 | Price filter for products not equals to particular amount | |
| categories | optional.Interface of []string | Filter by category ids | |
| modifiedSince | optional.String | Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | |
| createdSince | optional.String | Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SetConfigDisplayCurrency SetConfigDisplayCurrency(ctx, setConfigDisplayCurrency) Set the ISO 4217 compliant display currency code for your Brevo account
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| setConfigDisplayCurrency | SetConfigDisplayCurrency | set ISO 4217 compliant display currency code payload |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]