Skip to main content
Create a link with POST /v1/links. The API accepts a shared request body plus retailer-specific options. A successful request always returns the link resource and shareable short link. It includes default QR metadata when QR generation succeeds.

​
Supported intents

​
Shared request fields

Every link request includes these top-level fields. Retailer-specific options go inside options.

​
Retailer discovery

Use GET /v1/retailers to find supported Instacart stores before creating Instacart links. The endpoint returns the retailerId values used by shopping list and recipe links, plus the slug used by Instacart product detail links.

​
Response

Successful creation returns 201 with a data object containing the link ID, status, and shareable shortLink. The optional qrCode field is present when default QR generation succeeds. The API attempts to create the default QR image and persist it atomically with the link. If QR generation or the QR write fails, it falls back to persisting and returning the link without qrCode. You can retry QR creation later with the QR endpoint. The final retailer destination URL is not returned in the response. Incarts keeps that URL behind the short link so shoppers use the shoppable Incarts link you receive from the API.

​
Retailer guides

Direct retailer links

Amazon, Kroger, Target, and Walmart direct cart or product links.

Instacart links

Product detail links, shopping lists, recipes, and retailer routing.

Walmart links

Add-to-cart, product detail, backups, and smart-select.

Custom URL links

Wrap any URL in a trackable Incarts short link.

Create link endpoint

Full schema, examples, and response codes.

Find retailers endpoint

Search Instacart retailers and routing values.