Skip to content

Latest commit

 

History

History
336 lines (216 loc) · 12.6 KB

EcommerceApi.md

File metadata and controls

336 lines (216 loc) · 12.6 KB
Raw

\EcommerceApi

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
GetCategories Get /categories Return all your categories
GetCategoryInfo Get /categories/{id} Get a category details
GetProductInfo Get /products/{id} Get a product's details
GetProducts Get /products Return all your products

CreateBatchOrder

CreateBatchOrder(ctx, orderBatch) Create orders in batch

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

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
orderBatch OrderBatch

Return type

(empty response body)

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateOrder

CreateOrder(ctx, order) Managing the status of the order

Manages the transactional status of the order

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
order Order

Return type

(empty response body)

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateUpdateBatchCategory

CreateUpdateBatchCategoryModel CreateUpdateBatchCategory(ctx, createUpdateBatchCategory) Create categories in batch

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createUpdateBatchCategory CreateUpdateBatchCategory Values to create a batch of categories

Return type

CreateUpdateBatchCategoryModel

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateUpdateBatchProducts

CreateUpdateBatchProductsModel CreateUpdateBatchProducts(ctx, createUpdateBatchProducts) Create products in batch

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createUpdateBatchProducts CreateUpdateBatchProducts Values to create a batch of products

Return type

CreateUpdateBatchProductsModel

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateUpdateCategory

CreateCategoryModel CreateUpdateCategory(ctx, createUpdateCategory) Create/Update a category

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createUpdateCategory CreateUpdateCategory Values to create/update a category

Return type

CreateCategoryModel

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateUpdateProduct

CreateProductModel CreateUpdateProduct(ctx, createUpdateProduct) Create/Update a product

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createUpdateProduct CreateUpdateProduct Values to create/update a product

Return type

CreateProductModel

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EcommerceActivatePost

EcommerceActivatePost(ctx, ) Activate the eCommerce app

Getting access to Brevo eCommerce.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCategories

GetCategories GetCategories(ctx, optional) Return all your categories

Required Parameters

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

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

Return type

GetCategories

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCategoryInfo

GetCategoryDetails GetCategoryInfo(ctx, id) Get a category details

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Category ID

Return type

GetCategoryDetails

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProductInfo

GetProductDetails GetProductInfo(ctx, id) Get a product's details

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string Product ID

Return type

GetProductDetails

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProducts

GetProducts GetProducts(ctx, optional) Return all your products

Required Parameters

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

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

Return type

GetProducts

Authorization

api-key, partner-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]