Iterable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Iterable Commerce API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/commerce/trackPurchase'].post
$.paths['/api/commerce/updateCart'].post
$.paths['/commerce/trackPurchase'].post
$.paths['/commerce/updateCart'].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 Iterable Commerce API
  version: 1.0.0
extends: openapi/iterable-commerce-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['/api/commerce/trackPurchase'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a purchase and clear the cart
      effect: write
      questions:
      - Does tracking a purchase clear the user's shopping cart items?
      - Can I attribute a purchase to a campaign and give it my own ID?
      instructions:
      - text: Track a purchase of {items} totaling {total} for user {user}.
        slots:
          items: requestBody.items
          total: requestBody.total
          user: requestBody.user
      - text: Record purchase {id} for {user} with items {items} and total {total}, attributed to campaign {campaignId}.
        slots:
          id: requestBody.id
          user: requestBody.user
          items: requestBody.items
          total: requestBody.total
          campaignId: requestBody.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/commerce/updateCart'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace a user's shopping cart items
      effect: write
      questions:
      - How do I update shoppingCartItems on a user profile?
      - Will updating a cart create the user if they don't exist yet?
      instructions:
      - text: Set the shopping cart for {user} to {items}.
        slots:
          user: requestBody.user
          items: requestBody.items
      - text: Update {user}'s shoppingCartItems with {items} via /api/commerce.
        slots:
          user: requestBody.user
          items: requestBody.items
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commerce/trackPurchase'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a purchase for revenue attribution
      effect: write
      questions:
      - Can I log a purchase for revenue attribution using the simple /commerce endpoint?
      - What purchase details are recorded for revenue reporting?
      instructions:
      - text: Using /commerce/trackPurchase, log items {items} worth {total} for {user}.
        slots:
          items: requestBody.items
          total: requestBody.total
          user: requestBody.user
      - text: Record a {total} purchase by {user} at {createdAt} with items {items} for revenue attribution.
        slots:
          total: requestBody.total
          user: requestBody.user
          createdAt: requestBody.createdAt
          items: requestBody.items
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commerce/updateCart'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a cart for abandoned-cart campaigns
      effect: write
      questions:
      - How can I feed cart contents into abandoned cart campaigns?
      - Is there a basic /commerce endpoint to update what's in a user's cart?
      instructions:
      - text: Update the cart for {user} to {items} for abandoned-cart messaging.
        slots:
          user: requestBody.user
          items: requestBody.items
      - text: Using /commerce/updateCart, save cart contents {items}.
        slots:
          items: requestBody.items
      method: generated
      generated: '2026-10-01'

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/iterable-commerce-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.