# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GetResponse APIv3 Products API
  version: 1.0.0
extends: openapi/getresponse-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: 7
- target: $.paths['/shops/{shopId}/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List a shop's products
      effect: read
      questions:
      - Which products are in one of my GetResponse shops?
      - Can I filter a shop's products by vendor or category?
      instructions:
      - text: List products in shop {shop}.
        slots:
          shop: path.shopId
      - text: Find products from vendor {vendor} in shop {shop}.
        slots:
          vendor: query.query[vendor]
          shop: path.shopId
      - text: Find the product with external ID {externalId} in shop {shop}.
        slots:
          externalId: query.query[externalId]
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/products'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a product to a shop
      effect: write
      questions:
      - How do I add a new product to my shop catalog?
      - Can I create a product along with its variants in one request?
      instructions:
      - text: Create a product in shop {shop}.
        slots:
          shop: path.shopId
      - text: Add a new product with the details I give you to shop {shop}.
        slots:
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/products/{productId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product's details
      effect: read
      questions:
      - What details are stored for one product in my shop?
      - Can I look up a single product by its ID?
      instructions:
      - text: Get product {product} from shop {shop}.
        slots:
          product: path.productId
          shop: path.shopId
      - text: Show the {fields} of product {product} in shop {shop}.
        slots:
          fields: query.fields
          product: path.productId
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/products/{productId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a product's properties
      effect: write
      questions:
      - Can I change just the price or name of an existing product?
      - Do unchanged product fields stay the same when I update it?
      instructions:
      - text: Update product {product} in shop {shop}.
        slots:
          product: path.productId
          shop: path.shopId
      - text: Change only the fields I list on product {product} in shop {shop}.
        slots:
          product: path.productId
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/products/{productId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product
      effect: destructive
      questions:
      - How do I remove a discontinued product from my shop?
      - Is deleting a product from a shop permanent?
      instructions:
      - text: Delete product {product} from shop {shop}.
        slots:
          product: path.productId
          shop: path.shopId
      - text: Remove product {product} in shop {shop}.
        slots:
          product: path.productId
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/products/{productId}/categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign categories to a product
      effect: write
      questions:
      - Can I put a product into categories and set its default category?
      - Does assigning product categories remove the ones already there?
      instructions:
      - text: Assign categories {categories} to product {product} in shop {shop}.
        slots:
          categories: requestBody.categories
          product: path.productId
          shop: path.shopId
      - text: Add category assignments to product {product} of shop {shop}.
        slots:
          product: path.productId
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/products/{productId}/meta-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign meta fields to a product
      effect: write
      questions:
      - Can I attach extra metadata fields to a product?
      - Which meta fields end up on a product after I add new ones?
      instructions:
      - text: Attach meta fields {metaFields} to product {product} in shop {shop}.
        slots:
          metaFields: requestBody.metaFields
          product: path.productId
          shop: path.shopId
      - text: Add meta fields to product {product} of shop {shop} without removing existing ones.
        slots:
          product: path.productId
          shop: path.shopId
      method: generated
      generated: '2026-09-26'