GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Product Variants API

6 actions 6 updates phrasing extends openapi/getresponse-product-variants-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for GetResponse's API. It is a proposal applied on top of the contract, not a document GetResponse publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/shops/{shopId}/products/{productId}/variants'].get

$.paths['/shops/{shopId}/products/{productId}/variants'].post

$.paths['/shops/{shopId}/products/{productId}/variants/{variantId}'].get

$.paths['/shops/{shopId}/products/{productId}/variants/{variantId}'].post

$.paths['/shops/{shopId}/products/{productId}/variants/{variantId}'].delete

OpenAPI Overlay

# 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 Product Variants API
  version: 1.0.0
extends: openapi/getresponse-product-variants-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: 5
- target: $.paths['/shops/{shopId}/products/{productId}/variants'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's variants
      effect: read
      questions:
      - Which variants exist for a given product in my shop?
      - Can I look up product variants by SKU?
      instructions:
      - text: List variants of product {productId} in shop {shopId}.
        slots:
          productId: path.productId
          shopId: path.shopId
      - text: Find variants of product {productId} in shop {shopId} with SKU {sku}.
        slots:
          productId: path.productId
          shopId: path.shopId
          sku: query.query[sku]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/products/{productId}/variants'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a product variant
      effect: write
      questions:
      - How do I add a new size or color variant to a product?
      - Can I set price, quantity and SKU when creating a variant?
      instructions:
      - text: Add variant {name} with SKU {sku} at price {price} to product {productId} in shop {shopId}.
        slots:
          name: requestBody.name
          sku: requestBody.sku
          price: requestBody.price
          productId: path.productId
          shopId: path.shopId
      - text: Create a variant of product {productId} in shop {shopId} with quantity {quantity}.
        slots:
          productId: path.productId
          shopId: path.shopId
          quantity: requestBody.quantity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/products/{productId}/variants/{variantId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product variant
      effect: read
      questions:
      - What are the price and stock details of one product variant?
      - Can I fetch a single variant by its ID?
      instructions:
      - text: Show variant {variantId} of product {productId} in shop {shopId}.
        slots:
          variantId: path.variantId
          productId: path.productId
          shopId: path.shopId
      - text: Get the price and stock of variant {variantId} for product {productId} in shop {shopId}.
        slots:
          variantId: path.variantId
          productId: path.productId
          shopId: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/products/{productId}/variants/{variantId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a product variant
      effect: write
      questions:
      - Can I change an existing variant's properties?
      - Do images and taxes get replaced when I update a variant?
      instructions:
      - text: Update variant {variantId} of product {productId} in shop {shopId}.
        slots:
          variantId: path.variantId
          productId: path.productId
          shopId: path.shopId
      - text: Change the properties of existing variant {variantId} on product {productId}, shop {shopId}.
        slots:
          variantId: path.variantId
          productId: path.productId
          shopId: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/products/{productId}/variants/{variantId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product variant
      effect: destructive
      questions:
      - How do I remove a variant from a product?
      - Can a discontinued product variant be permanently deleted?
      instructions:
      - text: Delete variant {variantId} of product {productId} in shop {shopId}.
        slots:
          variantId: path.variantId
          productId: path.productId
          shopId: path.shopId
      - text: Remove discontinued variant {variantId} from product {productId} in shop {shopId}.
        slots:
          variantId: path.variantId
          productId: path.productId
          shopId: path.shopId
      method: generated
      generated: '2026-09-26'