# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Ecommerce API
  version: 1.0.0
extends: openapi/brevo-ecommerce-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: 18
- target: $.paths['/orders/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Record or update an order's status
      effect: write
      questions:
      - How do I send an order and its status from my store into Brevo?
      - Can I include coupons and billing details when recording an order?
      instructions:
      - text: Record order {id} with status {status}, amount {amount}, products {products}, created {createdAt} and updated {updatedAt}.
        slots:
          id: requestBody.id
          status: requestBody.status
          amount: requestBody.amount
          products: requestBody.products
          createdAt: requestBody.createdAt
          updatedAt: requestBody.updatedAt
      - text: Mark order {id} as {status}.
        slots:
          id: requestBody.id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders/status/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Create orders in batch
      effect: write
      questions:
      - Can I upload many orders at once instead of one at a time?
      - Is there a way to import historical orders in bulk and get notified when done?
      instructions:
      - text: 'Create these orders in batch: {orders}.'
        slots:
          orders: requestBody.orders
      - text: Import historical orders {orders} and notify {notifyUrl} when finished.
        slots:
          orders: requestBody.orders
          notifyUrl: requestBody.notifyUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List orders
      effect: read
      questions:
      - What orders have been synced into my Brevo account?
      - Can I list only orders modified since a certain date?
      instructions:
      - text: List my ecommerce orders.
      - text: Show orders created since {createdSince}.
        slots:
          createdSince: query.createdSince
      method: generated
      generated: '2026-09-26'
- target: $.paths['/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List and filter products
      effect: read
      questions:
      - Which products are in my Brevo ecommerce catalog?
      - Can I filter products by price range or category?
      - Is it possible to include deleted products when listing the catalog?
      instructions:
      - text: List all my ecommerce products.
      - text: Show products in categories {categories}.
        slots:
          categories: query.categories
      - text: Find products priced at most {maxPrice}.
        slots:
          maxPrice: query.price[lte]
      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 add a single product with price and SKU to my catalog?
      - What happens if I send a product ID that already exists?
      instructions:
      - text: Create product {id} named {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: Upsert product {id} named {name} with price {price} and SKU {sku}.
        slots:
          id: requestBody.id
          name: requestBody.name
          price: requestBody.price
          sku: requestBody.sku
      method: generated
      generated: '2026-09-26'
- target: $.paths['/products/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product's details
      effect: read
      questions:
      - What is the stock level and price of a specific product?
      - Can I look up one product by its ID?
      instructions:
      - text: Show the details of product {id}.
        slots:
          id: path.id
      - text: Get product {id} with its images and categories.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/products/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update products in batch
      effect: write
      questions:
      - Can I upload many products in one request?
      - How many products can one batch hold?
      instructions:
      - text: 'Create these products in batch: {products}.'
        slots:
          products: requestBody.products
      - text: Batch-update existing products {products}.
        slots:
          products: requestBody.products
      method: generated
      generated: '2026-09-26'
- target: $.paths['/products/{id}/alerts/{type}'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a contact to a product alert
      effect: write
      questions:
      - How do I notify a shopper when a product is back in stock?
      - Which contact identifiers can I use to register a product alert?
      instructions:
      - text: Create a {type} alert on product {id} for the contact.
        slots:
          type: path.type
          id: path.id
      - text: Alert contact {contactIdentifiers} when product {id} is {type}.
        slots:
          contactIdentifiers: requestBody.contactIdentifiers
          id: path.id
          type: path.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List product categories
      effect: read
      questions:
      - What product categories exist in my store catalog?
      - Can I search categories by name or modification date?
      instructions:
      - text: List all my product categories.
      - text: Find categories named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a category
      effect: write
      questions:
      - How do I add one product category with a URL?
      - Can I update a category's name by sending its existing ID?
      instructions:
      - text: Create category {id} named {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: Upsert category {id} with URL {url}.
        slots:
          id: requestBody.id
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categories/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a category's details
      effect: read
      questions:
      - What are the details of one product category?
      - Can I check whether a category was deleted?
      instructions:
      - text: Show category {id}.
        slots:
          id: path.id
      - text: Get the name and URL of category {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/categories/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update categories in batch
      effect: write
      questions:
      - Can I upload many product categories in one go?
      - What's the maximum number of categories in a single batch?
      instructions:
      - text: 'Create these categories in batch: {categories}.'
        slots:
          categories: requestBody.categories
      - text: Batch-update existing categories {categories}.
        slots:
          categories: requestBody.categories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/attribution/metrics/{conversionSource}/{conversionSourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get revenue attribution for one campaign
      effect: read
      questions:
      - How much revenue did a single email campaign or workflow drive?
      - What is the average basket value attributed to one automation?
      instructions:
      - text: Show attribution metrics for {conversionSource} {conversionSourceId}.
        slots:
          conversionSource: path.conversionSource
          conversionSourceId: path.conversionSourceId
      - text: Get orders and revenue driven by {conversionSource} {conversionSourceId}.
        slots:
          conversionSource: path.conversionSource
          conversionSourceId: path.conversionSourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/attribution/products/{conversionSource}/{conversionSourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List products sold through one campaign
      effect: read
      questions:
      - Which products sold because of a particular campaign?
      - Can I see revenue per product for one workflow?
      instructions:
      - text: List products attributed to {conversionSource} {conversionSourceId}.
        slots:
          conversionSource: path.conversionSource
          conversionSourceId: path.conversionSourceId
      - text: Show product-level sales for {conversionSource} {conversionSourceId}.
        slots:
          conversionSource: path.conversionSource
          conversionSourceId: path.conversionSourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/attribution/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare attribution across campaigns
      effect: read
      questions:
      - Can I get combined revenue attribution for several email and SMS campaigns?
      - What revenue did my campaigns generate over a date range?
      instructions:
      - text: Get attribution metrics for email campaigns {emailCampaignIds}.
        slots:
          emailCampaignIds: query.emailCampaignId[]
      - text: Show aggregated attribution from {periodFrom} to {periodTo}.
        slots:
          periodFrom: query.periodFrom
          periodTo: query.periodTo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate the eCommerce app
      effect: write
      questions:
      - How do I turn on Brevo eCommerce for my account?
      - What gives my account access to the ecommerce features?
      instructions:
      - text: Activate the eCommerce app on my account.
      - text: Enable eCommerce for the account with API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/config/displayCurrency'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the ecommerce display currency
      effect: read
      questions:
      - What currency are my ecommerce reports shown in?
      - Which ISO 4217 code is configured for my store dashboard?
      instructions:
      - text: Show my ecommerce display currency.
      - text: Get the display currency for the account with API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecommerce/config/displayCurrency'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the ecommerce display currency
      effect: write
      questions:
      - Can I change the currency used in my ecommerce dashboard?
      - What format must the display currency code use?
      instructions:
      - text: Set my ecommerce display currency to {code}.
        slots:
          code: requestBody.code
      - text: Switch dashboard currency to {code}.
        slots:
          code: requestBody.code
      method: generated
      generated: '2026-09-26'