Brevo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brevo eCommerce Products API

5 actions 5 updates phrasing extends openapi/brevo-products-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Brevo's API. It is a proposal applied on top of the contract, not a document Brevo publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/products'].get
$.paths['/products'].post
$.paths['/products/batch'].post
$.paths['/products/{productId}'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Brevo eCommerce Products API
  version: 1.0.0
extends: openapi/brevo-products-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List eCommerce products
      effect: read
      questions:
      - Which products from my store are synced to Brevo?
      - Can I fetch only certain products by their IDs?
      instructions:
      - text: List my synced products.
      - text: List products with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/products'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a product
      effect: write
      questions:
      - How do I sync a single product from my store into Brevo?
      - What happens if I send a product whose ID already exists?
      instructions:
      - text: Upsert product {id} named {name} at {url}.
        slots:
          id: requestBody.id
          name: requestBody.name
          url: requestBody.url
      - text: Save product {id} {name} at {url} priced {price} in categories {categories}.
        slots:
          id: requestBody.id
          name: requestBody.name
          url: requestBody.url
          price: requestBody.price
          categories: requestBody.categories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/products/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update products in bulk
      effect: write
      questions:
      - Can I sync my whole product catalog in one request?
      - How many products can I upsert per batch call?
      instructions:
      - text: 'Batch upsert these products: {products}.'
        slots:
          products: requestBody.products
      - text: Sync up to 100 products at once from {products}.
        slots:
          products: requestBody.products
      method: generated
      generated: '2026-09-26'
- target: $.paths['/products/{productId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product
      effect: read
      questions:
      - What price and URL does Brevo have for one of my products?
      - Can I look up a single synced product by its ID?
      instructions:
      - text: Get product {productId}.
        slots:
          productId: path.productId
      - text: Show the details of product {productId}.
        slots:
          productId: path.productId
      method: generated
      generated: '2026-09-26'