Package software.xdev.brevo.api

Class EcommerceApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.EcommerceApi

public class EcommerceApi
extends BaseApi

Field Summary

Fields inherited from class software.xdev.brevo.client.BaseApi

apiClient

Constructor Summary

Constructors

Constructor	Description
EcommerceApi()
EcommerceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CreatedBatchId	createBatchOrder(OrderBatch orderBatch)	Create orders in batch Create multiple orders at one time instead of one order at a time
CreatedBatchId	createBatchOrder(OrderBatch orderBatch, Map<String,String> additionalHeaders)	Create orders in batch Create multiple orders at one time instead of one order at a time
void	createOrder(Order order)	Managing the status of the order Manages the transactional status of the order
void	createOrder(Order order, Map<String,String> additionalHeaders)	Managing the status of the order Manages the transactional status of the order
CreateUpdateBatchCategoryModel	createUpdateBatchCategory(CreateUpdateBatchCategory createUpdateBatchCategory)	Create categories in batch
CreateUpdateBatchCategoryModel	createUpdateBatchCategory(CreateUpdateBatchCategory createUpdateBatchCategory, Map<String,String> additionalHeaders)	Create categories in batch
CreateUpdateBatchProductsModel	createUpdateBatchProducts(CreateUpdateBatchProducts createUpdateBatchProducts)	Create products in batch
CreateUpdateBatchProductsModel	createUpdateBatchProducts(CreateUpdateBatchProducts createUpdateBatchProducts, Map<String,String> additionalHeaders)	Create products in batch
CreateCategoryModel	createUpdateCategory(CreateUpdateCategory createUpdateCategory)	Create/Update a category
CreateCategoryModel	createUpdateCategory(CreateUpdateCategory createUpdateCategory, Map<String,String> additionalHeaders)	Create/Update a category
CreateProductModel	createUpdateProduct(CreateUpdateProduct createUpdateProduct)	Create/Update a product
CreateProductModel	createUpdateProduct(CreateUpdateProduct createUpdateProduct, Map<String,String> additionalHeaders)	Create/Update a product
void	ecommerceActivatePost()	Activate the eCommerce app Getting access to Brevo eCommerce.
void	ecommerceActivatePost(Map<String,String> additionalHeaders)	Activate the eCommerce app Getting access to Brevo eCommerce.
GetCategories	getCategories(Long limit, Long offset, String sort, List<String> ids, String name, String modifiedSince, String createdSince)	Return all your categories
GetCategories	getCategories(Long limit, Long offset, String sort, List<String> ids, String name, String modifiedSince, String createdSince, Map<String,String> additionalHeaders)	Return all your categories
GetCategoryDetails	getCategoryInfo(String id)	Get a category details
GetCategoryDetails	getCategoryInfo(String id, Map<String,String> additionalHeaders)	Get a category details
void	getOrders(Long limit, Long offset, String sort, String modifiedSince, String createdSince)	Get order details Get all the orders
void	getOrders(Long limit, Long offset, String sort, String modifiedSince, String createdSince, Map<String,String> additionalHeaders)	Get order details Get all the orders
GetProductDetails	getProductInfo(String id)	Get a product's details
GetProductDetails	getProductInfo(String id, Map<String,String> additionalHeaders)	Get a product's details
GetProducts	getProducts(Long limit, Long offset, String sort, List<String> ids, String name, BigDecimal priceLte, BigDecimal priceGte, BigDecimal priceLt, BigDecimal priceGt, BigDecimal priceEq, BigDecimal priceNe, List<String> categories, String modifiedSince, String createdSince)	Return all your products
GetProducts	getProducts(Long limit, Long offset, String sort, List<String> ids, String name, BigDecimal priceLte, BigDecimal priceGte, BigDecimal priceLt, BigDecimal priceGt, BigDecimal priceEq, BigDecimal priceNe, List<String> categories, String modifiedSince, String createdSince, Map<String,String> additionalHeaders)	Return all your products
<T> T	invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)	Directly invoke the API for the given URL.

Methods inherited from class software.xdev.brevo.client.BaseApi

getApiClient, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, setApiClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EcommerceApi

public EcommerceApi()

EcommerceApi

public EcommerceApi(ApiClient apiClient)

Method Details

createBatchOrder

public CreatedBatchId createBatchOrder(OrderBatch orderBatch)
                                throws ApiException

Create orders in batch Create multiple orders at one time instead of one order at a time

Parameters:

orderBatch - (required)

Returns:

CreatedBatchId

Throws:

ApiException - if fails to make API call

createBatchOrder

public CreatedBatchId createBatchOrder(OrderBatch orderBatch,
 Map<String,String> additionalHeaders)
                                throws ApiException

Create orders in batch Create multiple orders at one time instead of one order at a time

Parameters:

orderBatch - (required)

additionalHeaders - additionalHeaders for this call

Returns:

CreatedBatchId

Throws:

ApiException - if fails to make API call

createOrder

public void createOrder(Order order)
                 throws ApiException

Managing the status of the order Manages the transactional status of the order

Parameters:

order - (required)

Throws:

ApiException - if fails to make API call

createOrder

public void createOrder(Order order,
 Map<String,String> additionalHeaders)
                 throws ApiException

Managing the status of the order Manages the transactional status of the order

Parameters:

order - (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

createUpdateBatchCategory

public CreateUpdateBatchCategoryModel createUpdateBatchCategory(CreateUpdateBatchCategory createUpdateBatchCategory)
                                                         throws ApiException

Create categories in batch

Parameters:

createUpdateBatchCategory - Values to create a batch of categories (required)

Returns:

CreateUpdateBatchCategoryModel

Throws:

ApiException - if fails to make API call

createUpdateBatchCategory

public CreateUpdateBatchCategoryModel createUpdateBatchCategory(CreateUpdateBatchCategory createUpdateBatchCategory,
 Map<String,String> additionalHeaders)
                                                         throws ApiException

Create categories in batch

Parameters:

createUpdateBatchCategory - Values to create a batch of categories (required)

additionalHeaders - additionalHeaders for this call

Returns:

CreateUpdateBatchCategoryModel

Throws:

ApiException - if fails to make API call

createUpdateBatchProducts

public CreateUpdateBatchProductsModel createUpdateBatchProducts(CreateUpdateBatchProducts createUpdateBatchProducts)
                                                         throws ApiException

Create products in batch

Parameters:

createUpdateBatchProducts - Values to create a batch of products (required)

Returns:

CreateUpdateBatchProductsModel

Throws:

ApiException - if fails to make API call

createUpdateBatchProducts

public CreateUpdateBatchProductsModel createUpdateBatchProducts(CreateUpdateBatchProducts createUpdateBatchProducts,
 Map<String,String> additionalHeaders)
                                                         throws ApiException

Create products in batch

Parameters:

createUpdateBatchProducts - Values to create a batch of products (required)

additionalHeaders - additionalHeaders for this call

Returns:

CreateUpdateBatchProductsModel

Throws:

ApiException - if fails to make API call

createUpdateCategory

public CreateCategoryModel createUpdateCategory(CreateUpdateCategory createUpdateCategory)
                                         throws ApiException

Create/Update a category

Parameters:

createUpdateCategory - Values to create/update a category (required)

Returns:

CreateCategoryModel

Throws:

ApiException - if fails to make API call

createUpdateCategory

public CreateCategoryModel createUpdateCategory(CreateUpdateCategory createUpdateCategory,
 Map<String,String> additionalHeaders)
                                         throws ApiException

Create/Update a category

Parameters:

createUpdateCategory - Values to create/update a category (required)

additionalHeaders - additionalHeaders for this call

Returns:

CreateCategoryModel

Throws:

ApiException - if fails to make API call

createUpdateProduct

public CreateProductModel createUpdateProduct(CreateUpdateProduct createUpdateProduct)
                                       throws ApiException

Create/Update a product

Parameters:

createUpdateProduct - Values to create/update a product (required)

Returns:

CreateProductModel

Throws:

ApiException - if fails to make API call

createUpdateProduct

public CreateProductModel createUpdateProduct(CreateUpdateProduct createUpdateProduct,
 Map<String,String> additionalHeaders)
                                       throws ApiException

Create/Update a product

Parameters:

createUpdateProduct - Values to create/update a product (required)

additionalHeaders - additionalHeaders for this call

Returns:

CreateProductModel

Throws:

ApiException - if fails to make API call

ecommerceActivatePost

public void ecommerceActivatePost()
                           throws ApiException

Activate the eCommerce app Getting access to Brevo eCommerce.

Throws:

ApiException - if fails to make API call

ecommerceActivatePost

public void ecommerceActivatePost(Map<String,String> additionalHeaders)
                           throws ApiException

Activate the eCommerce app Getting access to Brevo eCommerce.

Parameters:

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getCategories

public GetCategories getCategories(Long limit,
 Long offset,
 String sort,
 List<String> ids,
 String name,
 String modifiedSince,
 String createdSince)
                            throws ApiException

Return all your categories

Parameters:

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document in the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

ids - Filter by category ids (optional)

name - Filter by category name (optional)

modifiedSince - 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.** (optional)

createdSince - 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.** (optional)

Returns:

GetCategories

Throws:

ApiException - if fails to make API call

getCategories

public GetCategories getCategories(Long limit,
 Long offset,
 String sort,
 List<String> ids,
 String name,
 String modifiedSince,
 String createdSince,
 Map<String,String> additionalHeaders)
                            throws ApiException

Return all your categories

Parameters:

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document in the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

ids - Filter by category ids (optional)

name - Filter by category name (optional)

modifiedSince - 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.** (optional)

createdSince - 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.** (optional)

additionalHeaders - additionalHeaders for this call

Returns:

GetCategories

Throws:

ApiException - if fails to make API call

getCategoryInfo

public GetCategoryDetails getCategoryInfo(String id)
                                   throws ApiException

Get a category details

Parameters:

id - Category ID (required)

Returns:

GetCategoryDetails

Throws:

ApiException - if fails to make API call

getCategoryInfo

public GetCategoryDetails getCategoryInfo(String id,
 Map<String,String> additionalHeaders)
                                   throws ApiException

Get a category details

Parameters:

id - Category ID (required)

additionalHeaders - additionalHeaders for this call

Returns:

GetCategoryDetails

Throws:

ApiException - if fails to make API call

getOrders

public void getOrders(Long limit,
 Long offset,
 String sort,
 String modifiedSince,
 String createdSince)
               throws ApiException

Get order details Get all the orders

Parameters:

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document in the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

modifiedSince - 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.** (optional)

createdSince - 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.** (optional)

Throws:

ApiException - if fails to make API call

getOrders

public void getOrders(Long limit,
 Long offset,
 String sort,
 String modifiedSince,
 String createdSince,
 Map<String,String> additionalHeaders)
               throws ApiException

Get order details Get all the orders

Parameters:

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document in the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

modifiedSince - 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.** (optional)

createdSince - 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.** (optional)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getProductInfo

public GetProductDetails getProductInfo(String id)
                                 throws ApiException

Get a product's details

Parameters:

id - Product ID (required)

Returns:

GetProductDetails

Throws:

ApiException - if fails to make API call

getProductInfo

public GetProductDetails getProductInfo(String id,
 Map<String,String> additionalHeaders)
                                 throws ApiException

Get a product's details

Parameters:

id - Product ID (required)

additionalHeaders - additionalHeaders for this call

Returns:

GetProductDetails

Throws:

ApiException - if fails to make API call

getProducts

public GetProducts getProducts(Long limit,
 Long offset,
 String sort,
 List<String> ids,
 String name,
 BigDecimal priceLte,
 BigDecimal priceGte,
 BigDecimal priceLt,
 BigDecimal priceGt,
 BigDecimal priceEq,
 BigDecimal priceNe,
 List<String> categories,
 String modifiedSince,
 String createdSince)
                        throws ApiException

Return all your products

Parameters:

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document in the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

ids - Filter by product ids (optional)

name - Filter by product name, minimum 3 characters should be present for search (optional)

priceLte - Price filter for products less than and equals to particular amount (optional)

priceGte - Price filter for products greater than and equals to particular amount (optional)

priceLt - Price filter for products less than particular amount (optional)

priceGt - Price filter for products greater than particular amount (optional)

priceEq - Price filter for products equals to particular amount (optional)

priceNe - Price filter for products not equals to particular amount (optional)

categories - Filter by product categories (optional)

modifiedSince - 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.** (optional)

createdSince - 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.** (optional)

Returns:

GetProducts

Throws:

ApiException - if fails to make API call

getProducts

public GetProducts getProducts(Long limit,
 Long offset,
 String sort,
 List<String> ids,
 String name,
 BigDecimal priceLte,
 BigDecimal priceGte,
 BigDecimal priceLt,
 BigDecimal priceGt,
 BigDecimal priceEq,
 BigDecimal priceNe,
 List<String> categories,
 String modifiedSince,
 String createdSince,
 Map<String,String> additionalHeaders)
                        throws ApiException

Return all your products

Parameters:

limit - Number of documents per page (optional, default to 50)

offset - Index of the first document in the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

ids - Filter by product ids (optional)

name - Filter by product name, minimum 3 characters should be present for search (optional)

priceLte - Price filter for products less than and equals to particular amount (optional)

priceGte - Price filter for products greater than and equals to particular amount (optional)

priceLt - Price filter for products less than particular amount (optional)

priceGt - Price filter for products greater than particular amount (optional)

priceEq - Price filter for products equals to particular amount (optional)

priceNe - Price filter for products not equals to particular amount (optional)

categories - Filter by product categories (optional)

modifiedSince - 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.** (optional)

createdSince - 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.** (optional)

additionalHeaders - additionalHeaders for this call

Returns:

GetProducts

Throws:

ApiException - if fails to make API call

invokeAPI

public <T> T invokeAPI(String url,
 String method,
 Object request,
 com.fasterxml.jackson.core.type.TypeReference<T> returnType,
 Map<String,String> additionalHeaders)
                throws ApiException

Description copied from class: BaseApi

Directly invoke the API for the given URL. Useful if the API returns direct links/URLs for subsequent requests.

Specified by:

invokeAPI in class BaseApi

Parameters:

url - The URL for the request, either full URL or only the path.

method - The HTTP method for the request.

request - The request object.

returnType - The return type.

additionalHeaders - Additional headers for the request.

Returns:

The API response in the specified type.

Throws:

ApiException - if fails to make API call.