Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Storefront API V1 Punchout API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/api/v1/punchout/setuprequest'].post
$.paths['/api/v1/punchout/sessionrequest'].get
$.paths['/api/v1/punchout/profiletransactionrequest'].post
$.paths['/api/v1/punchout/porequisition'].get
$.paths['/api/v1/punchout/orderrequest'].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 Storefront API V1 Punchout API
  version: 1.0.0
extends: openapi/optimizely-punchout-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['/api/v1/punchout/setuprequest'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a punchout setup request
      effect: write
      questions:
      - How does a buyer's procurement system start a punchout session with the storefront?
      - What does the punchout setup request endpoint accept?
      instructions:
      - text: Submit punchout setup request {request}.
        slots:
          request: query.request
      - text: Open a punchout session from the procurement system with setup request {request}.
        slots:
          request: query.request
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/punchout/sessionrequest'].get
  update:
    x-apievangelist-phrasing:
      intent: Resume a punchout session
      effect: read
      questions:
      - Can I load an existing punchout session by its session id?
      - Where does a shopper land after the punchout setup handshake?
      instructions:
      - text: Load punchout session {punchoutsessionid}.
        slots:
          punchoutsessionid: query.punchoutsessionid
      - text: Resume the punchout shopping session {punchoutsessionid}.
        slots:
          punchoutsessionid: query.punchoutsessionid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/punchout/profiletransactionrequest'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a punchout profile transaction request
      effect: read
      questions:
      - Which punchout transactions does the storefront support, per a profile request?
      - Is there an endpoint for the procurement profile handshake?
      instructions:
      - text: Send punchout profile transaction request {request}.
        slots:
          request: query.request
      - text: Ask the storefront for its supported punchout transactions with profile request {request}.
        slots:
          request: query.request
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/punchout/porequisition'].get
  update:
    x-apievangelist-phrasing:
      intent: Return the cart as a punchout PO requisition
      effect: write
      questions:
      - How do I send the punchout cart back to the buyer's procurement system as a requisition?
      - Can I choose the requisition operation when returning a punchout cart?
      instructions:
      - text: Send the punchout cart back as a PO requisition.
      - text: Return the punchout requisition using operation {operation}.
        slots:
          operation: query.operation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/punchout/orderrequest'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a punchout purchase order request
      effect: write
      questions:
      - How does an approved purchase order come back from procurement into the storefront?
      - What does the punchout order request endpoint take?
      instructions:
      - text: Submit punchout order request {request}.
        slots:
          request: query.request
      - text: Place the approved procurement purchase order {request} through punchout.
        slots:
          request: query.request
      method: generated
      generated: '2026-09-26'