SCVD General Store · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SCVD General Store Trade API

10 actions 10 updates phrasing extends openapi/scvd-store-trade-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for SCVD General Store's API. It is a proposal applied on top of the contract, not a document SCVD General Store publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/api/trade/contract'].get
$.paths['/api/trade/ledger'].get
$.paths['/api/trade/catalog'].get
$.paths['/api/trade/sandbox/check'].post
$.paths['/api/trade/sandbox/{item_id}'].post
$.paths['/api/trade/{partner}/check'].post
$.paths['/api/trade/{partner}/claim'].get
$.paths['/api/trade/{partner}/statement'].get
$.paths['/api/trade/{partner}/{item_id}'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SCVD General Store Trade API
  version: 1.0.0
extends: openapi/scvd-store-trade-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: 9
- target: $.paths['/api/trade/contract'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the trade counter's contract
      effect: read
      questions:
      - How does a marketplace order from the shelf on account?
      - What signing dialects and pricing rule does the trade counter use?
      instructions:
      - text: Get the trade counter contract.
      - text: Show me the trade terms, refusals and open accounts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/trade/ledger'].get
  update:
    x-apievangelist-phrasing:
      intent: Read every trade account's books
      effect: read
      questions:
      - What does each trade account owe, and what has been paid?
      - Is the trade counter's receivable public?
      instructions:
      - text: Get the public trade ledger.
      - text: Show delivered, billed, paid and outstanding totals per trade account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/trade/catalog'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the trade listing feed
      effect: read
      questions:
      - Which items can a marketplace list from the trade counter, at what trade price?
      - Can I see trade prices at my own account's share?
      instructions:
      - text: Get the trade catalog.
      - text: List trade items priced at account {account}'s share.
        slots:
          account: query.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/trade/sandbox/check'].post
  update:
    x-apievangelist-phrasing:
      intent: Test trade request signing in the sandbox
      effect: read
      questions:
      - Can I check my HMAC trade signature in the sandbox before ordering?
      - Why is my sandbox trade request failing the clock-skew or nonce check?
      instructions:
      - text: Run the sandbox check desk on a request timestamped {timestamp}.
        slots:
          timestamp: header.X-Trade-Timestamp
      - text: Test my sandbox signature {signature} with nonce {nonce}.
        slots:
          signature: header.X-Trade-Signature
          nonce: header.X-Trade-Nonce
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/trade/sandbox/{item_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Order an item on the sandbox trade account
      effect: write
      questions:
      - How do I place a test trade order on the sandbox account?
      - Can I test a signed sandbox order with my own order reference?
      instructions:
      - text: Order item {item_id} on the sandbox account.
        slots:
          item_id: path.item_id
      - text: Place a sandbox order for {item_id} with order ref {order_ref}.
        slots:
          item_id: path.item_id
          order_ref: requestBody.order_ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/trade/{partner}/check'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a partner's trade signing without ordering
      effect: read
      questions:
      - Will my partner account's signed request pass all four checks before I order?
      - Does the partner check desk deliver anything?
      instructions:
      - text: Run the check desk for partner {partner}.
        slots:
          partner: path.partner
      - text: Check partner {partner}'s signature {signature} without placing an order.
        slots:
          partner: path.partner
          signature: header.X-Trade-Signature
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/trade/{partner}/claim'].get
  update:
    x-apievangelist-phrasing:
      intent: Recover a trade delivery by order reference
      effect: read
      questions:
      - How can a marketplace recover a customer's lost receipt by order reference?
      - Can I get the signed certificate back for a trade order?
      instructions:
      - text: Recover order {order_ref} for partner {partner}.
        slots:
          order_ref: query.order_ref
          partner: path.partner
      - text: Find the ledger row and certificate for {order_ref} on account {partner}.
        slots:
          order_ref: query.order_ref
          partner: path.partner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/trade/{partner}/statement'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a trade account's signed statement
      effect: read
      questions:
      - Which deliveries and payouts are on my trade account?
      - Can only the account holder read a partner statement?
      instructions:
      - text: Get the trade statement for partner {partner}.
        slots:
          partner: path.partner
      - text: Show every delivery and payout on account {partner}, newest first.
        slots:
          partner: path.partner
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/trade/{partner}/{item_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Order an item on a live trade account
      effect: write
      questions:
      - How does a marketplace order an item billed on its trade statement?
      - What authenticates a live trade order on account?
      instructions:
      - text: Order item {item_id} on trade account {partner}.
        slots:
          item_id: path.item_id
          partner: path.partner
      - text: Place a billed order for {item_id} for partner {partner} with ref {order_ref}.
        slots:
          item_id: path.item_id
          partner: path.partner
          order_ref: requestBody.order_ref
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/scvd-store-trade-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

A second provider on the same verified email joins the account you already have.