Instacart · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/instacart-orders-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/orders/{order_id}/handling'].get

$.paths['/v2/post_checkout/orders/{order_id}/items'].get

OpenAPI Overlay

# 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 Orders API
  version: 1.0.0
extends: openapi/instacart-orders-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/orders/{order_id}/handling'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order's address, shopper and notes
      effect: read
      questions:
      - Who is the shopper on an order and what address is it going to?
      - Can I see the delivery coordinates and customer notes for an order after checkout?
      instructions:
      - text: Get handling details for order {order_id}.
        slots:
          order_id: path.order_id
      - text: Show the shopper, address and instructions for order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/post_checkout/orders/{order_id}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: Track item status and replacements in an order
      effect: read
      questions:
      - How can I see which items in an order have been picked or replaced?
      - Can I poll for real-time item status while the shopper is shopping?
      instructions:
      - text: List the items and their status for order {order_id}.
        slots:
          order_id: path.order_id
      - text: Check which items in order {order_id} have replacements.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'