Generated by API Evangelist
Written by API Evangelist tooling for Impact's API. It is a proposal applied on top of the contract, not a document Impact publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Partner Stores API
version: 1.0.0
extends: openapi/impact-stores-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: 3
- target: $.paths['/Mediapartners/{AccountSID}/Stores'].get
update:
x-apievangelist-phrasing:
intent: List stores available to a partner
effect: read
questions:
- Which brand stores can I browse as a partner?
- Can I see every store on my partner account?
instructions:
- text: List all stores in partner account {account}.
slots:
account: path.AccountSID
- text: Show the stores available to account {account}.
slots:
account: path.AccountSID
method: generated
generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Stores/{Id}'].get
update:
x-apievangelist-phrasing:
intent: Retrieve a store and its groups
effect: read
questions:
- What curated product groups does a particular store have?
- Can I include auto-created groups when viewing a store?
instructions:
- text: Get store {store} in account {account}.
slots:
account: path.AccountSID
store: path.Id
- text: 'Show store {store} for account {account} including auto-created groups: {auto}.'
slots:
account: path.AccountSID
store: path.Id
auto: query.ShowAutoCreatedGroups
method: generated
generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Stores/{Id}/Group/{GroupId}/Items'].get
update:
x-apievangelist-phrasing:
intent: List products in a store group
effect: read
questions:
- Which products are inside one group of a store?
- Can I search the items within a store group?
instructions:
- text: List items in group {group} of store {store}, account {account}.
slots:
account: path.AccountSID
store: path.Id
group: path.GroupId
- text: Search group {group} in store {store} for {query} in account {account}.
slots:
account: path.AccountSID
store: path.Id
group: path.GroupId
query: query.Query
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.