API Evangelist conversational phrasing for ActiveCampaign API v3 Ecommerce API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ActiveCampaign API v3 Ecommerce API
  version: 1.0.0
extends: openapi/activecampaign-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: 13
- target: $.paths['/ecomCustomers'].get
  update:
    x-apievangelist-phrasing:
      intent: List e-commerce customers
      effect: read
      questions:
      - Which shoppers have been synced from my store?
      - Can I find an e-commerce customer by email address?
      - How would I list only the customers from one store connection?
      instructions:
      - text: Find the e-commerce customer with email {email}.
        slots:
          email: query.filters[email]
      - text: List e-commerce customers for connection {connectionid}.
        slots:
          connectionid: query.filters[connectionid]
      - text: Look up the shopper with external ID {externalid}.
        slots:
          externalid: query.filters[externalid]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecomCustomers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an e-commerce customer
      effect: write
      questions:
      - How do I add a shopper from my store as an e-commerce customer?
      - Can I push a customer record for a connected store?
      instructions:
      - text: 'Create an e-commerce customer: {ecomCustomer}.'
        slots:
          ecomCustomer: requestBody.ecomCustomer
      - text: Add a new shopper to my connected store data.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecomCustomers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an e-commerce customer
      effect: read
      questions:
      - What store data is held for one e-commerce customer?
      - Can I fetch a shopper record by its ID?
      instructions:
      - text: Show e-commerce customer {id}.
        slots:
          id: path.id
      - text: Get the shopper record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecomCustomers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an e-commerce customer
      effect: write
      questions:
      - Can I change a shopper's email or external ID after syncing?
      - How do I edit an existing e-commerce customer?
      instructions:
      - text: Update e-commerce customer {id} with {ecomCustomer}.
        slots:
          id: path.id
          ecomCustomer: requestBody.ecomCustomer
      - text: Edit the shopper record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecomCustomers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an e-commerce customer
      effect: destructive
      questions:
      - How do I remove a shopper from my synced store data?
      - Can I delete an e-commerce customer record?
      instructions:
      - text: Delete e-commerce customer {id}.
        slots:
          id: path.id
      - text: Remove shopper {id} from store data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecomOrders'].get
  update:
    x-apievangelist-phrasing:
      intent: List e-commerce orders
      effect: read
      questions:
      - Which orders have come in from my store?
      - Can I filter orders by customer email or state?
      - What orders did a given store connection create after a certain date?
      instructions:
      - text: List orders placed by {email}.
        slots:
          email: query.filters[email]
      - text: Show orders for e-commerce customer {customerid}.
        slots:
          customerid: query.filters[customerid]
      - text: Find the order with external checkout ID {externalcheckoutid}.
        slots:
          externalcheckoutid: query.filters[externalcheckoutid]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecomOrders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an e-commerce order
      effect: write
      questions:
      - How do I send a store purchase or abandoned cart into ActiveCampaign?
      - Can I record a new order with its products?
      instructions:
      - text: 'Create an order: {ecomOrder}.'
        slots:
          ecomOrder: requestBody.ecomOrder
      - text: Record a new store purchase.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecomOrders/{ecomOrderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an e-commerce order
      effect: read
      questions:
      - What was in a particular order and what did it total?
      - Can I pull one order by its ID?
      instructions:
      - text: Show order {ecomOrderId}.
        slots:
          ecomOrderId: path.ecomOrderId
      - text: Get the details of store order {ecomOrderId}.
        slots:
          ecomOrderId: path.ecomOrderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecomOrders/{ecomOrderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an e-commerce order
      effect: destructive
      questions:
      - How do I remove an order that was synced by mistake?
      - Can I delete a store order record?
      instructions:
      - text: Delete order {ecomOrderId}.
        slots:
          ecomOrderId: path.ecomOrderId
      - text: Remove store order {ecomOrderId}.
        slots:
          ecomOrderId: path.ecomOrderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecomOrders/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an order or cart
      effect: write
      questions:
      - Can I update an abandoned cart once the shopper completes checkout?
      - How do I change the details of an existing order?
      instructions:
      - text: Update order {id} with {ecomOrder}.
        slots:
          id: path.id
          ecomOrder: requestBody.ecomOrder
      - text: Edit the existing order or cart {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecomOrderProducts'].get
  update:
    x-apievangelist-phrasing:
      intent: List all ordered products
      effect: read
      questions:
      - Which products appear across all my store orders?
      - Can I list every order line item in one call?
      instructions:
      - text: List all order products across every order.
      - text: Show every line item from my store orders.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecomOrders/{id}/orderProducts'].get
  update:
    x-apievangelist-phrasing:
      intent: List products in one order
      effect: read
      questions:
      - What products were bought in a specific order?
      - Can I see just the line items for one order?
      instructions:
      - text: List the products in order {id}.
        slots:
          id: path.id
      - text: Show the line items for order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ecomOrderProducts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one ordered product
      effect: read
      questions:
      - What price and quantity are recorded on a single order line item?
      - Can I fetch one order product by its own ID?
      instructions:
      - text: Show order product {id}.
        slots:
          id: path.id
      - text: Get the single line item {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'