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.
# 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 Shops API
version: 1.0.0
extends: openapi/getresponse-shops-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}'].get
update:
x-apievangelist-phrasing:
intent: Get a shop's details
effect: read
questions:
- What settings does one of my GetResponse shops have?
- Can I look up a shop by its ID?
instructions:
- text: Get shop {shop}.
slots:
shop: path.shopId
- text: Show the {fields} of shop {shop}.
slots:
fields: query.fields
shop: path.shopId
method: generated
generated: '2026-09-26'
- target: $.paths['/shops/{shopId}'].post
update:
x-apievangelist-phrasing:
intent: Update shop preferences
effect: write
questions:
- Can I change a shop's name, currency or locale?
- Do the shop settings I omit stay the same?
instructions:
- text: Update shop {shop}.
slots:
shop: path.shopId
- text: Change the preferences of shop {shop} as I describe.
slots:
shop: path.shopId
method: generated
generated: '2026-09-26'
- target: $.paths['/shops/{shopId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a shop
effect: destructive
questions:
- How do I delete a shop I no longer sell through?
- Is removing a shop permanent?
instructions:
- text: Delete shop {shop}.
slots:
shop: path.shopId
- text: Remove shop {shop} from my account.
slots:
shop: path.shopId
method: generated
generated: '2026-09-26'
- target: $.paths['/shops'].get
update:
x-apievangelist-phrasing:
intent: List my shops
effect: read
questions:
- Which ecommerce shops are connected to my account?
- Can I find a shop by name?
instructions:
- text: List all my shops.
- text: Find shops named {name}.
slots:
name: query.query[name]
method: generated
generated: '2026-09-26'
- target: $.paths['/shops'].post
update:
x-apievangelist-phrasing:
intent: Create a shop
effect: write
questions:
- How do I set up a new shop to sync ecommerce data?
- What do I need to provide to create a shop?
instructions:
- text: Create a new shop with the name and currency I give you.
- text: Set up a shop for my online store.
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.