GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Orders API

6 actions 6 updates phrasing extends openapi/getresponse-orders-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}/orders'].get

$.paths['/shops/{shopId}/orders'].post

$.paths['/shops/{shopId}/orders/{orderId}'].get

$.paths['/shops/{shopId}/orders/{orderId}'].post

$.paths['/shops/{shopId}/orders/{orderId}'].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 Orders API
  version: 1.0.0
extends: openapi/getresponse-orders-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}/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List a shop's orders
      effect: read
      questions:
      - Which orders have come into my shop recently?
      - Can I filter shop orders by status or processing date?
      instructions:
      - text: List orders in shop {shopId}.
        slots:
          shopId: path.shopId
      - text: Show orders in shop {shopId} with status {status}.
        slots:
          shopId: path.shopId
          status: query.query[status]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/orders'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a new shop order
      effect: write
      questions:
      - How do I record a purchase made by a contact?
      - Can I include shipping and billing addresses on a new order?
      instructions:
      - text: Create an order in shop {shopId} for contact {contactId} totaling {totalPrice} {currency}.
        slots:
          shopId: path.shopId
          contactId: requestBody.contactId
          totalPrice: requestBody.totalPrice
          currency: requestBody.currency
      - text: Record an order in shop {shopId} with variants {selectedVariants} and status {status}.
        slots:
          shopId: path.shopId
          selectedVariants: requestBody.selectedVariants
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/orders/{orderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shop order
      effect: read
      questions:
      - What are the details of one particular order?
      - Can I look up an order's total and status by its ID?
      instructions:
      - text: Show order {orderId} in shop {shopId}.
        slots:
          orderId: path.orderId
          shopId: path.shopId
      - text: Get the total and status of order {orderId} in shop {shopId}.
        slots:
          orderId: path.orderId
          shopId: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/orders/{orderId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a shop order
      effect: write
      questions:
      - Can I change the status of an order I already recorded?
      - Is it possible to correct the shipping address on an existing order?
      instructions:
      - text: Set order {orderId} in shop {shopId} to status {status}.
        slots:
          orderId: path.orderId
          shopId: path.shopId
          status: requestBody.status
      - text: Change the billing status of order {orderId} in shop {shopId} to {billingStatus}.
        slots:
          orderId: path.orderId
          shopId: path.shopId
          billingStatus: requestBody.billingStatus
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/orders/{orderId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shop order
      effect: destructive
      questions:
      - How can I remove an order from my shop?
      - Can a recorded order be permanently deleted?
      instructions:
      - text: Delete order {orderId} from shop {shopId}.
        slots:
          orderId: path.orderId
          shopId: path.shopId
      - text: Permanently remove order {orderId} from shop {shopId}.
        slots:
          orderId: path.orderId
          shopId: path.shopId
      method: generated
      generated: '2026-09-26'