Instacart · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Instacart Products API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v2/data_ingestion/catalog/product/submission'].post
$.paths['/idp/v1/products/products_link'].post
$.paths['/idp/v1/products/recipe'].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 Instacart Products API
  version: 1.0.0
extends: openapi/instacart-products-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: 3
- target: $.paths['/v2/data_ingestion/catalog/product/submission'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or update catalog products
      effect: write
      questions:
      - How do I add new products to my retailer catalog?
      - How long does a new product take to appear on the storefront?
      - Does updating a product overwrite attributes I leave out?
      instructions:
      - text: 'Submit these products to the catalog: {products}.'
        slots:
          products: requestBody.products
      - text: Create or update catalog products {products}.
        slots:
          products: requestBody.products
      method: generated
      generated: '2026-09-26'
- target: $.paths['/idp/v1/products/products_link'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shareable shopping list page
      effect: write
      questions:
      - How do I generate a link to a shopping list that people can add to their cart?
      - Can I set an expiry on a shopping list link?
      instructions:
      - text: Create a shopping list page titled {title} with products {line_items}.
        slots:
          title: requestBody.title
          line_items: requestBody.line_items
      - text: Make a shopping list link {title} for {line_items} that expires in {expires_in} seconds.
        slots:
          title: requestBody.title
          line_items: requestBody.line_items
          expires_in: requestBody.expires_in
      method: generated
      generated: '2026-09-26'
- target: $.paths['/idp/v1/products/recipe'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shoppable recipe page
      effect: write
      questions:
      - How do I publish a recipe page where readers can buy the ingredients?
      - Can a recipe page credit the author and show servings and cooking time?
      instructions:
      - text: Create a recipe page titled {title} with ingredients {ingredients}.
        slots:
          title: requestBody.title
          ingredients: requestBody.ingredients
      - text: Build a recipe page {title} by {author} serving {servings} with ingredients {ingredients}.
        slots:
          title: requestBody.title
          author: requestBody.author
          servings: requestBody.servings
          ingredients: requestBody.ingredients
      method: generated
      generated: '2026-09-26'