Instacart · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Instacart Connect Fulfillment Pickup API

4 actions 4 updates phrasing extends openapi/instacart-pickup-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/fulfillment/stores/pickup'].post
$.paths['/v2/fulfillment/users/{user_id}/service_options/pickup'].post
$.paths['/v2/fulfillment/users/{user_id}/orders/pickup'].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 Fulfillment Pickup API
  version: 1.0.0
extends: openapi/instacart-pickup-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/fulfillment/stores/pickup'].post
  update:
    x-apievangelist-phrasing:
      intent: Find stores offering pickup
      effect: read
      questions:
      - Which nearby stores let a customer pick up their order?
      - Can I find pickup stores from a postal code, closest first?
      instructions:
      - text: Find pickup stores near postal code {postal_code}.
        slots:
          postal_code: requestBody.postal_code
      - text: List stores offering pickup in {city}, {state}.
        slots:
          city: requestBody.city
          state: requestBody.state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/fulfillment/users/{user_id}/service_options/pickup'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview available pickup time slots
      effect: read
      questions:
      - What pickup times can I offer a customer before checkout?
      - Can I check pickup windows for a particular store?
      instructions:
      - text: Show pickup time slots for user {user_id} at store {store_id}.
        slots:
          user_id: path.user_id
          store_id: requestBody.store_id
      - text: Preview when user {user_id} could collect an order from store {store_id}.
        slots:
          user_id: path.user_id
          store_id: requestBody.store_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/fulfillment/users/{user_id}/orders/pickup'].post
  update:
    x-apievangelist-phrasing:
      intent: Place a pickup order
      effect: write
      questions:
      - How do I place an order the customer will collect in store?
      - Why can creating a pickup order take several seconds?
      instructions:
      - text: Create a pickup order for user {user_id} using hold {hold_id}.
        slots:
          user_id: path.user_id
          hold_id: requestBody.hold_id
      - text: Place a store pickup order for user {user_id} on hold {hold_id} with cart {cart}.
        slots:
          user_id: path.user_id
          hold_id: requestBody.hold_id
          cart: requestBody.cart
      method: generated
      generated: '2026-09-26'