Instacart · OpenAPI Overlay 1.0.0

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

2 actions 2 updates phrasing extends openapi/instacart-replacements-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 2

$.info

$.paths['/v2/post_checkout/orders/{order_id}/items/{order_item_id}/replacement'].put

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 Replacements API
  version: 1.0.0
extends: openapi/instacart-replacements-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: 1
- target: $.paths['/v2/post_checkout/orders/{order_id}/items/{order_item_id}/replacement'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve or reject a shopper's replacement
      effect: write
      questions:
      - How does a customer accept a substitute the shopper picked?
      - What happens to an item if its replacement is rejected?
      instructions:
      - text: Set the replacement for item {order_item_id} on order {order_id} to {status}.
        slots:
          order_item_id: path.order_item_id
          order_id: path.order_id
          status: requestBody.status
      - text: Approve the substitute for item {order_item_id} in order {order_id} by marking it {status}.
        slots:
          order_item_id: path.order_item_id
          order_id: path.order_id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'