GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Carts API

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

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

$.paths['/shops/{shopId}/carts/{cartId}'].get

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

$.paths['/shops/{shopId}/carts/{cartId}'].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 Carts API
  version: 1.0.0
extends: openapi/getresponse-carts-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}/carts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a shop's carts
      effect: read
      questions:
      - Which shopping carts exist in my shop, for example abandoned ones?
      - Can I find carts created in a date range?
      instructions:
      - text: List carts in shop {shop}.
        slots:
          shop: path.shopId
      - text: Find carts in shop {shop} created between {from} and {to}.
        slots:
          shop: path.shopId
          from: query.query[createdOn][from]
          to: query.query[createdOn][to]
      - text: Find the cart 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}/carts'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a new shopping cart
      effect: write
      questions:
      - How do I send a customer's cart into GetResponse for abandoned cart emails?
      - What must a new cart contain when I create it?
      instructions:
      - text: Create a cart in shop {shop}.
        slots:
          shop: path.shopId
      - text: Record the customer's current cart in shop {shop}.
        slots:
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/carts/{cartId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a cart's details
      effect: read
      questions:
      - What items are in one specific cart?
      - Can I look up a single cart by its ID?
      instructions:
      - text: Get cart {cart} from shop {shop}.
        slots:
          cart: path.cartId
          shop: path.shopId
      - text: Show the contents of cart {cart} in shop {shop}.
        slots:
          cart: path.cartId
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/carts/{cartId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a shopping cart
      effect: write
      questions:
      - Can I change the items or total of a cart that already exists?
      - Do cart fields I don't send stay the same?
      instructions:
      - text: Update cart {cart} in shop {shop}.
        slots:
          cart: path.cartId
          shop: path.shopId
      - text: Change the items in cart {cart} of shop {shop}.
        slots:
          cart: path.cartId
          shop: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/carts/{cartId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shopping cart
      effect: destructive
      questions:
      - How do I remove a cart once it's been converted or emptied?
      - Is deleting a cart permanent?
      instructions:
      - text: Delete cart {cart} from shop {shop}.
        slots:
          cart: path.cartId
          shop: path.shopId
      - text: Remove cart {cart} in shop {shop}.
        slots:
          cart: path.cartId
          shop: path.shopId
      method: generated
      generated: '2026-09-26'