Instacart · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Instacart Connect Post-Checkout Chat API

3 actions 3 updates phrasing extends openapi/instacart-chat-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 3

$.info
$.paths['/v2/post_checkout/chat/{order_id}/messages'].get
$.paths['/v2/post_checkout/chat/{order_id}/messages'].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 Connect Post-Checkout Chat API
  version: 1.0.0
extends: openapi/instacart-chat-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: 2
- target: $.paths['/v2/post_checkout/chat/{order_id}/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the shopper chat for an order
      effect: read
      questions:
      - How can I see what the customer and shopper have said to each other about an order?
      - Are the chat messages for an order returned oldest first?
      instructions:
      - text: Show the shopper chat history for order {order_id}.
        slots:
          order_id: path.order_id
      - text: Pull every chat message exchanged on order {order_id} in order.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/post_checkout/chat/{order_id}/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a message to the order's shopper
      effect: write
      questions:
      - How do I message the shopper who is picking my order?
      - Can a customer tell the shopper about a replacement or delivery instruction mid-order?
      instructions:
      - text: Send the shopper on order {order_id} the message {body}.
        slots:
          order_id: path.order_id
          body: requestBody.body
      - text: 'Tell the shopper for order {order_id}: {body}'
        slots:
          order_id: path.order_id
          body: requestBody.body
      method: generated
      generated: '2026-09-26'