Squarespace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Squarespace Transactions API

5 actions 5 updates phrasing extends openapi/squarespace-transactions-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Squarespace's API. It is a proposal applied on top of the contract, not a document Squarespace publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/1.0/commerce/transactions'].get

$.paths['/1.0/commerce/transactions/{documentIds}'].get

$.paths['/commerce/transactions'].get

$.paths['/commerce/transactions/{transactionIds}'].get

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 Squarespace Transactions API
  version: 1.0.0
extends: openapi/squarespace-transactions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/1.0/commerce/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List transaction documents (1.0)
      effect: read
      questions:
      - How do I list payment transactions for orders and donations on the versioned 1.0 API?
      - Can I pull the 1.0 transactions for one specific order?
      instructions:
      - text: List 1.0 transactions modified between {modifiedAfter} and {modifiedBefore}.
        slots:
          modifiedAfter: query.modifiedAfter
          modifiedBefore: query.modifiedBefore
      - text: List 1.0 transaction documents for order {orderId}.
        slots:
          orderId: query.orderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/1.0/commerce/transactions/{documentIds}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get transaction documents by ID (1.0)
      effect: read
      questions:
      - How do I fetch specific transaction documents by ID with the 1.0 endpoint?
      - How many transaction documents can a single 1.0 by-ID request return?
      instructions:
      - text: Get 1.0 transaction documents {documentIds}.
        slots:
          documentIds: path.documentIds
      - text: Look up the payment details in 1.0 documents {documentIds}.
        slots:
          documentIds: path.documentIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commerce/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List transaction documents (unversioned)
      effect: read
      questions:
      - What financial transactions happened on my site in a date range, via the unversioned path?
      - Is there an unversioned way to page through every order and donation transaction?
      instructions:
      - text: Retrieve unversioned transactions modified after {modifiedAfter} and before {modifiedBefore}.
        slots:
          modifiedAfter: query.modifiedAfter
          modifiedBefore: query.modifiedBefore
      - text: Continue the unversioned transaction listing from cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commerce/transactions/{transactionIds}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get transaction documents by ID (unversioned)
      effect: read
      questions:
      - What gateway data and totals are on a specific transaction document, via the unversioned path?
      - Can I retrieve several transaction documents by ID without the 1.0 prefix?
      instructions:
      - text: Retrieve unversioned transaction documents {transactionIds}.
        slots:
          transactionIds: path.transactionIds
      - text: Show gateway and line-entry details for transactions {transactionIds}.
        slots:
          transactionIds: path.transactionIds
      method: generated
      generated: '2026-10-01'