Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

instacart Chat API

Endpoints for shopper-customer communication including sending and retrieving chat messages.

instacart Chat API is one of 10 APIs that instacart publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Chat. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 2 operations across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://connect.instacart.com.

2 operations 1 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://connect.instacart.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

instacart Chat API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token obtained using client credentials with the connect:dataingestion scope.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Chat 2

Endpoints for shopper-customer communication including sending and retrieving chat messages.

GET
/v2/post_checkout/chat/{order_id}/messages
Get chat messages for an order
getChatMessages 1 param → 200401404
POST
/v2/post_checkout/chat/{order_id}/messages
Send a message to the shopper
sendChatMessage 1 param body → 200400401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ChatMessage (4 properties), Error (2 properties), SendMessageRequest (1 property), ChatMessagesResponse (1 property). Each schema is shown below with its type and property counts.

ChatMessage
object
4 properties
ChatMessagesResponse
object
1 property
SendMessageRequest
object
1 property 1 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instacart-chat-api-openapi.yml Raw ↑

Other APIs instacart publishes across the network.

Instacart Shopping Widgets
instacart Authentication API
instacart Delivery API
instacart Items API
instacart Last Mile Delivery API
instacart Orders API
instacart Pickup API
instacart Products API
instacart Replacements API