Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Talon One Catalogs API

6 actions 6 updates phrasing extends openapi/talon-one-catalogs-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Talon.One's API. It is a proposal applied on top of the contract, not a document Talon.One publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/v1/best_prior_price'].post
$.paths['/v1/catalogs/{catalogId}/sync'].put
$.paths['/v1/applications/{applicationId}/price_history'].post
$.paths['/v1/applications/{applicationId}/price_history/exclusions'].post
$.paths['/v1/catalogs/{catalogId}/items'].get

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 Talon One Catalogs API
  version: 1.0.0
extends: openapi/talon-one-catalogs-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['/v1/best_prior_price'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the best prior price for SKUs
      effect: read
      questions:
      - What was the lowest price of a product over the last 30 days before a discount?
      - Can I check the best prior price for several SKUs in one call?
      instructions:
      - text: Get the best prior price for SKUs {skus} over timeframe {timeframe} ending {timeframeEndDate} ({timeframeEndDateType}).
        slots:
          skus: requestBody.skus
          timeframe: requestBody.timeframe
          timeframeEndDate: requestBody.timeframeEndDate
          timeframeEndDateType: requestBody.timeframeEndDateType
      - text: Find the lowest historical price of {skus} within {timeframe} before {timeframeEndDate}, end date type {timeframeEndDateType}.
        slots:
          skus: requestBody.skus
          timeframe: requestBody.timeframe
          timeframeEndDate: requestBody.timeframeEndDate
          timeframeEndDateType: requestBody.timeframeEndDateType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalogs/{catalogId}/sync'].put
  update:
    x-apievangelist-phrasing:
      intent: Add, update or remove items in a cart item catalog
      effect: write
      questions:
      - How do I keep my product catalog in sync with my item attributes?
      - Can I add and remove several catalog items in one request?
      instructions:
      - text: Sync catalog {catalogId} with actions {actions}.
        slots:
          catalogId: path.catalogId
          actions: requestBody.actions
      - text: Apply item add, update and remove actions {actions} to catalog {catalogId} at version {version}.
        slots:
          actions: requestBody.actions
          catalogId: path.catalogId
          version: requestBody.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/price_history'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a SKU's price history
      effect: read
      questions:
      - How has the price of one SKU changed between two dates?
      - Where can I see historical price records for a product?
      instructions:
      - text: Show the price history of SKU {sku} from {startDate} to {endDate} in application {applicationId}.
        slots:
          sku: requestBody.sku
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          applicationId: path.applicationId
      - text: Summarize historical prices for {sku} between {startDate} and {endDate}, application {applicationId}.
        slots:
          sku: requestBody.sku
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/price_history/exclusions'].post
  update:
    x-apievangelist-phrasing:
      intent: Exclude price records from best prior price
      effect: write
      questions:
      - Can I ignore a wrong historical price when calculating the best prior price?
      - Do I need a reason to exclude price records?
      instructions:
      - text: Exclude price records {ids} in application {applicationId} because {reason}.
        slots:
          ids: requestBody.ids
          applicationId: path.applicationId
          reason: requestBody.reason
      - text: Drop historical price IDs {ids} from best prior price calculation in application {applicationId}, reason {reason}.
        slots:
          ids: requestBody.ids
          applicationId: path.applicationId
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/catalogs/{catalogId}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List items in a catalog
      effect: read
      questions:
      - What products are in my cart item catalog?
      - Can I filter catalog items by SKU or product name?
      instructions:
      - text: List the items in catalog {catalogId}.
        slots:
          catalogId: path.catalogId
      - text: Find items with SKU {sku} in catalog {catalogId}.
        slots:
          sku: query.sku
          catalogId: path.catalogId
      - text: Show catalog {catalogId} items for products {productNames}.
        slots:
          catalogId: path.catalogId
          productNames: query.productNames
      method: generated
      generated: '2026-09-26'